Get campaign statistics

Request

Parameter	In	Type	Required	Description
`CampaignID`	path	string	true	The ID of the campaign that you are fetching statistics for.
`Type`	path	string	false	The type of activity used to get information and display statistics. Possible values are: `Sent` - when and to which recipients the campaign was sent. `Opened` - who opened the campaign. `LinkClicked` - who clicked on which links in the campaign. `Unsubscribed` - who unsubscribed from the campaign by clicking the unsubscribe link and when. `Bounced` - which email recipients failed to receive the campaign. If not specified, `Sent` value is used by default. `Complained` - which email recipients reported your campaign as spam through their email service. `Activity` - all types of activities for the campaign.
`Format`	path	string	true	The supported file format for getting a response. Possible values: `json` and `xml`.
`apikey`	query	string	true	The API key of your account.
`date`	query	date	false	The specific year, month, and day the activity occurred. The `date` has a `YYYY/MM/DD` format.

RequestResponse

GET https://{hostname}/v3/campaigns/{CampaignID}/stats/{Type}.{Format}?apikey=

Response

Status	Description	Headers	Schema
`200 OK`	The request is successful.	`Content-Type:application/json` `Accept:application/json`	N/A

Status

Description

Headers

Schema

200 OK

The request is successful.

Content-Type:application/json

Accept:application/json

N/A

RequestResponse

{
  "Code": 0,
  "Error": null,
  "Context": {
    "Paging": {
      "PageSize": 1,
      "CurrentPage": 1,
      "TotalResults": 2,
      "TotalPageCount": 1,
      "SortExpression": null,
      "SortIsAscending": false
    },
    "Analytics": [
      {
        "Context": "[email protected]",
        "ContextName": "recipient name",
        "TotalCount": 1,
        "UniqueCount": 1,
        "ContextDescription": null,
        "Timestamp": "/Date(1705074023353+0000)/"
      },
      {
        "Context": "[email protected]",
        "ContextName": "recipient2 name",
        "TotalCount": 1,
        "UniqueCount": 1,
        "ContextDescription": null,
        "Timestamp": "/Date(1705074023353+0000)/"
      }
    ]
  }
{
  "Code": 0,
  "Error": null,
  "Context": {
    "Paging": {
      "PageSize": 1,
      "CurrentPage": 1,
      "TotalResults": 2,
      "TotalPageCount": 1,
      "SortExpression": null,
      "SortIsAscending": false
    },
    "Analytics": [
      {
        "Context": "[email protected]",
        "ContextName": "recipient name",
        "TotalCount": 1,
        "UniqueCount": 0,
        "ContextDescription": null
      },
      {
        "Context": "[email protected]",
        "ContextName": "recipient2 name",
        "TotalCount": 1,
        "UniqueCount": 0,
        "ContextDescription": null
      },
    "CampaignActivity": [
      {
        "Context": "NL", /*For opened is country code, For LinkedClicked is the link */
        "Email": "[email protected]", 
        "IpAddress": "20.67.123.236",
        "MailingListId": "459e1a6e-6fc9-48c2-a062-f6434684dabc",
        "MemberId": "dc9d95b8-16cc-05cc-6c10-7de9be83badf",
        "Name": null,
        "Status": "Opened",
        "Timestamp": "02:29 PM 2024-11-08"
            }
    ]
  }
}

Code - the response code. This is 0 if successful.
Error - the response error message. This is null if successful.
Context - an object that contains all the Paging and Analytics information for the campaign:
- Paging - an object that contains the following information:
  - PageSize - the page size of the results. This is 0 if not defined.
  - CurrentPage - the number of the result page. This is 1 if not defined.
  - Totalresults - the number of results that are included in the response.
  - TotalPageCount - the total number of pages in your account.
  - SortExpression - the sort expression associated with the column or columns being sorted.
  - SortIsAscending - this is false if the results are not displayed in ascending order based on the sort expression.
- Analytics - a list of recipients containing the following information for each recipient:
  - Context - the email address of the recipient.
  - ContextName - the name of the recipient.
  - TotalCount - the total number of statistics based on the activity Type made by the recipient. This can be opens, link clicks, and so on. Deprecated
  - UniqueCount - the total number of unique statistics based on the activity Type made by the recipient. This can be opens, link clicks, and so on. Deprecated
  - ContextDescription :
    
    Type is Unsubscribed - this contains the date-time the recipient unsubscribed from the campaign.
    
    Type is LinkClicked - the link URL clicked will be displayed as an extra as seen in the above code example.
    
    Type is Bounced - the Bounced Type will be displayed as an extra.
    
    Type is Complains - the Timestamp will be displayed as an extra.
  - Timestamp - for all parameters Sent, opened, LinkClicked etc an extra field with the time of the action is added in the response.
- Campaign Activity:
  - Context - This will show Country Code if the type is opened, the link is the type is LinkedClicked and the timestamp if the type is Complain.
  - Email - the email address of the recipient.
  - IpAddress - the IP address of the recipient.
  - MailingListId - the mailing list that the recipient belongs to.
  - MemberID - The recipients ID.
  - Name - the recipient's name.
  - Status - The status of the activity.
  - Timestamp - the timestamp of the action.

Do you have some feedback for us?

If you have suggestions for improving this article,