{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/business:braze/campaign-analytics":{"get":{"operationId":"business_braze_campaign_analytics","summary":"Campaign Analytics","description":"GET /campaigns/data_series","tags":["business"],"parameters":[{"name":"campaign_id","in":"query","required":false,"description":"(Required) String Campaign API identifier","schema":{"type":"string","description":"(Required) String Campaign API identifier"}},{"name":"length","in":"query","required":false,"description":"(Required) Integer Max number of days before ending_at to include in the returned series - must be between 1 and 100 inclusive","schema":{"type":"string","description":"(Required) Integer Max number of days before ending_at to include in the returned series - must be between 1 and 100 inclusive"}},{"name":"ending_at","in":"query","required":false,"description":"(Optional) DateTime (ISO 8601 string) Date on which the data series should end - defaults to time of the request","schema":{"type":"string","description":"(Optional) DateTime (ISO 8601 string) Date on which the data series should end - defaults to time of the request"}}],"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":"live"}},"/v1/business:braze/campaign-details":{"get":{"operationId":"business_braze_campaign_details","summary":"Campaign Details","description":"GET /campaigns/details","tags":["business"],"parameters":[{"name":"campaign_id","in":"query","required":false,"description":"(Required) String Campaign API identifier","schema":{"type":"string","description":"(Required) String Campaign API identifier"}}],"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":"live"}},"/v1/business:braze/campaign-list":{"get":{"operationId":"business_braze_campaign_list","summary":"Campaign List","description":"GET /campaigns/list","tags":["business"],"parameters":[{"name":"page","in":"query","required":false,"description":"(Optional) Integer The page of campaigns to return, defaults to 0 (returns the first set of up to 100)","schema":{"type":"string","description":"(Optional) Integer The page of campaigns to return, defaults to 0 (returns the first set of up to 100)"}},{"name":"include_archived","in":"query","required":false,"description":"(Optional) Boolean Whether or not to include archived campaigns, defaults to false","schema":{"type":"string","description":"(Optional) Boolean Whether or not to include archived campaigns, defaults to false"}},{"name":"sort_direction","in":"query","required":false,"description":"(Optional) String Pass in the value `desc` to sort by creation time from newest to oldest. Pass in `asc` to sort from oldest to newest. If…","schema":{"type":"string","description":"(Optional) String Pass in the value `desc` to sort by creation time from newest to oldest. Pass in `asc` to sort from oldest to newest. If…"}},{"name":"last_edit.time[gt]","in":"query","required":false,"description":"(Optional) DateTime (ISO 8601 string) Filters the results and only returns campaigns that were edited greater than the time provided till…","schema":{"type":"string","description":"(Optional) DateTime (ISO 8601 string) Filters the results and only returns campaigns that were edited greater than the time provided till…"}}],"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":"live"}},"/v1/business:braze/canvas-data-series-analytics":{"get":{"operationId":"business_braze_canvas_data_series_analytics","summary":"Canvas Data Series Analytics","description":"GET /canvas/data_series","tags":["business"],"parameters":[{"name":"canvas_id","in":"query","required":false,"description":"(Required) String Canvas API Identifier","schema":{"type":"string","description":"(Required) String Canvas API Identifier"}},{"name":"ending_at","in":"query","required":false,"description":"(Required) DateTime (ISO 8601 string) Date on which the data export should end - defaults to time of the request","schema":{"type":"string","description":"(Required) DateTime (ISO 8601 string) Date on which the data export should end - defaults to time of the request"}},{"name":"starting_at","in":"query","required":false,"description":"(Optional) DateTime (ISO 8601 string) Date on which the data export should begin (either length or starting_at are required)","schema":{"type":"string","description":"(Optional) DateTime (ISO 8601 string) Date on which the data export should begin (either length or starting_at are required)"}},{"name":"length","in":"query","required":false,"description":"(Optional) DateTime (ISO 8601 string) Max number of days before ending_at to include in the returned series - must be between 1 and 14…","schema":{"type":"string","description":"(Optional) DateTime (ISO 8601 string) Max number of days before ending_at to include in the returned series - must be between 1 and 14…"}},{"name":"include_variant_breakdown","in":"query","required":false,"description":"(Optional) Boolean Whether or not to include variant stats (defaults to false)","schema":{"type":"string","description":"(Optional) Boolean Whether or not to include variant stats (defaults to false)"}},{"name":"include_step_breakdown","in":"query","required":false,"description":"(Optional) Boolean Whether or not to include step stats (defaults to false)","schema":{"type":"string","description":"(Optional) Boolean Whether or not to include step stats (defaults to false)"}},{"name":"include_deleted_step_data","in":"query","required":false,"description":"(Optional) Boolean Whether or not to include step stats for deleted steps (defaults to false)","schema":{"type":"string","description":"(Optional) Boolean Whether or not to include step stats for deleted steps (defaults to false)"}}],"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":"live"}},"/v1/business:braze/canvas-data-analytics-summary":{"get":{"operationId":"business_braze_canvas_data_analytics_summary","summary":"Canvas Data Analytics Summary","description":"GET /canvas/data_summary","tags":["business"],"parameters":[{"name":"canvas_id","in":"query","required":false,"description":"(Required) String Canvas API identifier","schema":{"type":"string","description":"(Required) String Canvas API identifier"}},{"name":"ending_at","in":"query","required":false,"description":"(Required) DateTime (ISO 8601 string) Date on which the data export should end - defaults to time of the request","schema":{"type":"string","description":"(Required) DateTime (ISO 8601 string) Date on which the data export should end - defaults to time of the request"}},{"name":"starting_at","in":"query","required":false,"description":"(Optional) DateTime (ISO 8601 string) Date on which the data export should begin (either length or starting_at required)","schema":{"type":"string","description":"(Optional) DateTime (ISO 8601 string) Date on which the data export should begin (either length or starting_at required)"}},{"name":"length","in":"query","required":false,"description":"(Optional) Integer Max number of days before ending_at to include in the returned series - must be between 1 and 14 inclusive (either…","schema":{"type":"string","description":"(Optional) Integer Max number of days before ending_at to include in the returned series - must be between 1 and 14 inclusive (either…"}},{"name":"include_variant_breakdown","in":"query","required":false,"description":"(Optional) Boolean Whether or not to include variant stats (defaults to false)","schema":{"type":"string","description":"(Optional) Boolean Whether or not to include variant stats (defaults to false)"}},{"name":"include_step_breakdown","in":"query","required":false,"description":"(Optional) Boolean Whether or not to include step stats (defaults to false)","schema":{"type":"string","description":"(Optional) Boolean Whether or not to include step stats (defaults to false)"}},{"name":"include_deleted_step_data","in":"query","required":false,"description":"(Optional) Boolean Whether or not to include step stats for deleted steps (defaults to false)","schema":{"type":"string","description":"(Optional) Boolean Whether or not to include step stats for deleted steps (defaults to false)"}}],"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":"live"}},"/v1/business:braze/canvas-details":{"get":{"operationId":"business_braze_canvas_details","summary":"Canvas Details","description":"GET /canvas/details","tags":["business"],"parameters":[{"name":"canvas_id","in":"query","required":false,"description":"(Required) String Canvas API Identifier","schema":{"type":"string","description":"(Required) String Canvas API Identifier"}}],"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":"live"}},"/v1/business:braze/canvas-list":{"get":{"operationId":"business_braze_canvas_list","summary":"Canvas List","description":"GET /canvas/list","tags":["business"],"parameters":[{"name":"page","in":"query","required":false,"description":"(Optional) Integer The page of Canvases to return, defaults to `0` (returns the first set of up to 100)","schema":{"type":"string","description":"(Optional) Integer The page of Canvases to return, defaults to `0` (returns the first set of up to 100)"}},{"name":"include_archived","in":"query","required":false,"description":"(Optional) Boolean Whether or not to include archived Canvases, defaults to `false`.","schema":{"type":"string","description":"(Optional) Boolean Whether or not to include archived Canvases, defaults to `false`."}},{"name":"sort_direction","in":"query","required":false,"description":"(Optional) String Pass in the value `desc` to sort by creation time from newest to oldest. Pass in `asc` to sort from oldest to newest. If…","schema":{"type":"string","description":"(Optional) String Pass in the value `desc` to sort by creation time from newest to oldest. Pass in `asc` to sort from oldest to newest. If…"}},{"name":"last_edit.time[gt]","in":"query","required":false,"description":"(Optional) DateTime (ISO 8601 string) Filters the results and only returns Canvases that were edited greater than the time provided till…","schema":{"type":"string","description":"(Optional) DateTime (ISO 8601 string) Filters the results and only returns Canvases that were edited greater than the time provided till…"}}],"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":"live"}},"/v1/business:braze/schedule-api-triggered-canvases":{"post":{"operationId":"business_braze_schedule_api_triggered_canvases","summary":"Schedule API Triggered Canvases","description":"POST /canvas/trigger/schedule/create","tags":["business"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/business:braze/see-content-block-information":{"get":{"operationId":"business_braze_see_content_block_information","summary":"See Content Block Information","description":"GET /content_blocks/info","tags":["business"],"parameters":[{"name":"content_block_id","in":"query","required":false,"description":"(Required) String The Content Block ID. This can be found by either listing Content Block information or going to the Developer Console,…","schema":{"type":"string","description":"(Required) String The Content Block ID. This can be found by either listing Content Block information or going to the Developer Console,…"}},{"name":"include_inclusion_data","in":"query","required":false,"description":"(Optional) Boolean When set to ‘true’, the API returns back the Message Variation API ID of Campaigns and Canvases where this content…","schema":{"type":"string","description":"(Optional) Boolean When set to ‘true’, the API returns back the Message Variation API ID of Campaigns and Canvases where this content…"}}],"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":"live"}},"/v1/business:braze/list-available-content-blocks":{"get":{"operationId":"business_braze_list_available_content_blocks","summary":"List Available Content Blocks","description":"GET /content_blocks/list","tags":["business"],"parameters":[{"name":"modified_after","in":"query","required":false,"description":"(Optional) String in ISO 8601 Retrieve only content blocks updated at or after the given time.","schema":{"type":"string","description":"(Optional) String in ISO 8601 Retrieve only content blocks updated at or after the given time."}},{"name":"modified_before","in":"query","required":false,"description":"(Optional) String in ISO 8601 Retrieve only content blocks updated at or before the given time.","schema":{"type":"string","description":"(Optional) String in ISO 8601 Retrieve only content blocks updated at or before the given time."}},{"name":"limit","in":"query","required":false,"description":"(Optional) Positive Number Maximum number of content blocks to retrieve, default to 100 if not provided, maximum acceptable value is 1000.","schema":{"type":"string","description":"(Optional) Positive Number Maximum number of content blocks to retrieve, default to 100 if not provided, maximum acceptable value is 1000."}},{"name":"offset","in":"query","required":false,"description":"(Optional) Positive Number Number of content blocks to skip before returning rest of the templates that fit the search criteria.","schema":{"type":"string","description":"(Optional) Positive Number Number of content blocks to skip before returning rest of the templates that fit the search criteria."}}],"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":"live"}},"/v1/business:braze/query-hard-bounced-emails":{"get":{"operationId":"business_braze_query_hard_bounced_emails","summary":"Query Hard Bounced Emails","description":"GET /email/hard_bounces","tags":["business"],"parameters":[{"name":"start_date","in":"query","required":false,"description":"(Optional*) String in YYYY-MM-DD format Start date of the range to retrieve hard bounces, must be earlier than `end_date`. This is treated…","schema":{"type":"string","description":"(Optional*) String in YYYY-MM-DD format Start date of the range to retrieve hard bounces, must be earlier than `end_date`. This is treated…"}},{"name":"end_date","in":"query","required":false,"description":"(Optional*) String in YYYY-MM-DD format String in YYYY-MM-DD format. End date of the range to retrieve hard bounces. This is treated as…","schema":{"type":"string","description":"(Optional*) String in YYYY-MM-DD format String in YYYY-MM-DD format. End date of the range to retrieve hard bounces. This is treated as…"}},{"name":"limit","in":"query","required":false,"description":"(Optional) Integer Optional field to limit the number of results returned. Defaults to 100, maximum is 500.","schema":{"type":"string","description":"(Optional) Integer Optional field to limit the number of results returned. Defaults to 100, maximum is 500."}},{"name":"offset","in":"query","required":false,"description":"(Optional) Integer Optional beginning point in the list to retrieve from.","schema":{"type":"string","description":"(Optional) Integer Optional beginning point in the list to retrieve from."}},{"name":"email","in":"query","required":false,"description":"(Optional*) String If provided, we will return whether or not the user has hard bounced. *You must provide either an `email` or a…","schema":{"type":"string","description":"(Optional*) String If provided, we will return whether or not the user has hard bounced. *You must provide either an `email` or a…"}}],"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":"live"}},"/v1/business:braze/query-list-of-unsubscribed-email-addresses":{"get":{"operationId":"business_braze_query_list_of_unsubscribed_email_addresses","summary":"Query List of Unsubscribed Email Addresses","description":"GET /email/unsubscribes","tags":["business"],"parameters":[{"name":"start_date","in":"query","required":false,"description":"(Optional*) String in YYYY-MM-DD format Start date of the range to retrieve unsubscribes, must be earlier than end_date. This is treated…","schema":{"type":"string","description":"(Optional*) String in YYYY-MM-DD format Start date of the range to retrieve unsubscribes, must be earlier than end_date. This is treated…"}},{"name":"end_date","in":"query","required":false,"description":"(Optional*) String in YYYY-MM-DD format End date of the range to retrieve unsubscribes. This is treated as midnight in UTC time by the API.","schema":{"type":"string","description":"(Optional*) String in YYYY-MM-DD format End date of the range to retrieve unsubscribes. This is treated as midnight in UTC time by the API."}},{"name":"limit","in":"query","required":false,"description":"(Optional) Integer Optional field to limit the number of results returned. Limit must be greater than 1. Defaults to 100, maximum is 500.","schema":{"type":"string","description":"(Optional) Integer Optional field to limit the number of results returned. Limit must be greater than 1. Defaults to 100, maximum is 500."}},{"name":"offset","in":"query","required":false,"description":"(Optional) Integer Optional beginning point in the list to retrieve from","schema":{"type":"string","description":"(Optional) Integer Optional beginning point in the list to retrieve from"}},{"name":"sort_direction","in":"query","required":false,"description":"(Optional) String Pass in the value `asc` to sort unsubscribes from oldest to newest. Pass in `desc` to sort from newest to oldest. If…","schema":{"type":"string","description":"(Optional) String Pass in the value `asc` to sort unsubscribes from oldest to newest. Pass in `desc` to sort from newest to oldest. If…"}},{"name":"email","in":"query","required":false,"description":"(Optional*) String If provided, we will return whether or not the user has unsubscribed","schema":{"type":"string","description":"(Optional*) String If provided, we will return whether or not the user has unsubscribed"}}],"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":"live"}},"/v1/business:braze/custom-events-analytics":{"get":{"operationId":"business_braze_custom_events_analytics","summary":"Custom Events Analytics","description":"GET /events/data_series","tags":["business"],"parameters":[{"name":"event","in":"query","required":false,"description":"(Required) String The name of the custom event for which to return analytics","schema":{"type":"string","description":"(Required) String The name of the custom event for which to return analytics"}},{"name":"length","in":"query","required":false,"description":"(Required) Integer Max number of units (days or hours) before ending_at to include in the returned series - must be between 1 and 100…","schema":{"type":"string","description":"(Required) Integer Max number of units (days or hours) before ending_at to include in the returned series - must be between 1 and 100…"}},{"name":"unit","in":"query","required":false,"description":"(Optional) String Unit of time between data points - can be \"day\" or \"hour\" (defaults to \"day\")","schema":{"type":"string","description":"(Optional) String Unit of time between data points - can be \"day\" or \"hour\" (defaults to \"day\")"}},{"name":"ending_at","in":"query","required":false,"description":"(Optional) DateTime (ISO 8601 string) Point in time when the data series should end - defaults to time of the request","schema":{"type":"string","description":"(Optional) DateTime (ISO 8601 string) Point in time when the data series should end - defaults to time of the request"}},{"name":"app_id","in":"query","required":false,"description":"(Optional) String App API identifier retrieved from the Developer Console to limit analytics to a specific app","schema":{"type":"string","description":"(Optional) String App API identifier retrieved from the Developer Console to limit analytics to a specific app"}},{"name":"segment_id","in":"query","required":false,"description":"(Optional) String Segment API identifier indicating the analytics enabled segment for which event analytics should be returned","schema":{"type":"string","description":"(Optional) String Segment API identifier indicating the analytics enabled segment for which event analytics should be returned"}}],"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":"live"}},"/v1/business:braze/custom-events-list":{"get":{"operationId":"business_braze_custom_events_list","summary":"Custom Events List","description":"GET /events/list","tags":["business"],"parameters":[{"name":"page","in":"query","required":false,"description":"(Optional) Integer The page of event names to return, defaults to 0 (returns the first set of up to 250)","schema":{"type":"string","description":"(Optional) Integer The page of event names to return, defaults to 0 (returns the first set of up to 250)"}}],"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":"live"}},"/v1/business:braze/news-feed-card-analytics":{"get":{"operationId":"business_braze_news_feed_card_analytics","summary":"News Feed Card Analytics","description":"GET /feed/data_series","tags":["business"],"parameters":[{"name":"card_id","in":"query","required":false,"description":"(Required) String Card API identifier","schema":{"type":"string","description":"(Required) String Card API identifier"}},{"name":"length","in":"query","required":false,"description":"(Required) Integer Max number of units (days or hours) before ending_at to include in the returned series - must be between 1 and 100…","schema":{"type":"string","description":"(Required) Integer Max number of units (days or hours) before ending_at to include in the returned series - must be between 1 and 100…"}},{"name":"unit","in":"query","required":false,"description":"(Optional) String Unit of time between data points - can be \"day\" or \"hour\" (defaults to \"day\")","schema":{"type":"string","description":"(Optional) String Unit of time between data points - can be \"day\" or \"hour\" (defaults to \"day\")"}},{"name":"ending_at","in":"query","required":false,"description":"(Optional) DateTime (ISO 8601 string) Date on which the data series should end - defaults to time of the request","schema":{"type":"string","description":"(Optional) DateTime (ISO 8601 string) Date on which the data series should end - defaults to time of the request"}}],"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":"live"}},"/v1/business:braze/news-feed-cards-details":{"get":{"operationId":"business_braze_news_feed_cards_details","summary":"News Feed Cards Details","description":"GET /feed/details","tags":["business"],"parameters":[{"name":"card_id","in":"query","required":false,"description":"(Required) String Card API identifier","schema":{"type":"string","description":"(Required) String Card API identifier"}}],"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":"live"}},"/v1/business:braze/news-feed-cards-list":{"get":{"operationId":"business_braze_news_feed_cards_list","summary":"News Feed Cards List","description":"GET /feed/list","tags":["business"],"parameters":[{"name":"page","in":"query","required":false,"description":"(Optional) Integer The page of cards to return, defaults to 0 (returns the first set of up to 100)","schema":{"type":"string","description":"(Optional) Integer The page of cards to return, defaults to 0 (returns the first set of up to 100)"}},{"name":"include_archived","in":"query","required":false,"description":"(Optional) Boolean Whether or not to include archived cards, defaults to false","schema":{"type":"string","description":"(Optional) Boolean Whether or not to include archived cards, defaults to false"}},{"name":"sort_direction","in":"query","required":false,"description":"(Optional) String Pass in the value `desc` to sort by creation time from newest to oldest. Pass in `asc` to sort from oldest to newest. If…","schema":{"type":"string","description":"(Optional) String Pass in the value `desc` to sort by creation time from newest to oldest. Pass in `asc` to sort from oldest to newest. If…"}}],"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":"live"}},"/v1/business:braze/daily-active-users-by-date":{"get":{"operationId":"business_braze_daily_active_users_by_date","summary":"Daily Active Users by Date","description":"GET /kpi/dau/data_series","tags":["business"],"parameters":[{"name":"length","in":"query","required":false,"description":"(Required) Integer Max number of days before ending_at to include in the returned series - must be between 1 and 100 inclusive","schema":{"type":"string","description":"(Required) Integer Max number of days before ending_at to include in the returned series - must be between 1 and 100 inclusive"}},{"name":"ending_at","in":"query","required":false,"description":"(Optional) DateTime (ISO 8601 string) Point in time when the data series should end - defaults to time of the request","schema":{"type":"string","description":"(Optional) DateTime (ISO 8601 string) Point in time when the data series should end - defaults to time of the request"}},{"name":"app_id","in":"query","required":false,"description":"(Optional) String App API identifier; if excluded, results for all apps in app group will be returned","schema":{"type":"string","description":"(Optional) String App API identifier; if excluded, results for all apps in app group will be returned"}}],"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":"live"}},"/v1/business:braze/monthly-active-users-for-last30-days":{"get":{"operationId":"business_braze_monthly_active_users_for_last30_days","summary":"Monthly Active Users for Last 30 Days","description":"GET /kpi/mau/data_series","tags":["business"],"parameters":[{"name":"length","in":"query","required":false,"description":"(Required) Integer Max number of days before ending_at to include in the returned series - must be between 1 and 100 inclusive","schema":{"type":"string","description":"(Required) Integer Max number of days before ending_at to include in the returned series - must be between 1 and 100 inclusive"}},{"name":"ending_at","in":"query","required":false,"description":"(Optional) DateTime (ISO 8601 string) Point in time when the data series should end - defaults to time of the request","schema":{"type":"string","description":"(Optional) DateTime (ISO 8601 string) Point in time when the data series should end - defaults to time of the request"}},{"name":"app_id","in":"query","required":false,"description":"(Optional) String App API identifier; if excluded, results for all apps in app group will be returned","schema":{"type":"string","description":"(Optional) String App API identifier; if excluded, results for all apps in app group will be returned"}}],"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":"live"}},"/v1/business:braze/daily-new-users-by-date":{"get":{"operationId":"business_braze_daily_new_users_by_date","summary":"Daily New Users by Date","description":"GET /kpi/new_users/data_series","tags":["business"],"parameters":[{"name":"length","in":"query","required":false,"description":"(Required) Integer Max number of days before ending_at to include in the returned series - must be between 1 and 100 inclusive","schema":{"type":"string","description":"(Required) Integer Max number of days before ending_at to include in the returned series - must be between 1 and 100 inclusive"}},{"name":"ending_at","in":"query","required":false,"description":"(Optional) DateTime (ISO 8601 string) Point in time when the data series should end - defaults to time of the request","schema":{"type":"string","description":"(Optional) DateTime (ISO 8601 string) Point in time when the data series should end - defaults to time of the request"}},{"name":"app_id","in":"query","required":false,"description":"(Optional) String App API identifier; if excluded, results for all apps in app group will be returned","schema":{"type":"string","description":"(Optional) String App API identifier; if excluded, results for all apps in app group will be returned"}}],"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":"live"}},"/v1/business:braze/kp-is-for-daily-app-uninstalls-by-date":{"get":{"operationId":"business_braze_kp_is_for_daily_app_uninstalls_by_date","summary":"KPIs for Daily App Uninstalls by Date","description":"GET /kpi/uninstalls/data_series","tags":["business"],"parameters":[{"name":"length","in":"query","required":false,"description":"(Required) Integer Max number of days before ending_at to include in the returned series - must be between 1 and 100 inclusive","schema":{"type":"string","description":"(Required) Integer Max number of days before ending_at to include in the returned series - must be between 1 and 100 inclusive"}},{"name":"ending_at","in":"query","required":false,"description":"(Optional) DateTime (ISO 8601 string) Point in time when the data series should end - defaults to time of the request","schema":{"type":"string","description":"(Optional) DateTime (ISO 8601 string) Point in time when the data series should end - defaults to time of the request"}},{"name":"app_id","in":"query","required":false,"description":"(Optional) String App API identifier; if excluded, results for all apps in app group will be returned","schema":{"type":"string","description":"(Optional) String App API identifier; if excluded, results for all apps in app group will be returned"}}],"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":"live"}},"/v1/business:braze/get-upcoming-scheduled-campaigns-and-canvases":{"get":{"operationId":"business_braze_get_upcoming_scheduled_campaigns_and_canvases","summary":"Get Upcoming Scheduled Campaigns and Canvases","description":"GET /messages/scheduled_broadcasts","tags":["business"],"parameters":[{"name":"end_time","in":"query","required":false,"description":"(Required) String in ISO 8601 format End date of the range to retrieve upcoming scheduled Campaigns and Canvases. This is treated as…","schema":{"type":"string","description":"(Required) String in ISO 8601 format End date of the range to retrieve upcoming scheduled Campaigns and Canvases. This is treated as…"}}],"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":"live"}},"/v1/business:braze/segment-analytics":{"get":{"operationId":"business_braze_segment_analytics","summary":"Segment Analytics","description":"GET /segments/data_series","tags":["business"],"parameters":[{"name":"segment_id","in":"query","required":false,"description":"(Required) String Segment API identifier.","schema":{"type":"string","description":"(Required) String Segment API identifier."}},{"name":"length","in":"query","required":false,"description":"(Required) Integer Max number of days before `ending_at` to include in the returned series - must be between 1 and 100 inclusive.","schema":{"type":"string","description":"(Required) Integer Max number of days before `ending_at` to include in the returned series - must be between 1 and 100 inclusive."}},{"name":"ending_at","in":"query","required":false,"description":"(Optional) DateTime (ISO 8601 string) Point in time when the data series should end - defaults to time of the request.","schema":{"type":"string","description":"(Optional) DateTime (ISO 8601 string) Point in time when the data series should end - defaults to time of the request."}}],"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":"live"}},"/v1/business:braze/segment-details":{"get":{"operationId":"business_braze_segment_details","summary":"Segment Details","description":"GET /segments/details","tags":["business"],"parameters":[{"name":"segment_id","in":"query","required":false,"description":"(Required) String Segment API identifier","schema":{"type":"string","description":"(Required) String Segment API identifier"}}],"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":"live"}},"/v1/business:braze/segment-list":{"get":{"operationId":"business_braze_segment_list","summary":"Segment List","description":"GET /segments/list","tags":["business"],"parameters":[{"name":"page","in":"query","required":false,"description":"(Optional) Integer The page of segments to return, defaults to 0 (returns the first set of up to 100)","schema":{"type":"string","description":"(Optional) Integer The page of segments to return, defaults to 0 (returns the first set of up to 100)"}},{"name":"sort_direction","in":"query","required":false,"description":"(Optional) String Pass in the value `desc` to sort by creation time from newest to oldest. Pass in `asc` to sort from oldest to newest. If…","schema":{"type":"string","description":"(Optional) String Pass in the value `desc` to sort by creation time from newest to oldest. Pass in `asc` to sort from oldest to newest. If…"}}],"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":"live"}},"/v1/business:braze/send-analytics":{"get":{"operationId":"business_braze_send_analytics","summary":"Send Analytics","description":"GET /sends/data_series","tags":["business"],"parameters":[{"name":"campaign_id","in":"query","required":false,"description":"(Required) String Campaign API identifier.","schema":{"type":"string","description":"(Required) String Campaign API identifier."}},{"name":"send_id","in":"query","required":false,"description":"(Required) String Send API identifier.","schema":{"type":"string","description":"(Required) String Send API identifier."}},{"name":"length","in":"query","required":false,"description":"(Required) Integer Maximum number of days before `ending_at` to include in the returned series. Must be between 1 and 100 inclusive.","schema":{"type":"string","description":"(Required) Integer Maximum number of days before `ending_at` to include in the returned series. Must be between 1 and 100 inclusive."}},{"name":"ending_at","in":"query","required":false,"description":"(Optional) Datetime ISO 8601 string Date on which the data series should end. Defaults to time of the request.","schema":{"type":"string","description":"(Optional) Datetime ISO 8601 string Date on which the data series should end. Defaults to time of the request."}}],"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":"live"}},"/v1/business:braze/app-sessions-by-time":{"get":{"operationId":"business_braze_app_sessions_by_time","summary":"App Sessions by Time","description":"GET /sessions/data_series","tags":["business"],"parameters":[{"name":"length","in":"query","required":false,"description":"(Required) Integer Max number of units (days or hours) before ending_at to include in the returned series - must be between 1 and 100…","schema":{"type":"string","description":"(Required) Integer Max number of units (days or hours) before ending_at to include in the returned series - must be between 1 and 100…"}},{"name":"unit","in":"query","required":false,"description":"(Optional) String Unit of time between data points - can be \"day\" or \"hour\" (defaults to \"day\").","schema":{"type":"string","description":"(Optional) String Unit of time between data points - can be \"day\" or \"hour\" (defaults to \"day\")."}},{"name":"ending_at","in":"query","required":false,"description":"(Optional) DateTime (ISO 8601 string) Point in time when the data series should end - defaults to time of the request.","schema":{"type":"string","description":"(Optional) DateTime (ISO 8601 string) Point in time when the data series should end - defaults to time of the request."}},{"name":"app_id","in":"query","required":false,"description":"(Optional) String App API identifier retrieved from the Developer Console to limit analytics to a specific app.","schema":{"type":"string","description":"(Optional) String App API identifier retrieved from the Developer Console to limit analytics to a specific app."}},{"name":"segment_id","in":"query","required":false,"description":"(Optional) String Segment API identifier indicating the analytics enabled segment for which sessions should be returned.","schema":{"type":"string","description":"(Optional) String Segment API identifier indicating the analytics enabled segment for which sessions should be returned."}}],"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":"live"}},"/v1/business:braze/list-user-s-subscription-group-status-sms":{"get":{"operationId":"business_braze_list_user_s_subscription_group_status_sms","summary":"List User's Subscription Group Status - SMS","description":"GET /subscription/status/get","tags":["business"],"parameters":[{"name":"subscription_group_id","in":"query","required":false,"description":"(Required) String The `id` of your subscription group.","schema":{"type":"string","description":"(Required) String The `id` of your subscription group."}},{"name":"external_id","in":"query","required":false,"description":"(Required*) String The `external_id` of the user (must include at least one and at most 50 `external_ids`). Only external_id or phone is…","schema":{"type":"string","description":"(Required*) String The `external_id` of the user (must include at least one and at most 50 `external_ids`). Only external_id or phone is…"}},{"name":"phone","in":"query","required":false,"description":"(Required*) String The phone number of the user (must include at least one phone number and at most 50 phone numbers). The recommendation…","schema":{"type":"string","description":"(Required*) String The phone number of the user (must include at least one phone number and at most 50 phone numbers). The recommendation…"}}],"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":"live"}},"/v1/business:braze/list-user-s-subscription-group-sms":{"get":{"operationId":"business_braze_list_user_s_subscription_group_sms","summary":"List User's Subscription Group - SMS","description":"GET /subscription/user/status","tags":["business"],"parameters":[{"name":"external_id","in":"query","required":false,"description":"(Required*) String The external_id of the user. Must include at least one and at most 50 `external_ids`.","schema":{"type":"string","description":"(Required*) String The external_id of the user. Must include at least one and at most 50 `external_ids`."}},{"name":"limit","in":"query","required":false,"description":"(Optional) Integer The limit on the maximum number of results returned. Default (and max) limit is 100.","schema":{"type":"string","description":"(Optional) Integer The limit on the maximum number of results returned. Default (and max) limit is 100."}},{"name":"offset","in":"query","required":false,"description":"(Optional) Integer Number of templates to skip before returning rest of the templates that fit the search criteria.","schema":{"type":"string","description":"(Optional) Integer Number of templates to skip before returning rest of the templates that fit the search criteria."}},{"name":"phone","in":"query","required":false,"description":"(Required*) String The phone number of the user (must include at least one phone number and at most 50 phone numbers). The recommendation…","schema":{"type":"string","description":"(Required*) String The phone number of the user (must include at least one phone number and at most 50 phone numbers). The recommendation…"}}],"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":"live"}},"/v1/business:braze/see-email-template-information":{"get":{"operationId":"business_braze_see_email_template_information","summary":"See Email Template Information","description":"GET /templates/email/info","tags":["business"],"parameters":[{"name":"email_template_id","in":"query","required":false,"description":"(Required) String Your email template's API Identifier.","schema":{"type":"string","description":"(Required) String Your email template's API Identifier."}}],"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":"live"}},"/v1/business:braze/list-available-email-templates":{"get":{"operationId":"business_braze_list_available_email_templates","summary":"List Available Email Templates","description":"GET /templates/email/list","tags":["business"],"parameters":[{"name":"modified_after","in":"query","required":false,"description":"(Optional) String in ISO 8601 Retrieve only templates updated at or after the given time.","schema":{"type":"string","description":"(Optional) String in ISO 8601 Retrieve only templates updated at or after the given time."}},{"name":"modified_before","in":"query","required":false,"description":"(Optional) String in ISO 8601 Retrieve only templates updated at or before the given time","schema":{"type":"string","description":"(Optional) String in ISO 8601 Retrieve only templates updated at or before the given time"}},{"name":"limit","in":"query","required":false,"description":"(Optional) Positive Number Maximum number of templates to retrieve, default to 100 if not provided, maximum acceptable value is 1000.","schema":{"type":"string","description":"(Optional) Positive Number Maximum number of templates to retrieve, default to 100 if not provided, maximum acceptable value is 1000."}},{"name":"offset","in":"query","required":false,"description":"(Optional) Positive Number Number of templates to skip before returning rest of the templates that fit the search criteria.","schema":{"type":"string","description":"(Optional) Positive Number Number of templates to skip before returning rest of the templates that fit the search criteria."}}],"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":"live"}}},"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"}}}}}}}