SendGrid

Twilio SendGrid Marketing Campaigns Statistics API

The Marketing Campaigns Stats API allows you to retrieve statistics for both Automations and Single Sends. The statistics provided include bounces, clicks,…

Communication#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Marketing Campaigns Stats API allows you to retrieve statistics for both Automations and Single Sends. The statistics provided include bounces, clicks, opens, and more. You can export stats in CSV format for use in other applications. You can also retrieve Marketing Campaigns stats in the Marketing Campaigns application user interface.

This API provides statistics for Marketing Campaigns only. For stats related to event tracking, please see the Stats API.

Endpoints 8

Stats

  • GETGet All Automation Stats/v3/marketing/stats/automations?automation_ids=string&page_size=25&page_token=stringThis endpoint allows you to retrieve stats for all your Automations. By default, all of your Automations will be returned, but you can specify a selection by…
  • GETGet Automation Stats by ID/v3/marketing/stats/automations/:id?group_by=step_id&step_ids=3fa85f64-5717-4562-b3fc-2c963f66afa6&aggregated_by=day&start_date=2021-01-01&end_date=2021-12-31&timezone=UTC&page_size=25&page_token=stringThis endpoint allows you to retrieve stats for a single Automation using its ID. Multiple Automation IDs can be retrieved using the "Get All Automation Stats"…
  • GETGet Automation Click Tracking Stats by ID/v3/marketing/stats/automations/:id/links?group_by=step_id&step_ids=3fa85f64-5717-4562-b3fc-2c963f66afa6&page_size=25&page_token=stringThis endpoint lets you retrieve click-tracking stats for a single Automation. The stats returned list the URLs embedded in your Automation and the number of…
  • GETExport Single Send Stats/v3/marketing/stats/automations/export?ids=string&timezone=UTCThis endpoint allows you to export Single Send stats as .CSV data. You can specify one Single Send or many: include as many Single Send IDs as you need,…
  • GETGet All Single Sends Stats/v3/marketing/stats/singlesends?singlesend_ids=string&page_size=25&page_token=stringThis 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…
  • GETGet Single Send Stats by ID/v3/marketing/stats/singlesends/:id?aggregated_by=day&start_date=2021-01-01&end_date=2021-12-31&timezone=UTC&page_size=25&page_token=string&group_by=ab_variationThis endpoint allows you to retrieve stats for an individual Single Send using a Single Send ID. Multiple Single Send IDs can be retrieved using the "Get All…
  • GETGet Single Send Click Tracking Stats by ID/v3/marketing/stats/singlesends/:id/links?page_size=25&page_token=string&group_by=ab_variation&ab_variation_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&ab_phase_id=testThis endpoint lets you retrieve click-tracking stats for one Single Send. The stats returned list the URLs embedded in the specified Single Send and the…
  • GETExport Single Send Stats/v3/marketing/stats/singlesends/export?ids=string&timezone=UTCThis endpoint allows you to export Single Send stats as .CSV data. You can specify one Single Send or many: include as many Single Send IDs as you need,…

API details

Base URL
https://api.sendgrid.com
Authentication
A bearer token in the Authorization header
Operations
8 operations on 8 pathsGET 8
Main resources
Stats 8
Response formats
application/json
Description format
OpenAPI 3.1.0, API version 1.0.0

How to test the Twilio SendGrid Marketing Campaigns Statistics API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Twilio SendGrid Marketing Campaigns Statistics API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get All Automation Stats” (GET /v3/marketing/stats/automations?automation_ids=string&page_size=25&page_token=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Twilio SendGrid Marketing Campaigns Statistics API?

The Marketing Campaigns Stats API allows you to retrieve statistics for both Automations and Single Sends. The statistics provided include bounces, clicks,… It is listed under Communication and has 8 endpoints.

Who publishes the Twilio SendGrid Marketing Campaigns Statistics API?

It is listed from SendGrid's public API description (an OpenAPI document), not published by SendGrid on Swastik Codes. Anyone who controls sendgrid.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Twilio SendGrid Marketing Campaigns Statistics API?

Requests go to https://api.sendgrid.com. Endpoint paths are added to this base URL.

How do I authenticate with the Twilio SendGrid Marketing Campaigns Statistics API?

With A bearer token in the Authorization header.

How many endpoints does the Twilio SendGrid Marketing Campaigns Statistics API have?

8 operations on 8 paths (8 GET). The largest groups are Stats.

Is forking the Twilio SendGrid Marketing Campaigns Statistics API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.