GET /campaigns/details

This endpoint allows you to retrieve relevant information on a specified campaign, which can be identified by the `campaign_id`. > The campaign_id for API campaigns can be found on the Developer Console page and the campaign details page within your dashboard or you can use the Campaign List Endpoint. ### Components Used - [Campaign Identifier](https://www.braze.com/docs/api/identifier_types/) ### Campaign Details Endpoint API Response ```json Content-Type: application/json Authorization: Bearer YOUR-REST-API-KEY { "message": (required, string) the status of the export, returns 'success' when completed without errors, "created_at" : (string) date created as ISO 8601 date, "updated_at" : (string) date last updated as ISO 8601 date, "archived": (boolean) whether this Campaign is archived, "draft": (boolean) whether this Campaign is a draft, "name" : (string) campaign name, "description" : (string) campaign description, "schedule_type" : (string) type of scheduling action, "channels" : (array) list of channels to send via, "first_sent" : (string) date and hour of first sent as ISO 8601 date, "last_sent" : (string) date and hour of last sent as ISO 8601 date, "tags" : (array) tag names associated with the campaign, "messages": { "message_variation_id": (string) { // <=This is the actual id "channel": (string) channel type of the message (as in, "email", "ios_push", "webhook", "content_card", "in-app_message", "sms"), "name": (string) name of the message in the Dashboard (eg., "Variation 1") ... channel-specific fields for this message, see below ... } }, "conversion_behaviors": (array) conversion event behaviors assigned to the campaign (see below) } ``` #### Messages The `messages` response will contain information about each message. Example message responses for channels are below: ##### Push Channels ```json { "channel": (string) description of the channel, such as "ios_push" or "android_push" "alert": (string) alert body text, "extras": (hash) any key value pairs provided } ``` ##### Email Channel ```json { "channel": "email", "subject": (string) subject, "body": (string) HTML body, "from": (string) from address and display name, "reply_to": (string) reply-to for message, if different than "from" address, "title": (string) name of the email, "extras": (hash) any key value pairs provided } ``` ##### Content Card Channel ```json { "channel": "content_cards", "name": (string) name of variant, "extras": (hash) any key value pairs provided; only present if at least one key-value pair has been set } ``` ##### Webhook Channel ```json { "channel": "webhook", "url": (string) url for webhook, "body": (string) payload body, "type": (string) body content type, "headers": (hash) specified request headers, "method": (string) HTTP method (e.g., "POST" or "GET"), } ``` ##### SMS Channel ```json { "channel": "sms", "body": (string) payload body, "from": (string) list of numbers associated with the subscription group, "subscription_group_id": (string) API id of the subscription group targeted in the SMS message } ``` ##### Control Messages ```json { "channel": (string) description of the channel that the control is for, "type": "control" } ``` #### Conversion Behaviors The `conversion_behaviors` array will contain information about each conversion event behavior set for the campaign. These behaviors are in order as set by the campaign. For example, Conversion Event A will be the first item in the array, Conversion Event B will be second, etc. Example conversion event behavior responses for are below: ##### Clicks Email ```json { "type": "Clicks Email", "window": (integer) number of seconds during which the user can convert on this event, i.e. - 86400, which is 24 hours } ``` ##### Opens Email ```json { "type": "Opens Email", "window": (integer) number of seconds during which the user can convert on this event, i.e. - 86400, which is 24 hours } ``` ##### Makes Purchase (any purchase) ```json { "type": "Makes Any Purchase", "window": (integer) number of seconds during which the user can convert on this event, i.e. - 86400, which is 24 hours } ``` ##### Makes Purchase (specific product) ```json { "type": "Makes Specific Purchase", "window": (integer) number of seconds during which the user can convert on this event, i.e. - 86400, which is 24 hours, "product": (string) name of the product, i.e. - "Feline Body Armor" } ``` ##### Performs Custom Event ```json { "type": "Performs Custom Event", "window": (integer) number of seconds during which the user can convert on this event, i.e. - 86400, which is 24 hours, "custom_event_name": (string) name of the event, i.e. - "Used Feline Body Armor" } ``` ##### Upgrades App ```json { "type": "Upgrades App", "window": (integer) number of seconds during which the user can convert on this event, i.e. - 86400, which is 24 hours, "app_ids": (array|null) array of app ids, i.e. - ["12345", "67890"], or `null` if "Track sessions for any app" is selected in the UI } ``` ##### Uses App ```json { "type": "Starts Session", "window": (integer) number of seconds during which the user can convert on this event, i.e. - 86400, which is 24 hours, "app_ids": (array|null) array of app ids, i.e. - ["12345", "67890"], or `null` if "Track sessions for any app" is selected in the UI } ```