Detailed report without stats

API at a glance

Description: This API returns the detailed report of a specific campaign without performance statistics. Use this endpoint when you only need campaign metadata (configuration, triggers, segments, schedule) and not performance metrics.

ℹ️
Note
This API provides better performance than the Detailed report with stats API if you are only looking for campaign metadata.

Authentication & testing

Testing the API on this page

How to try it here

Use your User API Key as the Username (leave Password blank).

Select the appropriate API endpoint based on your Blueshift region.

Enter the necessary parameters and click Try It to run the request.

Authentication using Base64 encoding

Note for developers

API requests require authentication using HTTP Basic Authentication with an API key. The API key serves as the username, while the password field should be left empty. The format to encode is: your_api_key: (note the trailing colon).

This string must be Base64-encoded and included in the request's Authorization header as follows:

Authorization: Basic encoded_value

You can generate the encoded value using a trusted Base64 encoder.

Postman collection

Try it with Postman: Explore the API using Blueshift's Postman collection.

Things to know before you start

Campaign UUID: You can copy the UUID from the URL of the campaign on the Blueshift app. For example, if you open a campaign in the Blueshift app, its URL looks like https://app.getblueshift.com/dashboard#/app/campaigns/<CAMPAIGN_UUID>/details.
No statistics: This endpoint does not return performance metrics. Use the "Detailed report with stats" endpoint if you need statistics.
Performance: This endpoint is faster than the stats version when you only need campaign configuration details.
Use case: Best for retrieving campaign configuration, triggers, segments, and schedule information without the overhead of fetching statistics.

👍
Finding the campaign UUID
The campaign UUID is visible in the browser's address bar when you open a campaign. For example: https://app.getblueshift.com/dashboard#/app/campaigns/<CAMPAIGN_UUID>/edit_v3/journey

Request parameters

Check out the request parameters

Path parameters

Parameter	Type	Required	Description
`campaign_uuid`	`string`	✅ Yes	Specify the UUID of the campaign for which you want a detailed report. You can copy the UUID from the URL of the campaign on dashboard.

Example requests & responses

Get detailed campaign report without stats

Request

curl --request GET \
     --url https://api.getblueshift.com/api/v1/campaigns/a43b685d-65e3-5303-64d8-d4b4ab075b5f.json \
     --header 'accept: application/json' \
     --header 'authorization: Basic <YOUR_API_KEY>'

Response

{
  "status": "OK"
}