Browse developer documentation
Live visitors
attriboo reports realtime
Read visitors active in the last five minutes.
Access: OAuth analytics:read or workspace key
Options
| Field | Type | Description |
|---|---|---|
--site | string | Website ID or domain from sites list. |
--filters | string | JSON array string of up to twenty visitor filters, for example [{"dim":"country","op":"is","value":"US"}]. Dimensions: source, channel, campaign, entry_page, page, hostname, country, device, browser, os, goal. Operators: is, is_not. Values are exact strings up to 500 characters. All filters must match the visitor across available history; report dates then select activity for that cohort. Unmatched payments are excluded. Crawler counts remain website-wide; spend requires every filter to be source/channel/campaign. Preserve filters when paging. |
--limit | integer | Maximum rows where supported. Default: |
--cursor | string | A returned next_cursor. Keep the same website, report, dates, model, visitor filters and funnel selection. |
--json | boolean | Compact JSON instead of formatted JSON. |
--csv | boolean | CSV for the main row collection; nested values remain JSON cells. Cannot be combined with --json. |
Read live visitors
Replace example websites, dates and cursor values with your own. Running these commands makes real requests or changes the local session.
attriboo reports realtime --site shop.example.com --jsonExample output
{"site":{"id":"site_example","domain":"shop.example.com","currency":"USD"},"window_minutes":5,"live_visitors":1,"visitors":[{"visitor_id":"v_example","country_code":"US","city":"New York","source":"Google Organic","page":"/pricing","device":"Desktop","seconds_ago":12}]}Output fields
| Field | Type | Description |
|---|---|---|
site | object | Website ID, domain and currency. |
window_minutes | integer | Fixed five-minute live window. |
live_visitors | integer | Total live visitors, including later pages. |
visitors | array | Report records. See the fields below. |
next_cursor | string | null | When provided, pass this value to continue; null means the last page. Some small-site reports omit this field. |
coverage | object | When provided, describes completeness, snapshot time and row coverage. Row limits apply to this page, not to headline totals. |
site fields
| Field | Type | Description |
|---|---|---|
id | string | Website ID. |
domain | string | Website domain. |
currency | string | Three-letter currency. |
visitors[] fields
| Field | Type | Description |
|---|---|---|
visitor_id | string | Observed visitor ID. |
country_code | string | null | Country or null. |
city | string | null | City or null. |
source | string | Recorded source. |
page | string | Latest path. |
device | string | Device type. |
seconds_ago | integer | Seconds since last activity. |
The data follows the live visitors API contract. CLI JSON omits the REST envelope.
Behavior and limits
Money is integer cents in site.currency. Percentages use a 0–100 scale.
This is a fixed five-minute live window. period=realtime on other reports instead selects the last 30 minutes.
Continuation pages retain the original live window. Reload the first page for a fresh current window.
CLI JSON output is the API data object directly, without the REST status/data envelope. Default output is formatted JSON; --json is compact JSON.
CSV contains only the returned page's main row collection. Continue using returned next_cursor values rather than assuming a single CSV is a complete export.