Campaign Report API

You may use Blueshift's Campaign APIs to get real-time campaign summary or detailed statistics. In order to use these APIs, you would need to authenticate with your private Users API Key.  Only Blueshift Admins have access to User API Key.

To note, campaign metrics noted in the UI are calculated using the account time zone.  Thus, if you want the metrics from the report API to match that of the metrics you see in the UI, you will want to edit start/end date to reflect this.
 

Campaign Summary Report

Use this API to export all campaign performance data for date ranges.

Inputs:

  • start_date: In UTC iso8601 format
  • end_date: In UTC iso8601 format
  • status: Campaigns status to filter by, can be empty or 'launched', 'draft', 'paused', 'completed'
  • tag_data: You can also filter the campaign using tags Ex:tag_data=Category:Welcome

Sample call:

  • cURL
curl -u <USER API KEY>: "https://api.getblueshift.com/api/v1/campaigns.json?end_time=2016-03-31T18:29:59.999Z&start_time=2016-03-30T18:30:00.000Z&status=launched&tag_data=Category:Welcome"

Outputs:

  • name: Campaign name
  • uuid: Campaign unique identifier
  • status: Campaign status
  • statistics: Campaign statistics hash object

Sample response:

  • JSON
{
   "campaigns": [
       {
           "campaign_executing": false,
           "campaign_execution_ended_at": "2016-03-31T18:50:49.000Z",
           "campaign_execution_started_at": "2016-03-31T18:50:16.000Z",
           "created_at": "2016-02-25T06:31:56.000Z",
           "currency": "USD",
           "enddate": null,
           "exec_term": "on_going",
           "name": "Abandoned cart campaign",
           "recurring_number": null,
           "recurring_schedule": null,
           "recurring_time": null,
           "recurring_unit": null,
           "segment_name": "Abandoned cart segment",
           "segment_uuid": "644233b1-3236-4415-a356-3b7f19a44977",
           "startdate": "2016-02-24T18:30:00.000Z",
           "statistics": {
               "activations": 0,
               "add_to_carts": 0,
               "assigns": 0,
               "attributions": {},
               "bounces": 59,
               "checkouts": 0,
               "clicks": 61,
               "deliveries": 7116,
               "end_time": "2016-04-01T00:00:00.000Z",
               "media_spent": 0.0,
               "opens": 864,
               "pageloads": 0,
               "purchases": 3,
               "revenue": 24328.0,
               "sends": 7175,
               "spam_reports": 0,
               "start_time": "2016-03-31T00:00:00.000Z",
               "timezone": "Asia/Calcutta",
               "unique_clicks": 42,
               "unique_opens": 563,
               "unsubscribes": 3,
               "visits": 81
           },
           "status": "launched",
           "updated_at": "2016-03-31T18:50:49.000Z",
           "uuid": "869cfcbd-3598-4d13-8595-5ace10861066"
       }
     ]
}
 

Campaign detail report

Use this API endpoint to get detailed campaign statistics for a specific campaign. The data reported includes the performance of multiple-triggers, as well as experiments that may be running on the campaign.

Inputs:

Sample call:

  • cURL
curl -u <Users API Key>: "https://api.getblueshift.com/api/v1/campaigns/<campaign_uuid>/detail.json?end_time=2016-04-01T23:59:59%2B05:30&start_time=2016-04-01T00:00:00%2B05:30"
Was this article helpful?
0 out of 0 found this helpful