# Retrieve email statistics by mailbox provider. ## API Overview 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 basics of clicks and opens to looking at which browsers and mailbox providers your customers use. We have broken up statistics in specific ways so that you can get at-a-glance data, as well as allowing you to get into the details of how your email is being used. > \[!NOTE] > > Category statistics are available for the previous thirteen months only. ## Operation overview ```json {"path":"https://api.sendgrid.com/v3/mailbox_providers/stats","method":"get","servers":[{"url":"https://api.sendgrid.com","description":"for global users and subusers"},{"url":"https://api.eu.sendgrid.com","description":"for EU regional subusers"}]} ``` **This endpoint allows you to retrieve your email statistics segmented by recipient mailbox provider.** **We only store up to 7 days of email activity in our database.** By default, 500 items will be returned per request via the Advanced Stats API endpoints. Advanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our [Statistics Overview](/docs/sendgrid/ui/analytics-and-reporting/stats-overview/). ## Operation details ### Authentication API Key ### Headers ```json [{"in":"header","name":"Authorization","required":true,"default":"Bearer <>","schema":{"type":"string"}},{"name":"on-behalf-of","in":"header","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](/docs/sendgrid/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.","required":false,"schema":{"type":"string"},"refName":"#/components/parameters/OnBehalfOf","modelName":"__components_parameters_OnBehalfOf"}] ``` ### Query string ```json [{"name":"mailbox_providers","in":"query","description":"The mail box providers to get statistics for. You can include up to 10 by including this parameter multiple times.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"The number of results to return.","required":false,"schema":{"type":"integer"},"refName":"#/components/parameters/StatsAdvancedQueryStringsLimitOffsetLimit","modelName":"__components_parameters_StatsAdvancedQueryStringsLimitOffsetLimit"},{"name":"offset","in":"query","description":"The point in the list to begin retrieving results.","required":false,"schema":{"type":"integer"},"refName":"#/components/parameters/StatsAdvancedQueryStringsLimitOffsetOffset","modelName":"__components_parameters_StatsAdvancedQueryStringsLimitOffsetOffset"},{"name":"aggregated_by","in":"query","description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\".","required":false,"schema":{"type":"string","enum":["day","week","month"],"refName":"AggregatedBy3","modelName":"AggregatedBy3"},"refName":"#/components/parameters/StatsAdvancedQueryStringsLimitOffsetAggregatedBy","modelName":"__components_parameters_StatsAdvancedQueryStringsLimitOffsetAggregatedBy"},{"name":"start_date","in":"query","description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.","required":true,"schema":{"type":"string"},"refName":"#/components/parameters/StatsAdvancedQueryStringsLimitOffsetStartDate","modelName":"__components_parameters_StatsAdvancedQueryStringsLimitOffsetStartDate"},{"name":"end_date","in":"query","description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.","required":false,"schema":{"type":"string"},"refName":"#/components/parameters/StatsAdvancedQueryStringsLimitOffsetEndDate","modelName":"__components_parameters_StatsAdvancedQueryStringsLimitOffsetEndDate"}] ``` ### Responses ```json [{"responseCode":"200","schema":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","description":"The date that the statistics were gathered."},"stats":{"type":"array","description":"The list of statistics.","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of segmentation."},"name":{"type":"string","description":"The name of the specific segmentation."},"metrics":{"title":"Stats: Advanced Stats for Mailbox Provider","description":"The individual events and their stats.","type":"object","refName":"AdvancedStatsMailboxProvider","modelName":"AdvancedStatsMailboxProvider","properties":{"blocks":{"type":"integer","description":"The number of emails that were not allowed to be delivered by ISPs."},"bounces":{"type":"integer","description":"The number of emails that bounced instead of being delivered."},"deferred":{"type":"integer","description":"The number of emails that temporarily could not be delivered."},"delivered":{"type":"integer","description":"The number of emails SendGrid was able to confirm were actually delivered to a recipient."},"drops":{"type":"integer","description":"The number of emails that were not delivered due to the recipient email address being on a suppression list."},"requests":{"type":"integer","description":"The number of emails that were requested to be delivered."},"processed":{"type":"integer","description":"Requests from your website, application, or mail client via SMTP Relay or the Web API that SendGrid processed."},"spam_reports":{"type":"integer","description":"The number of recipients who marked your email as spam."}}}}}}}}},"examples":{"response":{"value":[{"date":"2015-10-11","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]},{"date":"2015-10-12","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]},{"date":"2015-10-13","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]},{"date":"2015-10-14","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]},{"date":"2015-10-15","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]},{"date":"2015-10-16","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]},{"date":"2015-10-17","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]},{"date":"2015-10-18","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]},{"date":"2015-10-19","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]},{"date":"2015-10-20","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]},{"date":"2015-10-21","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":1,"drops":0,"opens":1,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":1}}]},{"date":"2015-10-22","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]},{"date":"2015-10-23","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]},{"date":"2015-10-24","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]},{"date":"2015-10-25","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]},{"date":"2015-10-26","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":2,"drops":0,"opens":2,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":2}}]},{"date":"2015-10-27","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]},{"date":"2015-10-28","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]},{"date":"2015-10-29","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]},{"date":"2015-10-30","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]},{"date":"2015-10-31","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]},{"date":"2015-11-01","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]},{"date":"2015-11-02","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]},{"date":"2015-11-03","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]},{"date":"2015-11-04","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]},{"date":"2015-11-05","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]},{"date":"2015-11-06","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]},{"date":"2015-11-07","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]},{"date":"2015-11-08","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]},{"date":"2015-11-09","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]},{"date":"2015-11-10","stats":[{"type":"mailbox_provider","name":"Gmail","metrics":{"blocks":0,"bounces":0,"clicks":0,"deferred":0,"delivered":0,"drops":0,"opens":0,"processed":0,"requests":0,"spam_reports":0,"unique_clicks":0,"unique_opens":0}}]}]}}}}}}] ``` Retrieve email statistics by mailbox provider. ```js const client = require("@sendgrid/client"); client.setApiKey(process.env.SENDGRID_API_KEY); const queryParams = { start_date: "2009-07-06" }; const request = { url: `/v3/mailbox_providers/stats`, method: "GET", qs: queryParams, }; client .request(request) .then(([response, body]) => { console.log(response.statusCode); console.log(response.body); }) .catch((error) => { console.error(error); }); ``` ```python import os from sendgrid import SendGridAPIClient sg = SendGridAPIClient(os.environ.get("SENDGRID_API_KEY")) params = {"start_date": "2009-07-06"} response = sg.client.mailbox_providers.stats.get(query_params=params) print(response.status_code) print(response.body) print(response.headers) ``` ```csharp using System; using System.Collections.Generic; using System.Threading.Tasks; using SendGrid; public class Program { public static async Task Main() { string apiKey = Environment.GetEnvironmentVariable("SENDGRID_API_KEY"); var client = new SendGridClient(apiKey); var queryParams = @"{'start_date': '2009-07-06'}"; var response = await client.RequestAsync( method: SendGridClient.Method.GET, urlPath: "mailbox_providers/stats", queryParams: queryParams); Console.WriteLine(response.StatusCode); Console.WriteLine(response.Body.ReadAsStringAsync().Result); Console.WriteLine(response.Headers.ToString()); } } ``` ```java import com.sendgrid.*; import java.io.IOException; public class Example { public static void main(String[] args) throws IOException { try { SendGrid sg = new SendGrid(System.getenv("SENDGRID_API_KEY")); Request request = new Request(); request.setMethod(Method.GET); request.setEndpoint("/mailbox_providers/stats"); request.addQueryParam("start_date", "2009-07-06"); Response response = sg.api(request); System.out.println(response.getStatusCode()); System.out.println(response.getBody()); System.out.println(response.getHeaders()); } catch (IOException ex) { throw ex; } } } ``` ```go package main import ( "fmt" "github.com/sendgrid/sendgrid-go" "os" ) func main() { apiKey := os.Getenv("SENDGRID_API_KEY") host := "https://api.sendgrid.com" request := sendgrid.GetRequest(apiKey, "/v3/mailbox_providers/stats", host) request.Method = "GET" queryParams := make(map[string]string) queryParams["start_date"] = "2009-07-06" request.QueryParams = queryParams response, err := sendgrid.API(request) if err != nil { fmt.Println(err.Error()) os.Exit(1) } else { fmt.Println(response.StatusCode) fmt.Println(response.Body) fmt.Println(response.Headers) } } ``` ```php /sendgrid-php.php'; $apiKey = getenv("SENDGRID_API_KEY"); $sg = new \SendGrid($apiKey); $query_params = json_decode('{ "start_date": "2009-07-06" }'); try { $response = $sg->client ->mailbox_providers() ->stats() ->get(null, $query_params); print $response->statusCode() . "\n"; print_r($response->headers()); print $response->body() . "\n"; } catch (Exception $ex) { echo "Caught exception: " . $ex->getMessage(); } ``` ```ruby require 'sendgrid-ruby' include SendGrid sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY']) params = JSON.parse('{ "start_date": "2009-07-06" }') response = sg.client.mailbox_providers.stats.get(query_params: params) puts response.status_code puts response.headers puts response.body ``` ```bash curl -G -X GET "https://api.sendgrid.com/v3/mailbox_providers/stats?start_date=2009-07-06" \ --header "Authorization: Bearer $SENDGRID_API_KEY" ```