Skip to main content
POST
Read a tracking test report

Authorizations

x-api-key
string
header
required

A server-side Bily API key created under Settings > AI tools > Access keys. Select the intended workspace before creating it.

Headers

x-bily-organization-id
string

An organization ID returned by GET /context or GET /organizations. Omit it when a scoped key supplies the organization. Otherwise provide it when no organization is selected.

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
connectionKey
string
default:website

An exact key from tracking connections. Defaults to website.

since
string<date-time>

ISO timestamp within the last 120 minutes. Defaults to five minutes ago.

until
string<date-time>

Optional past ISO timestamp at or after since.

eventName
string

Exact event name without contact details.

eventId
string

Opaque event ID without contact details.

limit
integer
default:50

Maximum returned receipts.

Required range: 1 <= x <= 50
baselineKeys
string

Comma-separated baseline keys from test-baseline. At most 200 keys.

filter
string

Search retained event names and public scalar values.

Maximum string length: 256
email
string

Exact case-insensitive email match. Send only in the JSON body, never the URL.

Maximum string length: 254
params
object

Public scalar event parameters. Sensitive identity, credential and reserved keys are rejected.

Response

Request completed successfully.

The response is of type object.