Marketing Campaign Stats
The Marketing Campaigns Stats endpoints allow you to retrieve stats for both Automations and Single Sends.
Note: These endpoints provide stats for Marketing Campaigns only. For stats related to event tracking, please see the Stats section under Event Tracking below.
Get All Single Sends Stats
GET /v3/marketing/stats/singlesends
Base url: https://api.sendgrid.com
This endpoint allows you to retrieve stats for all your Single Sends.
By default, all of your Single Sends will be returned, but you can specify a selection by passing in a comma-separated list of Single Send IDs as the value of the query string parameter singlesend_ids.
Responses are paginated. You can limit the number of responses returned per batch using the page_size query string parameter. The default is 50, but you specify a value between 1 and 100.
You can retrieve a specific page of responses with the page_token query string parameter.
Authentication
- API Key
Headers
Query String
This endpoint returns all Single Send IDs if no IDs are included in singlesend_ids.
The number of elements you want returned on each page.
default: 50The stats endpoints are paginated. To get the next page, call the passed _metadata.next URL. If _metadata.prev doesn't exist, you're at the first page. Similarly, if _metadata.next is not present, you're at the last page.
Responses
This is the ID of the Single Dend you require stats for.
format: uuidThis is the A/B variation of the Single Send stat returned. If the group_by parameter doesn't include ab_variation in the request, then the value is "all".
This is the A/B phase of the Single Send stat returned. If the group_by parameter doesn't include ab_phase in the request, then the value is "all".
This describes the time unit to which the stat is rolled up. It is based on the aggregated_by parameter included in the request. It can be "total" or the date (in YYYY-MM-DD format) the stats are for.
The URL of the previous page of results. If this field isn't present, you're at the start of the list.
format: uriThe URL of the current page of results.
format: uriThe URL of the next page of results. If this field isn't present, you're at the end of the list.
format: uriThe number of items in the entire list, i.e., across all pages.
the error message
the field that generated the error
helper text or docs for troubleshooting
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}Need some help?
We all do sometimes. Get help now from the Twilio SendGrid Support Team.
Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.
