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.
How to get started with Reporting API?
- Go to Settings > Reporting API.
-
Click Access Credentials
Things to Note
- Credentials are not stored; Admins must copy and save it.
- For lost credentials, click Access Credentials, as the application is already available it sends back the credentials to Phriendly Phishing platform.
- If Reporting API is disabled, the application is deleted after 28 days and the Reporting API tab under settings is no longer visible.
- Credentials are not stored; Admins must copy and save it.
-
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!
Data Tables available in the Report
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:
|
| Learner Email Address | ||
| campaign_id | The block can be Baseline, Campaign, Spear or Training. | |
| campaign_start_date | Start date of the phishing block | The block can be Baseline, Campaign, Spear or Training. |
| campaign_end_date | End Date of the phishing block | The block can be Baseline, Campaign, Spear or Training. |
| email_template_id | Email Template ID | |
| template_subject | String value | |
| attachment | String value | |
| credential_capture_link | Applicable if the email template is a Credential Capture template | String value |
| request_details | request details of the click | |
| created_at | date the click is created | |
| updated_at | date the click is updated | |
| category |
Type of Phishing block
|
|
| is_excluded |
Indicates whether the click is excluded by IP exclusion setting.There are 2 values:
|
|
| action_type |
Type of Action on an email.
|
|
| 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 |
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, Course, Training result.
- Learner’s information: Email, Name, Segment, learner’s synced attributes
- Zone information: Zone Name
- Course: course name (Result)
- Training result: training result (Result), First Completion Date, Current Score
| 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:
|
| Learner Email Address | ||
| 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 |
| course_name | Course Name | |
| assigned | Number of times or blocks a specific course has been assigned to the learner. | |
| best_score | Best score that the learner obtained on a course. | |
| average_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_result |
|
This is a user based result. This lists the Learner's training results for courses that have been assigned to them. |
| course_status |
|
This is a training block status. This is the status of the training that learners were / are enrolled in. |
| 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. | |
| segment | Segment filter option under Learners | |
| department | Visible if the attribute is synched in the platform. | |
| division | Visible if the attribute is synched in the platform. |
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.
Below are the filters you must or can apply:
- Page (required)
- Page Size (required) ; you can query max 500 results at a time
- Schedule from (yyyy-mm-dd ; required)
- Schedule to (yyyy-mm-dd ; required)
- Sent from (yyyy-mm-dd ; required)
- Sent to (yyyy-mm-dd ; required)
- Type (campaign, baseline, spear phishing, training ; optional)
- Timezone (optional)
| 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 |
| 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) |
| phish_id | ID of phishing email |
| student_id | ID of learner |
| cell_id | ID of zone |
Comments
Please sign in to leave a comment.