Send Analytics Endpoint

get

/sends/data_series

This endpoint allows you to retrieve a daily series of various stats for a tracked send_id. Braze stores send analytics for 14 days after the send.

Campaign conversions will be attributed towards the most recent send id that a given user has received from the campaign.

The send_id is only generated for API campaign sends targeting segments, connected audiences or broadcasts. When relevant, the send_id is included in response for the messages/send, messages/schedule, campaign/trigger/send and campaign/trigger/schedule endpoints.

See me in Postman

Request Parameters

Parameter Required Data Type Description
campaign_id Yes String Campaign API Identifier.
send_id Yes String Send API Identifier.
length Yes Integer Max number of days before ending_at to include in the returned series - must be between 1 and 100 inclusive.
ending_at No DateTime (ISO 8601 string) Date on which the data series should end - defaults to time of the request.

Request Components

  • Campaign Identifier

    The send_id is only generated for API campaign sends targeting segments, connected audiences or broadcasts. When relevant, the send_id is included in response for the messages/send, messages/schedule, campaign/trigger/send and campaign/trigger/schedule endpoints.

Example URL

https://rest.iad-01.braze.com/sends/data_series?campaign_id=3bbc4555-8fa0-4c9b-a5c0-4505edf3e064&send_id=3456789&length=30&ending_at=2014-12-10T23:59:59-05:00

Example Request

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/sends/data_series?campaign_id=3bbc4555-8fa0-4c9b-a5c0-4505edf3e064&send_id=3456789&length=30&ending_at=2014-12-10T23:59:59-05:00' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'

Send Analytics Endpoint API Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
{
            "variation_name": (string) variation name,
            "sent": (int) the number of sends,
            "delivered": (int) the number of messages successfully delivered,
            "undelivered": (int) the number of undelivered,
            "delivery_failed": (int) the number of rejected,
            "direct_opens": (int) the number of direct opens,
            "total_opens": (int) the number of total opens,
            "bounces": (int) the number of bounces,
            "body_clicks": (int) the number of body clicks,
            "revenue": (float) the number of dollars of revenue (USD),
            "unique_recipients": (int) the number of unique recipients,
            "conversions": (int) the number of conversions,
            "conversions_by_send_time": (int) the number of conversions,
            "conversions1": (int, optional) the number of conversions for the second conversion event,
            "conversions1_by_send_time": (int, optional) the number of conversions for the second conversion event by send time,
            "conversions2": (int, optional) the number of conversions for the third conversion event,
            "conversions2_by_send_time": (int, optional) the number of conversions for the third conversion event by send time,
            "conversions3": (int, optional) the number of conversions for the fourth conversion event,
            "conversions3_by_send_time": (int, optional) the number of conversions for the fourth conversion event by send time
          }
        ]
      },
      "conversions_by_send_time": 0,
      "conversions1_by_send_time": 0,
      "conversions2_by_send_time": 0,
      "conversions3_by_send_time": 0,
      "conversions": 0,
      "conversions1": 0,
      "conversions2": 0,
      "conversions3": 0,
      "unique_recipients": 1,
      "revenue": 0
    }
  ],
  "message": "success"
}
  Edit this page on GitHub
WAS THIS PAGE HELPFUL?
New Stuff!