action braze_campaign_analytics {
  label: "Campaign Analytics"
  description: "This endpoint allows you to retrieve a daily series of various stats for a campaign over time. Data returned includes how many messages were sent, opened, clicked, converted, etc., broken down by message channel. \n\n### Components Used\n-[Campaign Identifier](https://www.braze.com/docs/api/identifier_types/)\n\n\n### Responses\n\n#### Multi-Channel Response\n\n```json\nContent-Type: application/json\nAuthorization: Bearer YOUR-REST-API-KEY\n{\n    \"message\": (required, string) the status of the export, returns 'success' when completed without errors,\n    \"data\" : [\n        {\n            \"time\" : (string) date as ISO 8601 date,\n            \"messages\" : {\n                \"ios_push\" : [\n                    {\n                      \"variation_name\": \"iOS_Push\",\n                      \"sent\" : (int),\n                      \"direct_opens\" : (int),\n                      \"total_opens\" : (int),\n                      \"bounces\" : (int),\n                      \"body_clicks\" : (int)\n                      \"revenue\": 0,\n                      \"unique_recipients\": 1,\n                      \"conversions\": 0,\n                      \"conversions_by_send_time\": 0,\n                      \"conversions1\": 0,\n                      \"conversions1_by_send_time\": 0,\n                      \"conversions2\": 0,\n                      \"conversions2_by_send_time\": 0,\n                      \"conversions3\": 0,\n                      \"conversions3_by_send_time\": 0,\n                      \"carousel_slide_[NUM]_[TITLE]_click\": (optional, int),\n                      \"notif_button_[NUM]_[TITLE]_click\": (optional, int)\n                    }\n                ],\n                \"android_push\" : [\n                    {\n                      \"sent\" : (int),\n                      \"direct_opens\" : (int),\n                      \"total_opens\" : (int),\n                      \"bounces\" : (int),\n                      \"body_clicks\" : (int)\n                    }\n                ],\n                \"webhook\": [\n                    {\n                      \"sent\": (int),\n                      \"errors\": (int)\n                    }\n                ],\n                \"email\" : [\n                    {\n                      \"sent\": (int),\n                      \"opens\": (int),\n                      \"unique_opens\": (int),\n                      \"clicks\": (int),\n                      \"unique_clicks\": (int),\n                      \"unsubscribes\": (int),\n                      \"bounces\": (int),\n                      \"delivered\": (int),\n                      \"reported_spam\": (int)\n                    }\n                ],\n                \"sms\" : [\n                  {\n                    \"sent\": (int),\n                    \"delivered\": (int),\n                    \"undelivered\": (int),\n                    \"delivery_failed\": (int)\n                  }\n                ]\n              },\n           \"conversions_by_send_time\": (optional, int),\n           \"conversions1_by_send_time\": (optional, int),\n           \"conversions2_by_send_time\": (optional, int),\n           \"conversions3_by_send_time\": (optional, int),\n           \"conversions\": (int),\n           \"conversions1\": (optional, int),\n           \"conversions2\": (optional, int),\n           \"conversions3\": (optional, int),\n           \"unique_recipients\": (int),\n           \"revenue\": (optional, float)\n        },\n        ...\n    ],\n    ...\n}\n```\n\n#### Multivariate Response\n\n```json\nContent-Type: application/json\nAuthorization: Bearer YOUR-REST-API-KEY\n{\n    \"data\" : [\n        {\n            \"time\" : (string) date as ISO 8601 date,\n            \"conversions\" : (int),\n            \"revenue\": (float),\n            \"conversions_by_send_time\": (int),\n            \"messages\" : {\n               \"trigger_in_app_message\": [{\n      				\"variation_name\": (optional, string),\n      				\"impressions\": (int),\n      				\"clicks\": (int),\n      				\"first_button_clicks\": (int),\n      				\"second_button_clicks\": (int),\n      				\"revenue\": (optional, float),,\n      				\"unique_recipients\": (int),\n      				\"conversions\": (optional, int),\n      				\"conversions_by_send_time\": (optional, int),\n      				\"conversions1\": (optional, int),\n      				\"conversions1_by_send_time\": (optional, int),\n      				\"conversions2\": (optional, int),\n      				\"conversions2_by_send_time\": (optional, int),\n      				\"conversions3\": (optional, int),\n      				\"conversions3_by_send_time\": (optional, int)\n      			}, {\n      				\"variation_name\": (optional, string),\n      				\"impressions\": (int),\n      				\"clicks\": (int),\n      				\"first_button_clicks\": (int),\n      				\"second_button_clicks\": (int),\n      				\"revenue\": (optional, float),,\n      				\"unique_recipients\": (int),\n      				\"conversions\": (optional, int),\n      				\"conversions_by_send_time\": (optional, int),\n      				\"conversions1\": (optional, int),\n      				\"conversions1_by_send_time\": (optional, int),\n      				\"conversions2\": (optional, int),\n      				\"conversions2_by_send_time\": (optional, int),\n      				\"conversions3\": (optional, int).\n      				\"conversions3_by_send_time\": (optional, int)\n      			}, {\n      				\"variation_name\": (optional, string),\n      				\"revenue\": (optional, float),,\n      				\"unique_recipients\": (int),\n      				\"conversions\": (optional, int),\n      				\"conversions_by_send_time\": (optional, int),\n      				\"conversions1\": (optional, int),\n      				\"conversions1_by_send_time\": (optional, int),\n      				\"conversions2\": (optional, int),\n      				\"conversions2_by_send_time\": (optional, int),\n      				\"conversions3\": (optional, int),\n      				\"conversions3_by_send_time\": (optional, int),\n      				\"enrolled\": (optional, int)\n      			}]\n      		},\n      		\"conversions_by_send_time\": (optional, int),\n      		\"conversions1_by_send_time\": (optional, int),\n      		\"conversions2_by_send_time\": (optional, int),\n      		\"conversions3_by_send_time\": (optional, int),\n      		\"conversions\": (optional, int,\n      		\"conversions1\": (optional, int),\n      		\"conversions2\": (optional, int),\n      		\"conversions3\": (optional, int),\n      		\"unique_recipients\": (int),\n      		\"revenue\": (optional, float)\n         }],\n         ...\n}\n```\n\nPossible message types are `email`, `in_app_message`, `webhook`, `android_push`, `apple_push`, `kindle_push`, `web_push`, `windows_phone8_push`, and `windows_universal_push`. All push message types will have the same statistics shown for `android_push` above."
  provider: braze
  method: GET
  path: "/campaigns/data_series"
  encoding: json
  input: {
    type: "object"
    properties: {
      campaign_id: {
        type: "string"
      }
      ending_at: {
        type: "string"
      }
      length: {
        type: "string"
      }
    }
    additionalProperties: false
  }
  output: {
    type: "object"
    additionalProperties: true
  }
}