post https://api.caniphish.com/api/v2/reporting/phishing/get-campaign-data
This API provides detailed information on email delivery, open, response, interaction, and compromise statistics for each employee involved.
Log in to see full request history
Response FIelds Explained:
- emailAddress: The email address of the targeted employee
- emailSentStatus: 1 = "Success", 2 = "Error - Domain Not Verified", 3 = "Error - Entire Quota Used", 4 = "Failure - Connection to SMTP server was rejected", 5 = "Failure - Email bounced", 6 = "Failure - Authentication To Microsoft Unsuccessful", 7 = "Failure - Employee Not Found In Microsoft 365"
- emailSentDate: DateTime of when the email was sent, formatted as "yyyy-MM-ddTHH:mm:ss"
- emailOpenStatus: 1 = Yes, 0 = No
- emailOpenDate: DateTime of when the email was opened, formatted as "yyyy-MM-ddTHH:mm:ss"
- emailResponseStatus: 1 = Yes, 0 = No
- emailResponseDate: DateTime of when the email was replied to, formatted as "yyyy-MM-ddTHH:mm:ss"
- payloadInteractionStatus: 1 = Yes, 0 = No
- payloadInteractionDate: DateTime of when the payload was interacted with, formatted as "yyyy-MM-ddTHH:mm:ss"
- payloadInteractionEvidence: IP address (if applicable) of where the interaction originated from
- payloadInteractionUserAgent: User Agent (if applicable) of the browser used when interacting with the payload
- employeeCompromiseStatus: 1 = Yes, 0 = No
- employeeCompromiseDate: DateTime of when the employee was compromised, formatted as "yyyy-MM-ddTHH:mm:ss"
- employeeCompromiseEvidence: IP address (if applicable) of where the interaction originated from
- employeeCompromiseUserAgent: User Agent (if applicable) of the browser used when interacting with the payload
- emailReportStatus: 1 = Yes, 0 = No
- emailReportDate: DateTime of when the email was reported, formatted as "yyyy-MM-ddTHH:mm:ss"
- senderProfileTemplateName: Sender profile used to deliver the phishing email
- PayloadType: Type of payload delivered to the employee (i.e. "Information Request", "Website", "Attachment")
- emailTemplateName: Template of the phishing email.
Responses