Reporting API – Phriendly Phishing

This feature allows Phriendly Phishing Company Admins to pull data from Phriendly Phishing platform for reporting purposes. Our API is able to send data from the Click Report, Training Results and Email Schedule.

Important

API Technical Documentation: Accessible from within the Phriendly Phishing platform or via this link - https://api.phriendlyphishing.com/v0.1/docs/.
API Data: Data accessible through the API is updated once per day and is done overnight.

This article includes:

How to get started with Reporting API?
What data can be retrieved via API

How to get started with Reporting API?

Go to Settings > Reporting API.
Click Access Credentials
Things to Note:
1. Credentials are not stored; Admins must copy and save it.
2. API documentation is available under API Settings
3. For lost credentials, click Access Credentials, as the application is already available it sends back the credentials to Phriendly Phishing platform.
4. If Reporting API is disabled, the application is deleted after 28 days and the Reporting API tab under settings is no longer visible.

Once Admins has the Credentials, this can now be used to get the access token, prior to retrieving any data from the platform.
Note: Access tokens expires in 12 hours

Select the Report you want to retrieve to view the data tables.

This report populates data of current zone by default and can retrieve data from its child zones if filtering with Data: Include Data From Sub Zones.Each data includes information of Learner, Zone, Campaigns, Phishes and Clicks.

Learner’s information: Email, Segment, learner synced attributes' value
Zone information: Zone Name, synced attributes
Campaigns: Campaign (Phishing start-end)
Phishes: Phishing Email (Email Template subject), Attachment (Attachment name), Credential Capture Link (has Credential Capture Link or not), QR Code (code clicked or not)
Clicks: Time Stamp (clicked at), IP Address, User Agent, Action (type of click), Excluded (is Excluded or not)

Field	Description	Notes
id	Click ID	The click can be clicked, opened, opened attachment, submitted credential or QR code.
phish_id	Phish ID	Phish represents an email that was sent to the learner.
student_id	Learner ID = recipient of the phish	Click table saves the learner id, but does not include the email, segment and synced attribute values of the learner, Please refer to related tables to get those data: refer to `students` table to get learner's email refer to `student_groups` and `groups` table to get segments' name refer to `student_attribute_vales` table to get the student synced attributes' value.
campaign_id	Block ID = learner joined date and when the phish is setup	The block can be Baseline, Campaign, Spear or Training.
email_template_id	Email Template ID	Click table only saves the email template id, but does not include the subject of template, Refer to to `email_templates` table to get template’s subject.
request_details	request details of the click
created_at	date the click is created
updated_at	date the click is updated
category	Type of block Baseline Campaign Spear Phishing Training
is_excluded	Indicates whether the click is excluded by IP exclusion setting.There are 2 values: 0 = IP from the click is not excluded 1 = IP from the click is excluded
action_type	Type of action on an email. There are 4 values: 1 means ‘click’ action 2 means ‘open email’ action 3 means ‘open attachment’ action 4 means ‘submit credential capture’ action
cell_id	Zone ID	Click table saves the zone id, but does not include the name of zone. Please refer to `cells` table to get zone’s name.
email_client	Email client
email_client_version	Email client version
deleted_at	Date the click is deleted

Related to

Field	Description	Notes
id	Training result ID
student_id	Learner ID	Training Results table saves the learner id, but does not include the email, segment and synced attribute values of learner. Refer to below related table to get the data: `students` table to get learner's email `student_groups` and `groups` table to get segments' name `student_attribute_vales` table to get the student synced attributes' value.
course_id	Course ID	`training_results` table only save the course id, not including the course name, we need to refer to `courses` table to get course name
best_score	Best score that the learner obtained on a course.
paverage_score	Average of all scores that the learner obtained on a course.
lowest_score	Lowest score that the learner obtained on a course.
current_score	Current score that the learner obtained on a course.
training_status	Training status has 4 values: 1= failed 2 = incomplete 3 = not started 4 = passed
course_status	Course status has 2 values: 1 = completed 2 = incomplete
created_at	Date the training result record is created.
updated_at	Date the training result record is updated.
deleted_at	Date the training result record is deleted.
first_completion_date	First date learner passed the course.

Field	Description
Schedule For	Phishing/Training Email is scheduled for sending
Sent At	Time when Phishing/Training email was sent
Zone Name	Name of Zone or Account
Email	Learner's Email Address
Phishing Email Subject	Email Subject of phishing email
Phishing Email From	From field in the email template
Level	Email Template level
Type	Type of email sent (Training, Phishing, Spear Phishing, Baseline)
is_delivered	`True` when `sent_at` is not null and `delivered` = 1 else `False`
phish_id	ID of phishing email
student_id	ID of learner
cell_id	ID of zone