Twilio SendGrid Statistics API
The Twilio SendGrid Statistics API allows you to retrieve the various statistics related to your email program. Tracking your emails is an important part of…
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 Twilio SendGrid Statistics API allows you to retrieve the various statistics related to your email program.
Tracking your emails is an important part of being a good sender and learning about how your users interact with your email. This includes everything from clicks and opens to looking at which browsers and mailbox providers your customers use.
SendGrid has broken up statistics in specific ways so that you can get at-a-glance data, as well as the details of how your email is being used.
Category statistics are available for the previous thirteen months only.
To learn more, see Statistics Overview.
Endpoints 10
Categories
- GETRetrieve all categories
/v3/categories?limit=50&category=string&offset=0This endpoint allows you to retrieve a paginated list of all of your categories. You can use the limit query parameter to set the page size. If your list… - GETRetrieve Email Statistics for Categories
/v3/categories/stats?start_date=string&end_date=string&categories=string&aggregated_by=dayThis endpoint allows you to retrieve all of your email statistics for each of your categories. If you do not define any query parameters, this endpoint will… - GETRetrieve sums of email stats for each category.
/v3/categories/stats/sums?sort_by_metric=delivered&sort_by_direction=desc&start_date=string&end_date=string&limit=5&offset=0&aggregated_by=dayThis endpoint allows you to retrieve the total sum of each email statistic for every category over the given date range. If you do not define any query…
Stats
- GETRetrieve email statistics by browser.
/v3/browsers/stats?browsers=string&aggregated_by=day&start_date=string&end_date=stringThis endpoint allows you to retrieve your email statistics segmented by browser type. By default, 500 items will be returned per request via the Advanced… - GETRetrieve email statistics by client type.
/v3/clients/stats?start_date=string&end_date=string&aggregated_by=dayThis endpoint allows you to retrieve your email statistics segmented by client type. By default, 500 items will be returned per request via the Advanced Stats… - GETRetrieve stats by a specific client type.
/v3/clients/:client_type/stats?start_date=string&end_date=string&aggregated_by=dayThis endpoint allows you to retrieve your email statistics segmented by a specific client type. By default, 500 items will be returned per request via the… - GETRetrieve email statistics by device type.
/v3/devices/stats?aggregated_by=day&start_date=string&end_date=stringThis endpoint allows you to retrieve your email statistics segmented by the device type. We only store up to 7 days of email activity in our database. By… - GETRetrieve email statistics by country and state/province.
/v3/geo/stats?country=US&aggregated_by=day&start_date=string&end_date=stringThis endpoint allows you to retrieve your email statistics segmented by country and state/province. By default, 500 items will be returned per request via the… - GETRetrieve email statistics by mailbox provider.
/v3/mailbox_providers/stats?mailbox_providers=string&aggregated_by=day&start_date=string&end_date=stringThis endpoint allows you to retrieve your email statistics segmented by recipient mailbox provider. By default, 500 items will be returned per request via the… - GETRetrieve global email statistics
/v3/stats?aggregated_by=day&start_date=string&end_date=stringThis endpoint allows you to retrieve all of your global email statistics between a given date range. Parent accounts can see either aggregated stats for the…
API details
- Base URL
https://api.sendgrid.comhttps://api.eu.sendgrid.com- Authentication
- A bearer token in the Authorization header
- Operations
- 10 operations on 10 pathsGET 10
- Main resources
- Stats 7Categories 3
- Response formats
application/json- Description format
- OpenAPI 3.1.0, API version
1.0.0 - Links
- Documentation · OpenAPI document · Terms of service · Support
How to test the Twilio SendGrid Statistics API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Twilio SendGrid Statistics API collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “Retrieve all categories” (GET /v3/categories?limit=50&category=string&offset=0), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Twilio SendGrid Statistics API?
The Twilio SendGrid Statistics API allows you to retrieve the various statistics related to your email program. Tracking your emails is an important part of… It is listed under Communication and has 10 endpoints.
Who publishes the Twilio SendGrid 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 Statistics API?
Its description lists 2 base URLs: https://api.sendgrid.com, https://api.eu.sendgrid.com. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Twilio SendGrid Statistics API?
With A bearer token in the Authorization header.
How many endpoints does the Twilio SendGrid Statistics API have?
10 operations on 10 paths (10 GET). The largest groups are Stats, Categories.
Is forking the Twilio SendGrid Statistics API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.