Journeys

Read the complete routes visitors took, page by page, with visits, buyers and linked purchase value for each route.

GET/api/v1/stats/journeys

Access: Workspace key or OAuth analytics:read · Permission details

Query parameters

Query parameters
Field	Type	Description
`site`	`string`	Website ID or domain. Required when the workspace has more than one website.
`period`	`string`	Saved website timezone calendar selection. from and to override period. Values: realtime, today, yesterday, 7d, 30d, 90d, 12m, wtd, mtd, qtd, ytd, all. Default: `30d`.
`from`	`string`	Inclusive website-local start date. Supply to as well.
`to`	`string`	Inclusive website-local end date. Supply from as well.
`compare`	`string`	Comparison range. Values: previous_period, mom, qoq, yoy, none. Default: `previous_period`.
`model`	`string`	Which visit gets credit for a sale, the same six rules as the dashboard's Credit menu. Values: first_touch, last_touch, last_non_direct, u_shaped, linear, time_decay. Default: `first_touch`.
`lookback`	`string`	How far back before each sale visits can get credit. Older visits get no credit; if none fall inside the window, the latest recorded visit keeps it. Larger-site database reports, visitor filters and cursors only accept all. Values: all, 90d, 30d, 7d. Default: `all`.
`filters`	`string`	URL-encoded JSON array 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`	Row limit for reports that support it. Default: `50`.
`cursor`	`string`	Opaque next_cursor from the previous page. Preserve the original website, report, dates, model and funnel selection. Never construct a cursor.
`journey_channel`	`string`	Only visits whose first recorded entry came from this channel, for example AI Referral.
`journey_source`	`string`	Only visits from this source, for example ChatGPT.
`start_page`	`string`	Only visits that started on this path, for example /pricing.
`outcome`	`string`	Keep visits with a new purchase, a goal, an outbound click, or without a purchase. Values: all, purchased, goal, outbound, no-purchase. Default: `all`.
`include_goals`	`string`	true adds recorded goals as steps. Values: true, false. Default: `false`.
`rank`	`string`	Order paths by visits or by linked purchase value. Values: visits, purchase_value. Default: `visits`.

Request examples

Examples run from your server or terminal. Configure ATTRIBOO_TOKEN privately for authenticated requests. Replace example website IDs and values with your own. The examples make real requests when you run them.

cURL request

curl "https://www.attriboo.com/api/v1/stats/journeys?site=site_example&from=2026-10-01&to=2026-10-07&compare=none" \
  -H "Authorization: Bearer $ATTRIBOO_TOKEN"

Response

Illustrative response. Fields below are inside the data object. Optional coverage, notes and continuation fields vary by report.

Response fields
Field	Type	Description
`site`	`object`	Website ID, domain and currency.
`period`	`object`	Selected dates as UTC timestamps; to is exclusive.
`totals`	`object`	visits, visitors, buyers, new_purchases and linked_value across every matching route.
`unlinked_purchases`	`integer`	New purchases with no recorded visit to link to.
`paths`	`array`	Matching routes, ranked by rank.
`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.
`notes`	`string`	How journeys are counted.

`site` fields

site nested fields
Field	Type	Description
`id`	`string`	Website ID.
`domain`	`string`	Website domain.
`currency`	`string`	Three-letter currency.

`period` fields

period nested fields
Field	Type	Description
`from`	`string`	Inclusive UTC start.
`to`	`string`	Exclusive UTC end.
`label`	`string`	Human-readable date selection.
`timezone`	`string`	Saved website timezone.

`paths[]` fields

paths nested fields
Field	Type	Description
`steps`	`array`	The route in order: kind (page, goal, outbound, purchase, end or more) and label.
`step_count`	`integer`	Steps in the full route; steps can be shorter for very long routes.
`visits`	`integer`	Visits that took this route.
`visitors`	`integer`	Distinct visitors.
`buyers`	`integer`	Visitors with a linked new purchase.
`new_purchases`	`integer`	Linked new purchases.
`linked_value`	`integer`	Value of linked new purchases, cents. Excludes refunds and renewals.

JSON response

{
  "status": "success",
  "data": {
    "site": {
      "id": "site_example",
      "domain": "shop.example.com",
      "currency": "USD"
    },
    "period": {
      "from": "2026-10-01T00:00:00.000Z",
      "to": "2026-10-08T00:00:00.000Z",
      "label": "Custom",
      "timezone": "UTC"
    },
    "totals": {
      "visits": 40,
      "visitors": 31,
      "buyers": 2,
      "new_purchases": 2,
      "linked_value": 39800
    },
    "unlinked_purchases": 0,
    "paths": [
      {
        "steps": [
          {
            "kind": "page",
            "label": "/pricing"
          },
          {
            "kind": "page",
            "label": "/checkout"
          },
          {
            "kind": "purchase",
            "label": "Purchase"
          }
        ],
        "step_count": 3,
        "visits": 4,
        "visitors": 4,
        "buyers": 2,
        "new_purchases": 2,
        "linked_value": 39800
      }
    ],
    "notes": "A visit ends after 30 minutes without activity."
  }
}

Behavior and limits

Money is integer cents in site.currency. Percentages use a 0–100 scale.

Matches Journeys & Funnels → Recorded paths. A visit ends after 30 minutes without activity.

Journeys follow visits, not revenue credit, so model and lookback do not change them. linked_value is not source revenue credit.

Larger sites use the database journey calculation and return next_cursor; keep the same website, dates and journey filters when continuing.

Errors and retries Pagination and completeness OpenAPI JSON