{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/communication:sendgrid-stats-v3/list-browser-stat":{"get":{"operationId":"communication_sendgrid_stats_v3_list_browser_stat","summary":"Retrieve email statistics by browser.","description":"GET /v3/browsers/stats","tags":["communication"],"parameters":[{"name":"browsers","in":"query","required":false,"description":"The browsers to get statistics for. You can include up to 10 different browsers by including this parameter multiple times.","schema":{"type":"string","description":"The browsers to get statistics for. You can include up to 10 different browsers by including this parameter multiple times."}},{"name":"on-behalf-of","in":"query","required":false,"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…","schema":{"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…"}},{"name":"aggregated_by","in":"query","required":false,"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\".","schema":{"type":"string","enum":["day","week","month"],"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\"."}},{"name":"start_date","in":"query","required":true,"description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD."}},{"name":"end_date","in":"query","required":false,"description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-stats-v3/list-category":{"get":{"operationId":"communication_sendgrid_stats_v3_list_category","summary":"Retrieve all categories","description":"GET /v3/categories","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"`limit` sets the page size, i.e. maximum number of items from the list to be returned for a single API request. If omitted, the default…","schema":{"type":"integer","default":50,"description":"`limit` sets the page size, i.e. maximum number of items from the list to be returned for a single API request. If omitted, the default…"}},{"name":"category","in":"query","required":false,"description":"Allows you to perform a prefix search on this particular category.","schema":{"type":"string","description":"Allows you to perform a prefix search on this particular category."}},{"name":"offset","in":"query","required":false,"description":"The number of items in the list to skip over before starting to retrieve the items for the requested page. The default `offset` of `0`…","schema":{"type":"integer","default":0,"description":"The number of items in the list to skip over before starting to retrieve the items for the requested page. The default `offset` of `0`…"}},{"name":"on-behalf-of","in":"query","required":false,"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…","schema":{"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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-stats-v3/list-category-stat":{"get":{"operationId":"communication_sendgrid_stats_v3_list_category_stat","summary":"Retrieve Email Statistics for Categories","description":"GET /v3/categories/stats","tags":["communication"],"parameters":[{"name":"start_date","in":"query","required":true,"description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD","schema":{"type":"string","description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD"}},{"name":"end_date","in":"query","required":false,"description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."}},{"name":"categories","in":"query","required":true,"description":"The individual categories that you want to retrieve statistics for. You may include up to 10 different categories.","schema":{"type":"string","description":"The individual categories that you want to retrieve statistics for. You may include up to 10 different categories."}},{"name":"aggregated_by","in":"query","required":false,"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\".","schema":{"type":"string","enum":["day","week","month"],"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\"."}},{"name":"on-behalf-of","in":"query","required":false,"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…","schema":{"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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-stats-v3/list-category-stat-sum":{"get":{"operationId":"communication_sendgrid_stats_v3_list_category_stat_sum","summary":"Retrieve sums of email stats for each category.","description":"GET /v3/categories/stats/sums","tags":["communication"],"parameters":[{"name":"sort_by_metric","in":"query","required":false,"description":"The metric that you want to sort by. Must be a single metric.","schema":{"type":"string","default":"delivered","description":"The metric that you want to sort by. Must be a single metric."}},{"name":"sort_by_direction","in":"query","required":false,"description":"The direction you want to sort.","schema":{"type":"string","enum":["desc","asc"],"description":"The direction you want to sort."}},{"name":"start_date","in":"query","required":true,"description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD."}},{"name":"end_date","in":"query","required":false,"description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."}},{"name":"limit","in":"query","required":false,"description":"Limits the number of results returned.","schema":{"type":"integer","default":5,"description":"Limits the number of results returned."}},{"name":"offset","in":"query","required":false,"description":"The point in the list to begin retrieving results.","schema":{"type":"integer","default":0,"description":"The point in the list to begin retrieving results."}},{"name":"aggregated_by","in":"query","required":false,"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\".","schema":{"type":"string","enum":["day","week","month"],"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\"."}},{"name":"on-behalf-of","in":"query","required":false,"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…","schema":{"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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-stats-v3/list-client-stat":{"get":{"operationId":"communication_sendgrid_stats_v3_list_client_stat","summary":"Retrieve email statistics by client type.","description":"GET /v3/clients/stats","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"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…","schema":{"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…"}},{"name":"start_date","in":"query","required":true,"description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD."}},{"name":"end_date","in":"query","required":false,"description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."}},{"name":"aggregated_by","in":"query","required":false,"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\".","schema":{"type":"string","enum":["day","week","month"],"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\"."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-stats-v3/get-client-stat":{"get":{"operationId":"communication_sendgrid_stats_v3_get_client_stat","summary":"Retrieve stats by a specific client type.","description":"GET /v3/clients/{client_type}/stats","tags":["communication"],"parameters":[{"name":"client_type","in":"query","required":true,"description":"Specifies the type of client to retrieve stats for. Must be either \"phone\", \"tablet\", \"webmail\", or \"desktop\".","schema":{"type":"string","enum":["phone","tablet","webmail","desktop"],"description":"Specifies the type of client to retrieve stats for. Must be either \"phone\", \"tablet\", \"webmail\", or \"desktop\"."}},{"name":"on-behalf-of","in":"query","required":false,"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…","schema":{"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…"}},{"name":"start_date","in":"query","required":true,"description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD."}},{"name":"end_date","in":"query","required":false,"description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."}},{"name":"aggregated_by","in":"query","required":false,"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\".","schema":{"type":"string","enum":["day","week","month"],"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\"."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-stats-v3/list-device-stat":{"get":{"operationId":"communication_sendgrid_stats_v3_list_device_stat","summary":"Retrieve email statistics by device type.","description":"GET /v3/devices/stats","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"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…","schema":{"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…"}},{"name":"aggregated_by","in":"query","required":false,"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\".","schema":{"type":"string","enum":["day","week","month"],"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\"."}},{"name":"start_date","in":"query","required":true,"description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD."}},{"name":"end_date","in":"query","required":false,"description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-stats-v3/list-geo-stat":{"get":{"operationId":"communication_sendgrid_stats_v3_list_geo_stat","summary":"Retrieve email statistics by country and state/province.","description":"GET /v3/geo/stats","tags":["communication"],"parameters":[{"name":"country","in":"query","required":false,"description":"The country you would like to see statistics for. Currently only supported for US and CA.","schema":{"type":"string","enum":["US","CA"],"description":"The country you would like to see statistics for. Currently only supported for US and CA."}},{"name":"on-behalf-of","in":"query","required":false,"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…","schema":{"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…"}},{"name":"aggregated_by","in":"query","required":false,"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\".","schema":{"type":"string","enum":["day","week","month"],"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\"."}},{"name":"start_date","in":"query","required":true,"description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD."}},{"name":"end_date","in":"query","required":false,"description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-stats-v3/list-mailbox-provider-stat":{"get":{"operationId":"communication_sendgrid_stats_v3_list_mailbox_provider_stat","summary":"Retrieve email statistics by mailbox provider.","description":"GET /v3/mailbox_providers/stats","tags":["communication"],"parameters":[{"name":"mailbox_providers","in":"query","required":false,"description":"The mail box providers to get statistics for. You can include up to 10 by including this parameter multiple times.","schema":{"type":"string","description":"The mail box providers to get statistics for. You can include up to 10 by including this parameter multiple times."}},{"name":"on-behalf-of","in":"query","required":false,"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…","schema":{"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…"}},{"name":"aggregated_by","in":"query","required":false,"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\".","schema":{"type":"string","enum":["day","week","month"],"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\"."}},{"name":"start_date","in":"query","required":true,"description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD."}},{"name":"end_date","in":"query","required":false,"description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sendgrid-stats-v3/list-stat":{"get":{"operationId":"communication_sendgrid_stats_v3_list_stat","summary":"Retrieve global email statistics","description":"GET /v3/stats","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"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…","schema":{"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…"}},{"name":"aggregated_by","in":"query","required":false,"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\".","schema":{"type":"string","enum":["day","week","month"],"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\"."}},{"name":"start_date","in":"query","required":true,"description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD."}},{"name":"end_date","in":"query","required":false,"description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}