Campaign Analytics

GET https://{{instance_url}}/campaigns/data_series?campaign_id={{campaign_identifier}}&length=7&ending_at=2020-06-28T23:59:59-5:00

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.

Components Used

-Campaign Identifier

Responses

Multi-Channel Response

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
    "message": (required, string) the status of the export, returns 'success' when completed without errors,
    "data" : [
        {
            "time" : (string) date as ISO 8601 date,
            "messages" : {
                "ios_push" : [
                    {
                      "variation_name": "iOS_Push",
                      "sent" : (int),
                      "direct_opens" : (int),
                      "total_opens" : (int),
                      "bounces" : (int),
                      "body_clicks" : (int)
                      "revenue": 0,
                      "unique_recipients": 1,
                      "conversions": 0,
                      "conversions_by_send_time": 0,
                      "conversions1": 0,
                      "conversions1_by_send_time": 0,
                      "conversions2": 0,
                      "conversions2_by_send_time": 0,
                      "conversions3": 0,
                      "conversions3_by_send_time": 0,
                      "carousel_slide_[NUM]_[TITLE]_click": (optional, int),
                      "notif_button_[NUM]_[TITLE]_click": (optional, int)
                    }
                ],
                "android_push" : [
                    {
                      "sent" : (int),
                      "direct_opens" : (int),
                      "total_opens" : (int),
                      "bounces" : (int),
                      "body_clicks" : (int)
                    }
                ],
                "webhook": [
                    {
                      "sent": (int),
                      "errors": (int)
                    }
                ],
                "email" : [
                    {
                      "sent": (int),
                      "opens": (int),
                      "unique_opens": (int),
                      "clicks": (int),
                      "unique_clicks": (int),
                      "unsubscribes": (int),
                      "bounces": (int),
                      "delivered": (int),
                      "reported_spam": (int)
                    }
                ],
                "sms" : [
                  {
                    "sent": (int),
                    "delivered": (int),
                    "undelivered": (int),
                    "delivery_failed": (int)
                  }
                ]
              },
           "conversions_by_send_time": (optional, int),
           "conversions1_by_send_time": (optional, int),
           "conversions2_by_send_time": (optional, int),
           "conversions3_by_send_time": (optional, int),
           "conversions": (int),
           "conversions1": (optional, int),
           "conversions2": (optional, int),
           "conversions3": (optional, int),
           "unique_recipients": (int),
           "revenue": (optional, float)
        },
        ...
    ],
    ...
}

Multivariate Response

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
    "data" : [
        {
            "time" : (string) date as ISO 8601 date,
            "conversions" : (int),
            "revenue": (float),
            "conversions_by_send_time": (int),
            "messages" : {
               "trigger_in_app_message": [{
                    "variation_name": (optional, string),
                    "impressions": (int),
                    "clicks": (int),
                    "first_button_clicks": (int),
                    "second_button_clicks": (int),
                    "revenue": (optional, float),,
                    "unique_recipients": (int),
                    "conversions": (optional, int),
                    "conversions_by_send_time": (optional, int),
                    "conversions1": (optional, int),
                    "conversions1_by_send_time": (optional, int),
                    "conversions2": (optional, int),
                    "conversions2_by_send_time": (optional, int),
                    "conversions3": (optional, int),
                    "conversions3_by_send_time": (optional, int)
                }, {
                    "variation_name": (optional, string),
                    "impressions": (int),
                    "clicks": (int),
                    "first_button_clicks": (int),
                    "second_button_clicks": (int),
                    "revenue": (optional, float),,
                    "unique_recipients": (int),
                    "conversions": (optional, int),
                    "conversions_by_send_time": (optional, int),
                    "conversions1": (optional, int),
                    "conversions1_by_send_time": (optional, int),
                    "conversions2": (optional, int),
                    "conversions2_by_send_time": (optional, int),
                    "conversions3": (optional, int).
                    "conversions3_by_send_time": (optional, int)
                }, {
                    "variation_name": (optional, string),
                    "revenue": (optional, float),,
                    "unique_recipients": (int),
                    "conversions": (optional, int),
                    "conversions_by_send_time": (optional, int),
                    "conversions1": (optional, int),
                    "conversions1_by_send_time": (optional, int),
                    "conversions2": (optional, int),
                    "conversions2_by_send_time": (optional, int),
                    "conversions3": (optional, int),
                    "conversions3_by_send_time": (optional, int),
                    "enrolled": (optional, int)
                }]
            },
            "conversions_by_send_time": (optional, int),
            "conversions1_by_send_time": (optional, int),
            "conversions2_by_send_time": (optional, int),
            "conversions3_by_send_time": (optional, int),
            "conversions": (optional, int,
            "conversions1": (optional, int),
            "conversions2": (optional, int),
            "conversions3": (optional, int),
            "unique_recipients": (int),
            "revenue": (optional, float)
         }],
         ...
}

Possible 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.

Request Params

Campaign API identifier | | length | number | | (Required) Integer

Max number of days before ending_at to include in the returned series - must be between 1 and 100 inclusive | | ending_at | string | | (Optional) DateTime (ISO 8601 string)

Date on which the data series should end - defaults to time of the request |

HEADERS