DocumentationDeveloper PortalAPI EndpointsProduct Updates
API Endpoints
Contact Us
Start typing to search…

Get customer events

get
https://api.getblueshift.com/api/v1/customer_search/show_events

Use this endpoint to fetch the details of the events for a customer using the customer's UUID.

API at a glance

Description: This API retrieves all events for a specific customer using their UUID. Returns detailed event data including timestamps, browser info, and custom event parameters.

Authentication & testing

Testing the API on this page

How to try it here

  • Use your User API Key as the Username (leave Password blank).
    • User API Key Location
  • Select the appropriate API endpoint based on your Blueshift region.
    • API - Select 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.

🚧

Caution

This API endpoint is provided for debugging purposes only and supports a maximum of 10 calls per hour.

Things to know before you start

  • Customer UUID required: Obtain the customer UUID from the Search customer or Create/Update customer response.
👍

Finding the customer UUID > >

You can find the customer UUID in the URL when viewing a customer profile in the Blueshift app. For example, if you open a customer profile in the Blueshift app, its URL looks like https://app.getblueshift.com/dashboard#/app/customer/<CUSTOMER_UUID>/show/overview.


  • Rate limit: Maximum 10 calls per hour - designed for debugging, not production use.
  • Event data: Returns all event types, including identify, page views, purchases, custom events, etc.
  • Response format: An array of events, sorted by timestamp, with detailed metadata.
  • Use case: Best for debugging customer behavior, troubleshooting event tracking, and investigating specific customer journeys.

Request parameters

Check out the request parameters

Query parameters

ParameterTypeRequiredDescription
uuidstring✅ YesUUID of the customer whose events to fetch.

Example requests & responses

Get customer events
GET /api/v1/customer_search/show_events?uuid=51aceb79-2cbc-4e2b-a132-b02de69bba15
[
  {
    "_bsft_doc_type": "events",
    "_bsft_ts": "2021-08-25T06:06:59.415Z",
    "_bsft_type": {
      "name": "events",
      "parent": "51aceb79-2cbc-4e2b-a132-b02de69bba15"
    },
    "account_uuid": "4b5b584f-fee7-44f3-ae3a-8ba90aa7d2d5",
    "browser_platform": "Windows",
    "browser_type": "Firefox",
    "browser_version": "126.0",
    "cookie": "b854bae6-6dc8-c80c-6133-c45d0ba0fdc4",
    "email": "[email protected]",
    "event": "identify",
    "event_uuid": "3766f118-d4cd-11eb-a278-0242ac110006",
    "ip": "201.33.19.3",
    "referrer": "http://site.com",
    "santized_at": "2021-08-25T06:06:59.415Z",
    "session_uuid": null,
    "site": "http://site.com",
    "timestamp": "2021-06-24T04:53:54Z",
    "timestamp_epoch": 1624510434,
    "url": "http://site.com",
    "user_agent": "mozilla/5.0 (macintosh; intel mac os x 10_15_7) applewebkit/537.36 (khtml, like gecko) chrome/91.0.4472.77 safari/537.36",
    "user_uuid": "51aceb79-2cbc-4e2b-a132-b02de69bba15"
  }
]
API error responses

Note
The following error codes are commonly returned by Blueshift APIs. Depending on the specific endpoint, not all may apply.

Status code

Description

Example responses

400 Bad Request

The request is invalid due to missing or incorrect parameters. This includes missing fields, invalid values, formatting issues, or conflicts such as duplicate data.

{ "errors": { "name": ["can't be blank"] } }

{ "errors": { "startdate": ["can't be blank"] } }

401 Unauthorized

API authentication failed due to an invalid or missing API key.

{ "message": "Not authorized" }

403 Forbidden

The API key does not have sufficient permissions to perform this action.

{ "message": "Permission denied" }

404 Not Found

The specified campaign was not found. Verify the campaign UUID.

{ "message": "Campaign not found" }

422 Unprocessable Entity

  • The campaign cannot be paused due to its current status (e.g., already completed or archived).
  • One or more scheduling parameters may be invalid (if applicable).

{ "message": "Campaign cannot be paused in its current status." }

{ "message": "Invalid schedule values" }

429 Too Many Requests

The request limit has been exceeded. Reduce request frequency.

{ "message": "Rate limit exceeded" }

500 Internal Server Error

An unexpected server error occurred. Contact support if the issue persists.

{ "message": "Internal Server Error - Please contact support for more information." }

502 Bad Gateway

The server received an invalid response. Retry the request.

{ "message": "Bad Gateway - Please retry the request." }

503 Service Unavailable

The service is temporarily unavailable. Try again later.

{ "message": "Service Unavailable - The service is temporarily unavailable. Try again later." }

504 Gateway Timeout

The server took too long to respond. Retry the request with exponential backoff.

{ "message": "Gateway Timeout - The server took too long to respond. Retry with exponential backoff." }

Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!