{"componentChunkName":"component---src-templates-api-js","path":"/api/usage/","result":{"data":{"allApiBlueprint":{"edges":[{"node":{"meta":{"title":"Bounce Domains API","label":null},"fields":{"path":"/api/bounce-domains/","file":"bounce-domains.apib"}}},{"node":{"meta":{"title":"Account API","label":null},"fields":{"path":"/api/account/","file":"account.apib"}}},{"node":{"meta":{"title":"Ingest API","label":"Private Access"},"fields":{"path":"/api/events-ingest/","file":"events-ingest.apib"}}},{"node":{"meta":{"title":"A/B Testing API","label":"New"},"fields":{"path":"/api/ab-testing/","file":"ab-testing.apib"}}},{"node":{"meta":{"title":"Events API","label":null},"fields":{"path":"/api/events/","file":"events.apib"}}},{"node":{"meta":{"title":"Data Privacy API","label":"New"},"fields":{"path":"/api/data-privacy/","file":"data-privacy.apib"}}},{"node":{"meta":{"title":"Inbound Domains API","label":null},"fields":{"path":"/api/inbound-domains/","file":"inbound-domains.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":"IP Pools API","label":null},"fields":{"path":"/api/ip-pools/","file":"ip-pools.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":"Recipient Lists API","label":null},"fields":{"path":"/api/recipient-lists/","file":"recipient-lists.apib"}}},{"node":{"meta":{"title":"Relay Webhooks API","label":null},"fields":{"path":"/api/relay-webhooks/","file":"relay-webhooks.apib"}}},{"node":{"meta":{"title":"Seed List API","label":"Deliverability"},"fields":{"path":"/api/seed-list/","file":"seed-list.apib"}}},{"node":{"meta":{"title":"Sending IPs API","label":null},"fields":{"path":"/api/sending-ips/","file":"sending-ips.apib"}}},{"node":{"meta":{"title":"Sending Domains API","label":null},"fields":{"path":"/api/sending-domains/","file":"sending-domains.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":"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":"Templates API","label":null},"fields":{"path":"/api/templates/","file":"templates.apib"}}},{"node":{"meta":{"title":"Tracking Domains API","label":null},"fields":{"path":"/api/tracking-domains/","file":"tracking-domains.apib"}}},{"node":{"meta":{"title":"Transmissions API","label":null},"fields":{"path":"/api/transmissions/","file":"transmissions.apib"}}},{"node":{"meta":{"title":"Usage API","label":null},"fields":{"path":"/api/usage/","file":"usage.apib"}}},{"node":{"meta":{"title":"Event Webhooks API","label":null},"fields":{"path":"/api/webhooks/","file":"webhooks.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":"Usage API"}}},{"element":"member","meta":{"classes":{"element":"array","content":[{"element":"string","content":"user"}]}},"content":{"key":{"element":"string","content":"description"},"value":{"element":"string","content":"Get customer usage across all products."}}}]}},"content":[{"element":"category","meta":{"classes":{"element":"array","content":[{"element":"string","content":"resourceGroup"}]},"title":{"element":"string","content":"Usage"}},"content":[{"element":"copy","content":"The Usage API provides customer usage data across all SparkPost products. This endpoint allows you to retrieve usage metrics for your account, including both current usage and historical data organized by product."},{"element":"resource","meta":{"title":{"element":"string","content":"Retrieve Usage"}},"attributes":{"href":{"element":"string","content":"/v1/usage"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Retrieve Usage"}},"attributes":{"href":{"element":"string","content":"/v1/usage"}},"content":[{"element":"copy","content":"Gets customer usage across all products"},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"dataStructure","content":{"element":"object","content":[{"element":"member","content":{"key":{"element":"string","content":"results"},"value":{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"Recipient validation usage data"}},"content":{"key":{"element":"string","content":"recipient_validation"},"value":{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"Daily usage data"}},"content":{"key":{"element":"string","content":"day"},"value":{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"Start date of the day period in ISO format"}},"content":{"key":{"element":"string","content":"start"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"End date of the day period in ISO format"}},"content":{"key":{"element":"string","content":"end"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Daily usage limit"}},"content":{"key":{"element":"string","content":"limit"},"value":{"element":"number"}}},{"element":"member","meta":{"description":{"element":"string","content":"Used amount for the day"}},"content":{"key":{"element":"string","content":"used"},"value":{"element":"number"}}}]}}},{"element":"member","meta":{"description":{"element":"string","content":"Monthly usage data"}},"content":{"key":{"element":"string","content":"month"},"value":{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"Start date of the month period in ISO format"}},"content":{"key":{"element":"string","content":"start"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"End date of the month period in ISO format"}},"content":{"key":{"element":"string","content":"end"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Used amount for the month"}},"content":{"key":{"element":"string","content":"used"},"value":{"element":"number"}}}]}}},{"element":"member","meta":{"description":{"element":"string","content":"Last usage date in ISO format"}},"content":{"key":{"element":"string","content":"last_usage_date"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Timestamp of when usage data was retrieved"}},"content":{"key":{"element":"string","content":"timestamp"},"value":{"element":"string"}}}]}}},{"element":"member","meta":{"description":{"element":"string","content":"Messaging usage data"}},"content":{"key":{"element":"string","content":"messaging"},"value":{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"Daily usage data"}},"content":{"key":{"element":"string","content":"day"},"value":{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"Start date of the day period in ISO format"}},"content":{"key":{"element":"string","content":"start"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"End date of the day period in ISO format"}},"content":{"key":{"element":"string","content":"end"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Used amount for the day"}},"content":{"key":{"element":"string","content":"used"},"value":{"element":"number"}}}]}}},{"element":"member","meta":{"description":{"element":"string","content":"Monthly usage data"}},"content":{"key":{"element":"string","content":"month"},"value":{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"Start date of the month period in ISO format"}},"content":{"key":{"element":"string","content":"start"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"End date of the month period in ISO format"}},"content":{"key":{"element":"string","content":"end"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Used amount for the month"}},"content":{"key":{"element":"string","content":"used"},"value":{"element":"number"}}}]}}},{"element":"member","meta":{"description":{"element":"string","content":"Last usage date in ISO format (can be null)"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"nullable"}]}},"content":{"key":{"element":"string","content":"last_usage_date"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Timestamp of when usage data was retrieved"}},"content":{"key":{"element":"string","content":"timestamp"},"value":{"element":"string"}}}]}}}]}}}]}},{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"{\n    \"results\": {\n        \"recipient_validation\": {\n            \"day\": {\n                \"start\": \"2021-08-03T14:45:00.000Z\",\n                \"end\": \"2021-08-04T14:45:00.000Z\",\n                \"limit\": 5000000,\n                \"used\": 2\n            },\n            \"month\": {\n                \"start\": \"2021-07-09T00:00:00.000Z\",\n                \"end\": \"2021-08-09T00:00:00.000Z\",\n                \"used\": 2\n            },\n            \"last_usage_date\": \"2020-08-19\",\n            \"timestamp\": \"2021-08-04T14:50:53.030Z\"\n        },\n        \"messaging\": {\n            \"day\": {\n                \"start\": \"2021-08-03T14:45:00.000Z\",\n                \"end\": \"2021-08-04T14:45:00.000Z\",\n                \"used\": 0\n            },\n            \"month\": {\n                \"start\": \"2021-08-04T00:00:00.000Z\",\n                \"end\": \"2021-09-04T00:00:00.000Z\",\n                \"used\": 0\n            },\n            \"last_usage_date\": null,\n            \"timestamp\": \"2021-08-04T14:50:54.331Z\"\n        }\n    }\n}\n"},{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBodySchema"}]}},"attributes":{"contentType":{"element":"string","content":"application/schema+json"}},"content":"{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"results\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"recipient_validation\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"day\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"start\": {\n                  \"type\": \"string\",\n                  \"description\": \"Start date of the day period in ISO format\"\n                },\n                \"end\": {\n                  \"type\": \"string\",\n                  \"description\": \"End date of the day period in ISO format\"\n                },\n                \"limit\": {\n                  \"type\": \"number\",\n                  \"description\": \"Daily usage limit\"\n                },\n                \"used\": {\n                  \"type\": \"number\",\n                  \"description\": \"Used amount for the day\"\n                }\n              },\n              \"description\": \"Daily usage data\"\n            },\n            \"month\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"start\": {\n                  \"type\": \"string\",\n                  \"description\": \"Start date of the month period in ISO format\"\n                },\n                \"end\": {\n                  \"type\": \"string\",\n                  \"description\": \"End date of the month period in ISO format\"\n                },\n                \"used\": {\n                  \"type\": \"number\",\n                  \"description\": \"Used amount for the month\"\n                }\n              },\n              \"description\": \"Monthly usage data\"\n            },\n            \"last_usage_date\": {\n              \"type\": \"string\",\n              \"description\": \"Last usage date in ISO format\"\n            },\n            \"timestamp\": {\n              \"type\": \"string\",\n              \"description\": \"Timestamp of when usage data was retrieved\"\n            }\n          },\n          \"description\": \"Recipient validation usage data\"\n        },\n        \"messaging\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"day\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"start\": {\n                  \"type\": \"string\",\n                  \"description\": \"Start date of the day period in ISO format\"\n                },\n                \"end\": {\n                  \"type\": \"string\",\n                  \"description\": \"End date of the day period in ISO format\"\n                },\n                \"used\": {\n                  \"type\": \"number\",\n                  \"description\": \"Used amount for the day\"\n                }\n              },\n              \"description\": \"Daily usage data\"\n            },\n            \"month\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"start\": {\n                  \"type\": \"string\",\n                  \"description\": \"Start date of the month period in ISO format\"\n                },\n                \"end\": {\n                  \"type\": \"string\",\n                  \"description\": \"End date of the month period in ISO format\"\n                },\n                \"used\": {\n                  \"type\": \"number\",\n                  \"description\": \"Used amount for the month\"\n                }\n              },\n              \"description\": \"Monthly usage data\"\n            },\n            \"last_usage_date\": {\n              \"type\": [\n                \"string\",\n                \"null\"\n              ],\n              \"description\": \"Last usage date in ISO format (can be null)\"\n            },\n            \"timestamp\": {\n              \"type\": \"string\",\n              \"description\": \"Timestamp of when usage data was retrieved\"\n            }\n          },\n          \"description\": \"Messaging usage data\"\n        }\n      }\n    }\n  }\n}"}]}]}]}]}]}]}]},"TableOfContents":[{"anchor":"#usage","title":"Usage","children":[{"anchor":"#usage-retrieve-usage","title":"Retrieve Usage","children":[{"anchor":"#usage-get-retrieve-usage","title":"Retrieve Usage"}]}]}],"meta":{"title":"Usage API","description":"Get customer usage across all products.","full":false},"fields":{"path":"/api/usage/"}}},"pageContext":{"file":"usage.apib"}},"staticQueryHashes":["1319884646","1428769721","3859448388"]}