Skip to main content
GET
Read a live traffic snapshot

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"

Query Parameters

snapshotMinutesBack
integer
default:30

Snapshot lookback in minutes.

Required range: 1 <= x <= 120
activeMinutesBack
integer
default:15

Active visitor lookback in minutes.

Required range: 1 <= x <= 60
topVisitors
integer
default:10

Maximum top visitors.

Required range: 1 <= x <= 20
sessionLimit
integer
default:50

Maximum sessions.

Required range: 1 <= x <= 100

Response

Request completed successfully.

The response is of type object.