{"command":{"effect":"read","timeoutSeconds":30,"inputSchema":{"type":"object","description":"**This endpoint allows you to retrieve your email statistics segmented by recipient mailbox provider.**\n\nBy default, 500 items will be returned per request via the Advanced Stats API endpoints.\n\nAdvanced 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](https://sendgrid.com/docs/ui/analytics-and-reporting/stats-overview/).","properties":{"query":{"type":"object","properties":{"mailbox_providers":{"type":"string","description":"The mail box providers to get statistics for. You can include up to 10 by including this parameter multiple times."},"aggregated_by":{"allOf":[{"$ref":"#/definitions/AggregatedBy3"},{"type":"string"}],"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\"."},"start_date":{"type":"string","description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD."},"end_date":{"type":"string","description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."}},"required":["start_date"],"additionalProperties":false},"headers":{"type":"object","properties":{"on-behalf-of":{"type":"string","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 <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: <subuser-username>`). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information."}},"required":[],"additionalProperties":false}},"required":["query"],"additionalProperties":false,"definitions":{"AggregatedBy3":{"type":"string","enum":["day","week","month"]}}},"name":"Retrieve email statistics by mailbox provider.","id":"sendgrid.stats.listmailboxproviderstat","example":{"query":{"start_date":"example"}},"maxRequests":1,"summary":false}}