Get sequence performance analytics

Returns workspace-wide sequence analytics for the requested lookback window.

GET

https://api.channelautomation.com/api/workspaces/{workspaceId}/sequence-analytics

Authorization

ApiKeyAuth
optional
API key in header

BearerAuth
optional
HTTP Bearer (JWT)

Path parameters

workspaceId
string
required
Workspace ID.

Query parameters

days
optional
integer
Number of days to include.

default: 30
timeframe
optional
string
Legacy timeframe string. Used only when days is not provided.

Returns

200

Sequence analytics returned successfully.

400

Invalid analytics request.

401

Authentication required

JSON

error
optional
string
success
optional
boolean

500

Internal server error

JSON

error
optional
string
details
optional
string
success
optional
boolean

504

Analytics query timed out.

Get sequence performance analytics

curl --request GET \
  --url 'https://api.channelautomation.com/api/workspaces/<workspaceId>/sequence-analytics' \
  --header 'X-API-Key: <X-API-Key>'

const url = 'https://api.channelautomation.com/api/workspaces/<workspaceId>/sequence-analytics';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/workspaces/<workspaceId>/sequence-analytics"

headers = {"X-API-Key": "<X-API-Key>"}

response = requests.get(url, headers=headers)

print(response.text)

Response example

{
  "error": "Authentication required",
  "success": false
}

{
  "error": "Internal server error",
  "details": "string",
  "success": false
}