Skip to main content
POST
/
customer-journey
/
{storeUrl}
Get a customer journey
curl --request POST \
  --url https://app.bily.ai/api/customer/v1/customer-journey/{storeUrl} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "bilyId": "<string>",
  "dateFrom": "2023-12-25",
  "dateTo": "2023-12-25"
}
'
const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({bilyId: '<string>', dateFrom: '2023-12-25', dateTo: '2023-12-25'})
};

fetch('https://app.bily.ai/api/customer/v1/customer-journey/{storeUrl}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
import requests

url = "https://app.bily.ai/api/customer/v1/customer-journey/{storeUrl}"

payload = {
    "bilyId": "<string>",
    "dateFrom": "2023-12-25",
    "dateTo": "2023-12-25"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
{}
{
  "error": "Store not found",
  "requestId": "<string>",
  "details": "<unknown>",
  "retryAfter": "<string>"
}
{
  "error": "Store not found",
  "requestId": "<string>",
  "details": "<unknown>",
  "retryAfter": "<string>"
}
{
  "error": "Store not found",
  "requestId": "<string>",
  "details": "<unknown>",
  "retryAfter": "<string>"
}
{
  "error": "Store not found",
  "requestId": "<string>",
  "details": "<unknown>",
  "retryAfter": "<string>"
}
{
  "error": "Store not found",
  "requestId": "<string>",
  "details": "<unknown>",
  "retryAfter": "<string>"
}
{
  "error": "Store not found",
  "requestId": "<string>",
  "details": "<unknown>",
  "retryAfter": "<string>"
}
{
  "error": "Store not found",
  "requestId": "<string>",
  "details": "<unknown>",
  "retryAfter": "<string>"
}

Authorizations

​
x-api-key
string
header
required

A server-side Bily API key created under Settings > MCP > Access key fallback. Select the intended store before creating it.

Headers

​
x-bily-organization-id
string

An organization ID returned by GET /context or GET /organizations. Required for GET /stores and optional for store-scoped paths.

Example:

"org_01J8W7T9G3E6ZQ4M2K5N8P1R0S"

Path Parameters

​
storeUrl
string
required

The exact store URL returned by GET /context or GET /stores.

Example:

"store.example.com"

Body

application/json
​
bilyId
string
required

The Bily customer identifier whose journey you want to read.

Minimum string length: 1
​
dateFrom
string<date>
required

First date to include, in YYYY-MM-DD format.

​
dateTo
string<date>
required

Last date to include, in YYYY-MM-DD format.

Response

The ordered customer journey report.

An ordered customer journey or touchpoint report.