Spoar
All projects

Where visitors went next, across projects

GET
/v2/paths

As the per-project route.

Authorization

AuthorizationBearer <token>

An API token from POST /v2/tokens (at_live_...), or a project's secret key (sk_...) for server-side ingest.

In: header

Query Parameters

from?string

Start of the range; send with to.

Formatdate-time
to?string

End of the range, exclusive.

Formatdate-time
period?string

A range ending at the start of today in UTC (24h ends at the start of this hour). Ignored when from and to are sent; 30d by default.

Value in

  • "24h"
  • "7d"
  • "30d"
  • "90d"
  • "12mo"
  • "all"
traffic?string

Which traffic is counted. human (the default) leaves out bot scores of 50 and up, your own visits and localhost; bots keeps only scores of 50 and up; internal keeps only your own visits; all keeps everything.

Value in

  • "human"
  • "bots"
  • "internal"
  • "all"
environment?string

production (the default) leaves preview deployments out, preview keeps only them, all keeps both.

Value in

  • "production"
  • "preview"
  • "all"
filter?

Sent as filter[<dimension>]=value, or !value to exclude; repeatable across dimensions.

page?string

The page path to start from; required.

Length1 <= length
direction?string

next (the default) lists the pages viewed right after page, previous the ones right before it.

Value in

  • "next"
  • "previous"
limit?|

Rows per page, 1 to 100 (default 20), or up to 1000 with format.

Range1 <= value <= 1000
cursor?string

The opaque nextCursor of the previous page.

Length1 <= length
format?string

Returns every row as one download instead of a page, up to 1,000,000 rows: csv with a header row and nested fields as dotted columns, json as the normal answer with all rows in data, sql as CREATE TABLE and INSERT statements for Postgres or SQLite. Accept: text/csv also asks for CSV.

Value in

  • "csv"
  • "json"
  • "sql"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v2/paths"
{  "data": [    {      "path": "/signup",      "count": 38,      "share": 0.304    },    {      "path": "/docs",      "count": 21,      "share": 0.168    },    {      "path": "/",      "count": 9,      "share": 0.072    }  ],  "page": "/pricing",  "direction": "next",  "views": 125,  "dropOff": {    "count": 57,    "share": 0.456  },  "total": 3,  "nextCursor": null,  "range": {    "from": "2026-08-31T00:00:00.000Z",    "to": "2026-09-28T00:00:00.000Z"  },  "traffic": "human",  "environment": "production",  "filters": {}}

One person across projects GET

Previous Page

Returning visitors by cohort, across projects GET

Next Page