Skip to content

Phishing report data dump

The phishing report data dump endpoint allows you to extract comprehensive data about phishing campaigns.

The data can be retrieved in either CSV or JSONL format, making it easy to integrate with your preferred data processing tools for detailed reporting and insights.

curl -X 'GET' \
  'https://api.awaretrain.com/public/v1/report/phishing/dump.csv?filter[campaign]=123' \
  -H 'Authorization: Bearer 6652....383ef1d01'

curl -X 'GET' \
  'https://api.awaretrain.com/public/v1/report/phishing/dump.jsonl?filter[campaign]=123' \
  -H 'Authorization: Bearer 6652....383ef1d01'

Request Parameters

All filters are optional. You can use one or more of the following parameters to filter the data:

Property Type Optional Description
user string Filter by specific user ID.
email string Filter by user email.
employeeNumber string Filter by user employee number.
group string Filter by user group.
campaign string Filter by specific campaign ID.
sentAt date Filter by sent date (optionally prefixed with an operator, e.g. >=).

Note

For detailed information on the scopes required to access the Phishing Report Data Dump endpoint, you can check the scopes page.

Performance and Best Practices

To ensure optimal performance and effective use of the phishing report data dump endpoint, consider the following:

  • Use specific filters: Apply filters to narrow down the dataset you're requesting. This reduces data processing and improves response times.
  • Leverage Last-Modified header: The response includes a Last-Modified header, which you can use to make conditional requests. This prevents retrieving unchanged data, optimising network efficiency.
  • Rate limiting: The endpoint is subject to global API rate limiting. Be mindful of request frequency to avoid hitting rate limits, and consider spreading out bulk requests during off-peak hours if real-time data is not required.
  • Handle user data securely: The endpoint returns sensitive user information such as user IDs and email addresses. Ensure that you handle this data securely and in compliance with relevant data protection regulations.