API: Phishing Campaign Overview

This gives you a high level overview of your phishing campaigns.

Request

URL: https://api.app.cyberpilot.io/accounts/{account-id}/reports/overview
Method: GET
Parameters:

Parameter	Type	Default Value	Description	Example
Authorization	Header		The value of this header must be your Access Token prefix with “bearer “.	Bearer eyJhbGciOiJSUzI1N
account-id	Path		The ID of your account. You can find this in the API section of your Account settings on the platform	c36a9951-a630-4f5a-b874-160d4fe00d6f

Response

Important: The API will return more properties than specified below, but these properties are not actively supported and should not be relied upon. They may be removed in the future.

{ 
  pastPhishingCampaigns: int // Number of phishing campaigns completed for the account  
  activePhishingCampaigns: int // Number of active phishing campaigns 
  nextPhishingCampaignDate: datetime | null // Date when the next phishing campaign is scheduled to start 
}

Got a question?