{"componentChunkName":"component---src-templates-api-js","path":"/api/events/","result":{"data":{"allApiBlueprint":{"edges":[{"node":{"meta":{"title":"A/B Testing API","label":"New"},"fields":{"path":"/api/ab-testing/","file":"ab-testing.apib"}}},{"node":{"meta":{"title":"Data Privacy API","label":"New"},"fields":{"path":"/api/data-privacy/","file":"data-privacy.apib"}}},{"node":{"meta":{"title":"Events API","label":null},"fields":{"path":"/api/events/","file":"events.apib"}}},{"node":{"meta":{"title":"Ingest API","label":"Private Access"},"fields":{"path":"/api/events-ingest/","file":"events-ingest.apib"}}},{"node":{"meta":{"title":"Inbound Domains API","label":null},"fields":{"path":"/api/inbound-domains/","file":"inbound-domains.apib"}}},{"node":{"meta":{"title":"Account API","label":null},"fields":{"path":"/api/account/","file":"account.apib"}}},{"node":{"meta":{"title":"API Overview","label":null},"fields":{"path":"/api/","file":"index.apib"}}},{"node":{"meta":{"title":"Automatic Inline Seeding","label":"Deliverability"},"fields":{"path":"/api/inline-seeds/","file":"inline-seeds.apib"}}},{"node":{"meta":{"title":"Labs APIs","label":null},"fields":{"path":"/api/labs/","file":"labs.apib"}}},{"node":{"meta":{"title":"Message Events API","label":null},"fields":{"path":"/api/message-events/","file":"message-events.apib"}}},{"node":{"meta":{"title":"Recipient Validation API","label":"New"},"fields":{"path":"/api/recipient-validation/","file":"recipient-validation.apib"}}},{"node":{"meta":{"title":"IP Pools API","label":null},"fields":{"path":"/api/ip-pools/","file":"ip-pools.apib"}}},{"node":{"meta":{"title":"Seed List API","label":"Deliverability"},"fields":{"path":"/api/seed-list/","file":"seed-list.apib"}}},{"node":{"meta":{"title":"Bounce Domains API","label":null},"fields":{"path":"/api/bounce-domains/","file":"bounce-domains.apib"}}},{"node":{"meta":{"title":"Recipient Lists API","label":null},"fields":{"path":"/api/recipient-lists/","file":"recipient-lists.apib"}}},{"node":{"meta":{"title":"Sending IPs API","label":null},"fields":{"path":"/api/sending-ips/","file":"sending-ips.apib"}}},{"node":{"meta":{"title":"Relay Webhooks API","label":null},"fields":{"path":"/api/relay-webhooks/","file":"relay-webhooks.apib"}}},{"node":{"meta":{"title":"SMTP API","label":null},"fields":{"path":"/api/smtp/","file":"smtp.apib"}}},{"node":{"meta":{"title":"Snippets API","label":"New"},"fields":{"path":"/api/snippets/","file":"snippets.apib"}}},{"node":{"meta":{"title":"Subaccounts API","label":null},"fields":{"path":"/api/subaccounts/","file":"subaccounts.apib"}}},{"node":{"meta":{"title":"Sending Domains API","label":null},"fields":{"path":"/api/sending-domains/","file":"sending-domains.apib"}}},{"node":{"meta":{"title":"Suppression List API","label":null},"fields":{"path":"/api/suppression-list/","file":"suppression-list.apib"}}},{"node":{"meta":{"title":"Template Language","label":null},"fields":{"path":"/api/template-language/","file":"template-language.apib"}}},{"node":{"meta":{"title":"Tracking Domains API","label":null},"fields":{"path":"/api/tracking-domains/","file":"tracking-domains.apib"}}},{"node":{"meta":{"title":"Templates API","label":null},"fields":{"path":"/api/templates/","file":"templates.apib"}}},{"node":{"meta":{"title":"Transmissions API","label":null},"fields":{"path":"/api/transmissions/","file":"transmissions.apib"}}},{"node":{"meta":{"title":"Event Webhooks API","label":null},"fields":{"path":"/api/webhooks/","file":"webhooks.apib"}}},{"node":{"meta":{"title":"Usage API","label":null},"fields":{"path":"/api/usage/","file":"usage.apib"}}},{"node":{"meta":{"title":"Metrics API","label":null},"fields":{"path":"/api/metrics/","file":"metrics.apib"}}}]},"apiBlueprint":{"ast":{"element":"parseResult","content":[{"element":"category","meta":{"classes":{"element":"array","content":[{"element":"string","content":"api"}]},"title":{"element":"string","content":""}},"attributes":{"meta":{"element":"array","content":[{"element":"member","meta":{"classes":{"element":"array","content":[{"element":"string","content":"user"}]}},"content":{"key":{"element":"string","content":"FORMAT"},"value":{"element":"string","content":"1A"}}},{"element":"member","meta":{"classes":{"element":"array","content":[{"element":"string","content":"user"}]}},"content":{"key":{"element":"string","content":"title"},"value":{"element":"string","content":"Events API"}}},{"element":"member","meta":{"classes":{"element":"array","content":[{"element":"string","content":"user"}]}},"content":{"key":{"element":"string","content":"description"},"value":{"element":"string","content":"Query detailed SparkPost event data for further analysis and processing."}}}]}},"content":[{"element":"category","meta":{"classes":{"element":"array","content":[{"element":"string","content":"resourceGroup"}]},"title":{"element":"string","content":"Events"}},"content":[{"element":"copy","content":"The Events API allows searching for recent events, and supports various types of result filtering. \nAvailable events include message status – injection, delivery, bounce – as well as recipient engagement – clicks and opens. \nYou can fetch all event types or only specific ones, such as bounces, deliveries, or clicks.\nYou can also filter by date range, campaign, or just about any other field.\nIt provides access to similar event data that can also be delivered via [Webhooks](/api/webhooks/).\n\n<Banner status=\"info\">The maximum URI length is 4096 characters, so please keep your queries below that size when adding filters to an API call.</Banner>\n\n* * *\n\n**The SparkPost Events API uses MaxMind software [MaxMind License](https://www.maxmind.com/download/geoip/database/LICENSE.txt)**\n\n* * *\n\n### Data Retention\n\nData in the Events API is retained for 10 days. Aggregate reporting data is available through [metrics](/api/metrics/) or the app for up to 6 months.\n\n### Event Types\n\nYou can query the following types of events from the Events API.\n\n<MessageEvents></MessageEvents>\n\n### Keyword Searching\n\nSome of the filter query parameters in the Events API support keyword searching.  Keyword searching allows for filtering results without the precise value\nand also allows filtering for multiple values, without having to enter in each value individually.  Keywords are determined by natural breaks in phrases by\nspaces, dashes, underscores, and in special cases periods(`recipient_domains` and `sending_domains`).\n\nFor example, suppose the following campaigns are sent via SparkPost: `blackfriday-specials`, `blackfriday-members`, and `blackfriday-flash-deals`.\nWithout keyword searching, to retrieve results for all three campaigns, `?campaigns=blackfriday-specials,blackfriday-members,blackfriday-flash-deals` would need to be\nadded to the Events API request. With keyword searching, the previous example can be condensed into `?campaigns=blackfriday`, and the same data is returned as would be by\nthe much longer filter.\n\nIts important to distinguish that searching for a keyword is different than a partial search.  In the previous example, \nsearching for `?campaigns=friday` will not return any of the same results that `?campaigns=blackfriday` would return.\n\nFilters that support keyword searching are:\n\n-   `ab_tests`\n\n-   `campaigns`\n\n-   `ip_pools`\n\n-   `reasons`\n\n-   `recipient_domains`\n\n-   `sending_domains`\n\n-   `subjects`\n\n-   `templates`\n\n-   `mailbox_providers`\n\n-   `mailbox_provider_regions`"},{"element":"resource","meta":{"title":{"element":"string","content":"Pagination"}},"attributes":{"href":{"element":"string","content":"/v1/events"}},"content":[{"element":"copy","content":"The Events API supports pagination for queries with larger result sets. Pagination is done through the use of the `cursor` and `per_page` query parameters.\nThe `per_page` query parameter tells the Events API the number of events to return in a single request, and supports a maximum value of 10,000.\n\nTo start a paging request, add the query parameter `?cursor=initial` to your Events API request. This will fetch the first page of results. If cursor is not provided, then the default value of `initial` is applied.\nIn the response body, there are three main keys: `results`, `total_count` and `links`. `results` is an array which contains the page of JSON events that matched the request,\n`total_count` is an integer that describes the total number of JSON events that matched your request, and `links` is an object which provides a way to request the next page of events, if there is more than one page.\n\nOnce you have the response, you then can use `links` to retrieve the URL for your next page, which will be prefilled with the appropriate value for the `cursor` query parameter,\nas well as any other filters you supplied with the original request.\n\nIn the following examples, to retrieve the first page, we use the `initial` value for the `cursor` query parameter.  the `cursor` value from\nthe `next` key in the `links` object, and use that to make the request for the second page. This process would then be repeated until all results have been paged through,\nat which point the `links` object will not have a `next` key, and no further additional requests are necessary.\n\nIf your result set is less than one page of data, then the `links` object will not have a `next` key.\n\n<Banner status=\"info\">Pagination requests count towards the number of requests allowed by rate limiting, the same as non-paginated requests.</Banner>"},{"element":"transition","meta":{"title":{"element":"string","content":"Retrieve First Page"}},"attributes":{"href":{"element":"string","content":"/v1/events/message{?per_page,cursor}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"per_page"},"value":{"element":"string","content":"1000"}}},{"element":"member","meta":{"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"cursor"},"value":{"element":"string","content":"initial"}}}]}},"content":[{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"    {\n      \"results\": [\n        ...\n      ],\n      \"total_count\": 20000,\n      \"links\": {\n        \"next\": \"/api/v1/events/message?events=delivery&per_page=1000&cursor=WycyMDE4LTExLTA1VDIyOjQ1OjM5LjAwMFonLCAnc3BjLTM4MTQ1MjY3MjMyNTA2NTEwJ10=\"\n      }\n    }\n\n"}]}]}]},{"element":"transition","meta":{"title":{"element":"string","content":"Retrieve Subsequent Page"}},"attributes":{"href":{"element":"string","content":"/v1/events/message{?per_page,cursor}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"per_page"},"value":{"element":"string","content":"1000"}}},{"element":"member","meta":{"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"cursor"},"value":{"element":"string","content":"WycyMDE4LTExLTA1VDIyOjQ1OjM5LjAwMFonLCAnc3BjLTM4MTQ1MjY3MjMyNTA2NTEwJ10="}}}]}},"content":[{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"    {\n      \"results\": [\n        ...\n      ],\n      \"total_count\": 20000,\n      \"links\": {\n        \"next\": \"/api/v1/events/message?events=delivery&per_page=1000&cursor=WycyMDE4LTExLTA0VDIyOjQ1OjM5LjAwMFonLCAndWF0LTM4MTQ1MjE3MjUyNTY2NTIwJ10=\"\n      }\n    }\n\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Search"}},"attributes":{"href":{"element":"string","content":"/v1/events"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Search for Message Events"}},"attributes":{"href":{"element":"string","content":"/v1/events/message{?ab_tests,ab_test_versions,bounce_classes,campaigns,cursor,delimiter,event_ids,events,from,from_addresses,ip_pools,messages,per_page,reasons,recipients,recipient_domains,subjects,sending_domains,sending_ips,subaccounts,templates,to,transmissions}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"description":{"element":"string","content":"Datetime in format of `YYYY-MM-DDTHH:MM:ssZ`, inclusive. Value should be in UTC."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"from"},"value":{"element":"string","attributes":{"default":{"element":"string","content":"24 hours ago"}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Datetime in format of `YYYY-MM-DDTHH:MM:ssZ`, exclusive. Value should be in UTC."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"to"},"value":{"element":"string","attributes":{"default":{"element":"string","content":"1 minute ago"}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Results cursor for pagination. Used in conjunction with `per_page` parameter. See [Pagination](/api/events/#events-pagination) section for details."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"cursor"},"value":{"element":"string","attributes":{"default":{"element":"string","content":"initial"}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Maximum number of results to return per page. Must be between 1 and 10,000."},"title":{"element":"string","content":"number"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"per_page"},"value":{"element":"string","attributes":{"default":{"element":"string","content":"1000"}}}}},{"element":"member","meta":{"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"delimiter"},"value":{"element":"string","attributes":{"default":{"element":"string","content":","}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Comma delimited list of event IDs to search."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"event_ids"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Comma delimited list of event types to search."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"events"},"value":{"element":"string","attributes":{"default":{"element":"string","content":"all event types"}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Comma delimited list of recipients to search."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"recipients"},"value":{"element":"string","content":"recipient@example.com"}}},{"element":"member","meta":{"description":{"element":"string","content":"Comma delimited list of recipient domains to search. Supports keyword searching by domain segment."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"recipient_domains"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Comma delimited list of friendly from addresses to search."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"from_addresses"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Comma delimited list of sending domains to search. Supports keyword searching by domain segment."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"sending_domains"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Comma delimited list of subject lines from the email header to search. Supports keyword searching."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"subjects"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Comma delimited list of bounce classification codes to search. See [Bounce Classification Codes](https://www.sparkpost.com/docs/deliverability/bounce-classification-codes/)."},"title":{"element":"string","content":"number"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"bounce_classes"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Comma delimited list of Bounce/failure/rejection reason to search. Supports keyword searching"},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"reasons"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Comma delimited list of campaign IDs to search. Supports keyword searching."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"campaigns"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Comma delimited list of template IDs to search. Supports keyword searching."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"templates"},"value":{"element":"string","content":"my-template"}}},{"element":"member","meta":{"description":{"element":"string","content":"Comma delimited list of sending IP addresses to search."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"sending_ips"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Comma delimited list of IP pool IDs to search. Supports keyword searching."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"ip_pools"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Comma delimited list of subaccount IDs to search."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"subaccounts"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Comma delimited list of message IDs to search."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"messages"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Comma delimited list of transmission IDs to search."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"transmissions"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Comma delimited list of mailbox providers to search. Supports keyword searching."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"mailbox_providers"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Comma delimited list of mailbox provider regions to search. Supports keyword searching."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"mailbox_provider_regions"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Comma delimited list of A/B test IDs to search. Supports keyword searching."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"ab_tests"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Comma delimited list of version numbers of A/B tests to search. If provided, `ab_tests` parameter becomes required."},"title":{"element":"string","content":"number"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"ab_test_versions"},"value":{"element":"string"}}}]}},"content":[{"element":"copy","content":"Returns a list of message events that matched the filtered search."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"results\": [\n          {\n              \"type\": \"click\",\n              \"campaign_id\": \"Example Campaign Name\",\n              \"customer_id\": \"1\",\n              \"delv_method\": \"esmtp\",\n              \"event_id\": \"92356927693813856\",\n              \"friendly_from\": \"sender@example.com\",\n              \"geo_ip\": {\n                  \"country\": \"US\",\n                  \"region\": \"MD\",\n                  \"city\": \"Columbia\",\n                  \"latitude\": \"39.1749\",\n                  \"longitude\": \"-76.8375\"\n              },\n              \"injection_time\": \"2016-04-18T14:25:07.000+00:00\",\n              \"ip_address\": \"127.0.0.1\",\n              \"ip_pool\": \"Example-Ip-Pool\",\n              \"message_id\": \"000443ee14578172be22\",\n              \"msg_from\": \"sender@example.com\",\n              \"msg_size\": \"1337\",\n              \"num_retries\": \"2\",\n              \"queue_time\": \"12\",\n              \"rcpt_meta\": {\n                  \"customKey\": \"customValue\",\n                  \"anotherKey\": [\"value1\", \"value2\", \"value3\"]\n              },\n              \"rcpt_tags\": [\n                  \"male\",\n                  \"US\"\n              ],\n              \"rcpt_to\": \"recipient@example.com\",\n              \"raw_rcpt_to\": \"recipient@example.com\",\n              \"rcpt_type\": \"cc\",\n              \"recipient_domain\": \"example.com\",\n              \"routing_domain\": \"example.com\",\n              \"sending_domain\": \"example.com\",\n              \"sending_ip\": \"127.0.0.1\",\n              \"subaccount_id\": \"101\",\n              \"subject\": \"Summer deals are here!\",\n              \"target_link_name\": \"Example Link Name\",\n              \"target_link_url\": \"http://example.com\",\n              \"template_id\": \"my-template\",\n              \"template_version\": \"1\",\n              \"timestamp\": \"2016-04-18T14:25:07.000+00:00\",\n              \"transmission_id\": \"65832150921904138\",\n              \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.118 Safari/537.36\",\n              \"mailbox_provider\": \"Gmail\",\n              \"mailbox_provider_region\": \"Europe\"\n          }\n      ],\n      \"total_count\": 1,\n      \"links\": {}\n  }\n"}]}]}]},{"element":"transition","meta":{"title":{"element":"string","content":"Search for Ingest Events"}},"attributes":{"href":{"element":"string","content":"/v1/events/ingest{?batch_ids,cursor,delimiter,error_types,events,event_ids,from,retryable,subaccounts,to}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"description":{"element":"string","content":"Datetime in format of YYYY-MM-DDTHH:MM:ssZ, inclusive."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"from"},"value":{"element":"string","attributes":{"default":{"element":"string","content":"24 hours ago"}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Datetime in format of YYYY-MM-DDTHH:MM:ssZ, exclusive."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"to"},"value":{"element":"string","attributes":{"default":{"element":"string","content":"1 minute ago"}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Results cursor for pagination. Used in conjunction with `per_page` parameter. See [Pagination](/api/events/#events-pagination) section for details."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"cursor"},"value":{"element":"string","attributes":{"default":{"element":"string","content":"initial"}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Maximum number of results to return per page. Must be between 1 and 10,000."},"title":{"element":"string","content":"number"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"per_page"},"value":{"element":"string","attributes":{"default":{"element":"string","content":"1000"}}}}},{"element":"member","meta":{"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"delimiter"},"value":{"element":"string","attributes":{"default":{"element":"string","content":","}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Comma delimited list of event types to search."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"events"},"value":{"element":"string","attributes":{"default":{"element":"string","content":"success,error"}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Comma delimited list of event IDs to search."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"event_ids"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Comma delimited list of batch IDs to search."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"batch_ids"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Filter ingest events by whether or not they are retryable."},"title":{"element":"string","content":"boolean"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"retryable"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Comma delimited list of subaccount IDs to search."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"subaccounts"},"value":{"element":"string"}}}]}},"content":[{"element":"copy","content":"Returns a list of ingest events that matched the filtered search."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"results\": [\n            {\n              \"retryable\": false,\n              \"number_succeeded\": 440,\n              \"event_id\": \"1d1941e9-4987-1a6c-b124-2a4328585721\",\n              \"number_failed\": 460,\n              \"batch_id\": \"fbd59e4c-1629-4736-803d-201ff9fa8dd6\",\n              \"expiration_timestamp\": \"2019-06-16T19:02:09.373Z\",\n              \"error_type\": \"validation\",\n              \"href\": \"https://api.sparkpost.com/ingest/number_failed/fbd59e4c-1629-4736-803d-201ff9fa8dd6\",\n              \"type\": \"error\",\n              \"customer_id\": 8675308,\n              \"subaccount_id\": 38,\n              \"number_duplicates\": 20,\n              \"timestamp\": \"2019-06-06T19:02:09.373Z\"\n            }\n      ],\n      \"total_count\": 1,\n      \"links\": {}\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Documentation"}},"attributes":{"href":{"element":"string","content":"/v1/events/message/documentation"}},"content":[{"element":"copy","content":"These endpoints are used to generate the samples and descriptions for the [Event Types](#header-event-types) section."},{"element":"transition","meta":{"title":{"element":"string","content":"Events Documentation"}},"content":[{"element":"copy","content":"Returns a list of descriptions of the event fields that could be included in a response from the message events search. Fields will vary by event type."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"{\n  \"results\": [\n    {\n      \"type\": {\n        \"description\": \"Type of event this record describes\",\n        \"sampleValue\": \"bounce\"\n      },\n      ...\n    },\n    ...\n  ]\n}\n"}]}]}]},{"element":"transition","meta":{"title":{"element":"string","content":"Events Samples"}},"attributes":{"href":{"element":"string","content":"/v1/events/message/samples{?events}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"description":{"element":"string","content":"Event types for which to get a sample payload. Defaults to all event types. See [Events Types](/api/events/#header-event-types) for the list of available event types."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"events"},"value":{"element":"string","content":"bounce"}}}]}},"content":[{"element":"copy","content":"Returns an example message event for each event type listed in the `events` parameter."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}}]}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"{\n  \"results\": [\n    {\n      \"type\": \"bounce\",\n      ...\n    }\n  ]\n}\n"}]}]}]}]}]}]},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":6},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":4678},{"element":"number","content":11}]}]}]}},"content":"missing response HTTP status code, assuming 'Response 200'"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":10},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":4691},{"element":"number","content":265}]}]}]}},"content":"dangling message-body asset, expected a pre-formatted code block, indent every of it's line by 4 spaces or 1 tabs"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":6},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":5203},{"element":"number","content":11}]}]}]}},"content":"missing response HTTP status code, assuming 'Response 200'"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":10},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":5216},{"element":"number","content":265}]}]}]}},"content":"dangling message-body asset, expected a pre-formatted code block, indent every of it's line by 4 spaces or 1 tabs"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":2},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":4956},{"element":"number","content":73}]}]}]}},"content":"action with method 'GET' already defined for resource '/v1/events'"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":10},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":9181},{"element":"number","content":27}]},{"element":"array","content":[{"element":"number","content":9216},{"element":"number","content":58}]}]}]}},"content":"headers is expected to be a pre-formatted code block, every of its line indented by exactly 12 spaces or 3 tabs"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":6},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":9277},{"element":"number","content":11}]}]}]}},"content":"missing response HTTP status code, assuming 'Response 200'"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":8},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":5505},{"element":"number","content":303}]}]}]}},"content":"parameter 'mailbox_providers' is not found within the URI template '/v1/events/message{?ab_tests,ab_test_versions,bounce_classes,campaigns,cursor,delimiter,event_ids,events,from,from_addresses,ip_pools,messages,per_page,reasons,recipients,recipient_domains,subjects,sending_domains,sending_ips,subaccounts,templates,to,transmissions}' for 'Search for Message Events' "},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":8},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":5505},{"element":"number","content":303}]}]}]}},"content":"parameter 'mailbox_provider_regions' is not found within the URI template '/v1/events/message{?ab_tests,ab_test_versions,bounce_classes,campaigns,cursor,delimiter,event_ids,events,from,from_addresses,ip_pools,messages,per_page,reasons,recipients,recipient_domains,subjects,sending_domains,sending_ips,subaccounts,templates,to,transmissions}' for 'Search for Message Events' "},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":10},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":13146},{"element":"number","content":27}]},{"element":"array","content":[{"element":"number","content":13181},{"element":"number","content":58}]}]}]}},"content":"headers is expected to be a pre-formatted code block, every of its line indented by exactly 12 spaces or 3 tabs"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":6},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":13242},{"element":"number","content":11}]}]}]}},"content":"missing response HTTP status code, assuming 'Response 200'"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":8},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":11682},{"element":"number","content":142}]}]}]}},"content":"parameter 'per_page' is not found within the URI template '/v1/events/ingest{?batch_ids,cursor,delimiter,error_types,events,event_ids,from,retryable,subaccounts,to}' for 'Search for Ingest Events' "},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":2},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":5481},{"element":"number","content":24}]}]}]}},"content":"the resource '/v1/events' is already defined"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":6},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":14564},{"element":"number","content":12}]}]}]}},"content":"missing response HTTP status code, assuming 'Response 200'"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":6},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":15290},{"element":"number","content":12}]}]}]}},"content":"missing response HTTP status code, assuming 'Response 200'"}]},"TableOfContents":[{"anchor":"#events","title":"Events","children":[{"anchor":"#header-data-retention","title":"Data Retention"},{"anchor":"#header-event-types","title":"Event Types"},{"anchor":"#header-keyword-searching","title":"Keyword Searching"},{"anchor":"#events-pagination","title":"Pagination","children":[{"anchor":"#events-get-retrieve-first-page","title":"Retrieve First Page"},{"anchor":"#events-get-retrieve-subsequent-page","title":"Retrieve Subsequent Page"}]},{"anchor":"#events-search","title":"Search","children":[{"anchor":"#events-get-search-for-message-events","title":"Search for Message Events"},{"anchor":"#events-get-search-for-ingest-events","title":"Search for Ingest Events"}]},{"anchor":"#events-documentation","title":"Documentation","children":[{"anchor":"#events-get-events-documentation","title":"Events Documentation"},{"anchor":"#events-get-events-samples","title":"Events Samples"}]}]}],"meta":{"title":"Events API","description":"Query detailed SparkPost event data for further analysis and processing.","full":false},"fields":{"path":"/api/events/"}}},"pageContext":{"file":"events.apib"}},"staticQueryHashes":["1319884646","1428769721","3859448388"]}