API Reference
Log In
API Reference

Generate a report (PDF)

post
https://api.caniphish.com/api/v3/reporting/generate-report

Generates a report and returns a presigned download URL. Report type/filters are passed through to the report generator.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
string
required
string
string
string
reportColumns
array of strings
reportColumns
string
string
string
string
string
string
string
string
enum

Interaction filter for the Phishing Compliance report (console label "Interaction"). PayloadInteraction and EmployeeCompromised keep only the rows with that outcome. The 2Plus, 3Plus and 4Plus options keep only the payload interactions (or compromises) of employees who had one in at least that many different campaigns within the report's date range. AllInteractions applies no filter. Other report types ignore it.

Responses

Updated 28 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 28 days ago