{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/communication:sendgrid-mc-stats-v3/list-automation-stat":{"get":{"operationId":"communication_sendgrid_mc_stats_v3_list_automation_stat","summary":"Get All Automation Stats","description":"GET /v3/marketing/stats/automations","tags":["communication"],"parameters":[{"name":"automation_ids","in":"query","required":false,"description":"This endpoint returns all automation IDs if no `automation_ids` are specified.","schema":{"type":"array","description":"This endpoint returns all automation IDs if no `automation_ids` are specified."}},{"name":"page_size","in":"query","required":false,"description":"The number of elements you want returned on each page.","schema":{"type":"integer","default":25,"description":"The number of elements you want returned on each page."}},{"name":"page_token","in":"query","required":false,"description":"The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn't exist, you're…","schema":{"type":"string","description":"The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn't exist, you're…"}}],"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-mc-stats-v3/get-automation-stat":{"get":{"operationId":"communication_sendgrid_mc_stats_v3_get_automation_stat","summary":"Get Automation Stats by ID","description":"GET /v3/marketing/stats/automations/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the Automation for which you want to retrieve statistics.","schema":{"type":"string","description":"The ID of the Automation for which you want to retrieve statistics."}},{"name":"group_by","in":"query","required":false,"description":"Automations can have multiple steps. Including `step_id` as a `group_by` metric allows further granularity of stats.","schema":{"type":"array","description":"Automations can have multiple steps. Including `step_id` as a `group_by` metric allows further granularity of stats."}},{"name":"step_ids","in":"query","required":false,"description":"Comma-separated list of `step_ids` that you want the link stats for.","schema":{"type":"array","description":"Comma-separated list of `step_ids` that you want the link stats for."}},{"name":"aggregated_by","in":"query","required":false,"description":"Dictates how the stats are time-sliced. Currently, `\"total\"` and `\"day\"` are supported.","schema":{"type":"string","enum":["day","total"],"description":"Dictates how the stats are time-sliced. Currently, `\"total\"` and `\"day\"` are supported."}},{"name":"start_date","in":"query","required":false,"description":"Format: `YYYY-MM-DD`. If this parameter is included, the stats' start date is included in the search.","schema":{"type":"string","default":"2021-01-01","description":"Format: `YYYY-MM-DD`. If this parameter is included, the stats' start date is included in the search."}},{"name":"end_date","in":"query","required":false,"description":"Format: `YYYY-MM-DD`.If this parameter is included, the stats' end date is included in the search.","schema":{"type":"string","default":"2021-12-31","description":"Format: `YYYY-MM-DD`.If this parameter is included, the stats' end date is included in the search."}},{"name":"timezone","in":"query","required":false,"description":"[IANA Area/Region](https://en.wikipedia.org/wiki/Tz_database#Names_of_timezones) string representing the timezone in which the stats are…","schema":{"type":"string","default":"UTC","description":"[IANA Area/Region](https://en.wikipedia.org/wiki/Tz_database#Names_of_timezones) string representing the timezone in which the stats are…"}},{"name":"page_size","in":"query","required":false,"description":"The number of elements you want returned on each page.","schema":{"type":"integer","default":25,"description":"The number of elements you want returned on each page."}},{"name":"page_token","in":"query","required":false,"description":"The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn't exist, you're…","schema":{"type":"string","description":"The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn't exist, you're…"}}],"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-mc-stats-v3/list-click-tracking-stat":{"get":{"operationId":"communication_sendgrid_mc_stats_v3_list_click_tracking_stat","summary":"Get Automation Click Tracking Stats by ID","description":"GET /v3/marketing/stats/automations/{id}/links","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the Automation you want to get click tracking stats for.","schema":{"type":"string","description":"The ID of the Automation you want to get click tracking stats for."}},{"name":"group_by","in":"query","required":false,"description":"Automations can have multiple steps. Including `step_id` as a `group_by` metric allows further granularity of stats.","schema":{"type":"array","description":"Automations can have multiple steps. Including `step_id` as a `group_by` metric allows further granularity of stats."}},{"name":"step_ids","in":"query","required":false,"description":"Comma-separated list of `step_ids` that you want the link stats for.","schema":{"type":"array","description":"Comma-separated list of `step_ids` that you want the link stats for."}},{"name":"page_size","in":"query","required":false,"description":"The number of elements you want returned on each page.","schema":{"type":"integer","default":25,"description":"The number of elements you want returned on each page."}},{"name":"page_token","in":"query","required":false,"description":"The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn't exist, you're…","schema":{"type":"string","description":"The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn't exist, you're…"}}],"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-mc-stats-v3/export-automation-stat":{"get":{"operationId":"communication_sendgrid_mc_stats_v3_export_automation_stat","summary":"Export Single Send Stats","description":"GET /v3/marketing/stats/automations/export","tags":["communication"],"parameters":[{"name":"ids","in":"query","required":false,"description":"The IDs of Single Sends for which to export stats.","schema":{"type":"array","description":"The IDs of Single Sends for which to export stats."}},{"name":"timezone","in":"query","required":false,"description":"The [IANA Area/Region](https://en.wikipedia.org/wiki/Tz_database#Names_of_timezones) string representing the timezone in which the stats…","schema":{"type":"string","default":"UTC","description":"The [IANA Area/Region](https://en.wikipedia.org/wiki/Tz_database#Names_of_timezones) string representing the timezone in which the stats…"}}],"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-mc-stats-v3/list-single-send-stat":{"get":{"operationId":"communication_sendgrid_mc_stats_v3_list_single_send_stat","summary":"Get All Single Sends Stats","description":"GET /v3/marketing/stats/singlesends","tags":["communication"],"parameters":[{"name":"singlesend_ids","in":"query","required":false,"description":"This endpoint returns all Single Send IDs if no IDs are included in `singlesend_ids`.","schema":{"type":"array","description":"This endpoint returns all Single Send IDs if no IDs are included in `singlesend_ids`."}},{"name":"page_size","in":"query","required":false,"description":"The number of elements you want returned on each page.","schema":{"type":"integer","default":25,"description":"The number of elements you want returned on each page."}},{"name":"page_token","in":"query","required":false,"description":"The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn't exist, you're…","schema":{"type":"string","description":"The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn't exist, you're…"}}],"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-mc-stats-v3/get-single-send-stat":{"get":{"operationId":"communication_sendgrid_mc_stats_v3_get_single_send_stat","summary":"Get Single Send Stats by ID","description":"GET /v3/marketing/stats/singlesends/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of Single Send for which you want to retrieve stats.","schema":{"type":"string","description":"The ID of Single Send for which you want to retrieve stats."}},{"name":"aggregated_by","in":"query","required":false,"description":"Dictates how the stats are time-sliced. Currently, `\"total\"` and `\"day\"` are supported.","schema":{"type":"string","enum":["day","total"],"description":"Dictates how the stats are time-sliced. Currently, `\"total\"` and `\"day\"` are supported."}},{"name":"start_date","in":"query","required":false,"description":"Format: `YYYY-MM-DD`. If this parameter is included, the stats' start date is included in the search.","schema":{"type":"string","default":"2021-01-01","description":"Format: `YYYY-MM-DD`. If this parameter is included, the stats' start date is included in the search."}},{"name":"end_date","in":"query","required":false,"description":"Format: `YYYY-MM-DD`.If this parameter is included, the stats' end date is included in the search.","schema":{"type":"string","default":"2021-12-31","description":"Format: `YYYY-MM-DD`.If this parameter is included, the stats' end date is included in the search."}},{"name":"timezone","in":"query","required":false,"description":"[IANA Area/Region](https://en.wikipedia.org/wiki/Tz_database#Names_of_timezones) string representing the timezone in which the stats are…","schema":{"type":"string","default":"UTC","description":"[IANA Area/Region](https://en.wikipedia.org/wiki/Tz_database#Names_of_timezones) string representing the timezone in which the stats are…"}},{"name":"page_size","in":"query","required":false,"description":"The number of elements you want returned on each page.","schema":{"type":"integer","default":25,"description":"The number of elements you want returned on each page."}},{"name":"page_token","in":"query","required":false,"description":"The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn't exist, you're…","schema":{"type":"string","description":"The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn't exist, you're…"}},{"name":"group_by","in":"query","required":false,"description":"A/B Single Sends have multiple variation IDs and phase IDs. Including these additional fields allows further granularity of stats by these…","schema":{"type":"array","description":"A/B Single Sends have multiple variation IDs and phase IDs. Including these additional fields allows further granularity of stats by these…"}}],"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-mc-stats-v3/list-single-send-tracking-stat":{"get":{"operationId":"communication_sendgrid_mc_stats_v3_list_single_send_tracking_stat","summary":"Get Single Send Click Tracking Stats by ID","description":"GET /v3/marketing/stats/singlesends/{id}/links","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of Single Send for which you want to retrieve link stats.","schema":{"type":"string","description":"The ID of Single Send for which you want to retrieve link stats."}},{"name":"page_size","in":"query","required":false,"description":"The number of elements you want returned on each page.","schema":{"type":"integer","default":25,"description":"The number of elements you want returned on each page."}},{"name":"page_token","in":"query","required":false,"description":"The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn't exist, you're…","schema":{"type":"string","description":"The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn't exist, you're…"}},{"name":"group_by","in":"query","required":false,"description":"A/B Single Sends have multiple variation IDs and phase IDs. Including these additional fields allows further granularity of stats by these…","schema":{"type":"array","description":"A/B Single Sends have multiple variation IDs and phase IDs. Including these additional fields allows further granularity of stats by these…"}},{"name":"ab_variation_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"ab_phase_id","in":"query","required":false,"schema":{"type":"string","enum":["test","send"]}}],"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-mc-stats-v3/export-single-send-stat":{"get":{"operationId":"communication_sendgrid_mc_stats_v3_export_single_send_stat","summary":"Export Single Send Stats","description":"GET /v3/marketing/stats/singlesends/export","tags":["communication"],"parameters":[{"name":"ids","in":"query","required":false,"description":"The IDs of Single Sends for which to export stats.","schema":{"type":"array","description":"The IDs of Single Sends for which to export stats."}},{"name":"timezone","in":"query","required":false,"description":"The [IANA Area/Region](https://en.wikipedia.org/wiki/Tz_database#Names_of_timezones) string representing the timezone in which the stats…","schema":{"type":"string","default":"UTC","description":"The [IANA Area/Region](https://en.wikipedia.org/wiki/Tz_database#Names_of_timezones) string representing the timezone in which the stats…"}}],"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"}}}}}}}