Contacts

Get email campaigns' statistics for a contact

get/contacts/{identifier}/campaignStats

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/contacts/{identifier}/campaignStats
  • Auth: one of:
    • API key in header api-key
    • API key in header partner-key

Path parameters

identifierstring required

Email (urlencoded) OR ID of the contact

Query parameters

startDatestring

Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate

endDatestring

Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days

Response

Contact campaign statistics informations

Example response

{
  "messagesSent": [
    {
      "campaignId": 3,
      "eventTime": "2017-03-12T20:15:13Z"
    }
  ],
  "hardBounces": [
    {
      "campaignId": 3,
      "eventTime": "2017-03-12T20:15:13Z"
    }
  ],
  "softBounces": [
    {
      "campaignId": 3,
      "eventTime": "2017-03-12T20:15:13Z"
    }
  ],
  "complaints": [
    {
      "campaignId": 3,
      "eventTime": "2017-03-12T20:15:13Z"
    }
  ],
  "unsubscriptions": {
    "userUnsubscription": [
      {
        "campaignId": 3,
        "eventTime": "2017-03-12T20:15:13Z",
        "ip": "165.87.3.15"
      }
    ],
    "adminUnsubscription": [
      {
        "eventTime": "2017-03-12T20:15:13Z",
        "ip": "165.87.3.15"
      }
    ]
  },
  "opened": [
    {
      "campaignId": 3,
      "count": 3,
      "eventTime": "2017-03-12T20:15:13Z",
      "ip": "165.87.3.15"
    }
  ],
  "clicked": [
    {
      "campaignId": 3,
      "links": [
        {
          "count": 1,
          "eventTime": "2017-03-12T20:15:13Z",
          "ip": "165.87.3.15",
          "url": "www.myshop.com"
        }
      ]
    }
  ],
  "transacAttributes": [
    {
      "orderDate": "2017-03-12",
      "orderPrice": 24.99,
      "orderId": 248
    }
  ],
  "delivered": [
    {
      "campaignId": 3,
      "eventTime": "2017-03-12T20:15:13Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.