CCcc
Email Reporting

GET an Email Campaigns Summary Report

Changed on

Use this method to get aggregate email campaign statistics for up to five hundred email campaigns. The response results include the total number of times that each contact uniquely interacted with each tracked campaign activity.

Results are sorted in descending order by the date that the email was last sent (<code>last_sent_date</code>). Use the <code>limit</code> query parameter to limit the number of email campaign summary reports listed on each page.

For more use case information, see "Get an Email Campaign Summary Report"

get/reports/summary_reports/email_campaign_summaries

Request

Query parameters

limitstring

Use the limit query parameter to limit the number of email campaign summaries to return on a single page. The default is 50 and the maximum is 500 per page.

Response

Request was successful.

Example response

{
  "bulk_email_campaign_summaries": [
    {
      "campaign_id": "82ee2c37-c8f8-4974-9560-ef93ad51d58z",
      "campaign_type": "Newsletter",
      "last_sent_date": "2019-04-25T11:08:00.000Z",
      "unique_counts": {
        "sends": 3129,
        "opens": 1672,
        "clicks": 256,
        "forwards": 21,
        "optouts": 3,
        "abuse": 1,
        "bounces": 210,
        "not_opened": 1211
      }
    }
  ],
  "aggregate_percents": {
    "click": 43,
    "open": 12,
    "did_not_open": 23,
    "bounce": 21,
    "unsubscribe": 2
  }
}

Changes

  • 2483585c5d89Revision changes
    • info

      the endpoint scheme security api_key was removed from the API

  • f1d4ed59fcf2Revision changes
    • info

      the security scope campaign_data was added to the endpoint's security scheme oauth2_access_code

    • info

      the security scope campaign_data was added to the endpoint's security scheme oauth2_implicit

    • info

      the security scope contact_data was removed from the endpoint's security scheme oauth2_access_code

    • info

      the security scope contact_data was removed from the endpoint's security scheme oauth2_implicit