API: Get Results for Specific Phishing Training Campaign

This API will return detailed results for a particular phishing campaign, providing user-specific actions like email sent, link clicked, data submitted, and whether the email was reported as phishing.

Request

URL: https://api.app.cyberpilot.io/gophish/campaigns/{campaign-id}/results
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
campaign-id	Path		The ID of the campaign to fetch results for.	c36a9951-a630-4f5a-b874-160d4fe00d6f
take	Query	20	How many campaigns to return.
skip	Query	0	How many campaigns to skip (offset). Take and skip combined can be used as pagination.

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.

{ 
  count: int // How many users the campaign was sent to 
  fetched: int // How many users was fetched in this request. (See the “take” query parameter) 
  result: array [ // Results for each user 
    { 
      email: string 
      firstName: string 
      lastName: string 
      status: string // Either “email-sent”, “clicked-link”, “submitted-data”,  
      meta: object {  
        reported: boolean // Whether or not the user reported the email as phishing 
      } 
}

Got a question?