get
https://api.getblueshift.com/api/v1/onsite_slots.json
API at a glance
Description: This API retrieves a list of live content slots configured in your Blueshift account. You can filter by slot name, format, or active status.
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_valueYou 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
- Optional filters: All query parameters are optional. Leave them blank to retrieve all slots.
- Format types: Slot formats can be HTML, JSON, Popup, or Landing Page (case insensitive).
- Active filter: When
activeis true, returns slots linked to campaigns not in 'Completed' or 'Archived' states. When false, returns unused slots or slots associated with completed/archived campaigns. - Response structure: Returns an array of slot objects, each containing name, format, and UUID.
- Use case: Best for managing live content slots, auditing slot configurations, and integrating with external systems.
Request parameters
Check out the request parameters
Query parameters
Note: All query parameters are optional. Leave blank to get all slots.
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | ❌ No | Search for live content slots that contain the specified string in the name. |
slot_format | string | ❌ No | Search by format. Case insensitive. Values: HTML, JSON, Popup, Landing Page. |
active | boolean | ❌ No | Filter by active status. true returns slots linked to active campaigns. false returns unused slots or slots with completed/archived campaigns. |
Example requests & responses
List all live content slots
Request
curl --request GET \
--url https://api.getblueshift.com/api/v1/onsite_slots.json \
--header 'accept: application/json' \
--header 'authorization: Basic <YOUR_API_KEY>'Response
[
{
"name": "abandon_browse_html",
"format": "HTML",
"uuid": "81878e0675c5c-4baa-b876-f90b0cf62e02"
},
{
"name": "mobile_top_banner",
"format": "JSON",
"uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
]Filter by format and active status
Request
curl --request GET \
--url 'https://api.getblueshift.com/api/v1/onsite_slots.json?slot_format=JSON&active=true' \
--header 'accept: application/json' \
--header 'authorization: Basic <YOUR_API_KEY>'Response
[
{
"name": "mobile_top_banner",
"format": "JSON",
"uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
]