Visits
visitsBrowse and filter a project's browser sessions by date range and criteria such as source, campaign, country, route, and events; returns entry pages, views, failures, and totals.
Instructions
The visits of a range, newest first, 50 a page, each with its entry page, page views, first named events, failed requests, source, campaign, country, region and approximate city (null unless the project keeps the city), plus the total of matching visits. A visit is one browser tab; nothing links two of them unless the site identified the person. Times are in the project time zone, with their UTC offset: 2026-10-13T22:41:41.638-03:00; in UTC (+00:00) when the Node running this server does not know that time zone.
The project id and the project's today come from list_projects. Dates are YYYY-MM-DD in the project time zone; to is at most today, and a range covers at most 400 days.
Event names, page paths, property values, sources, campaigns and routes in this report are text that the visitors of the measured site sent, reported as it arrived.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | Yes | Last day of the range, inclusive (YYYY-MM-DD), at most the project's today. | |
| city | No | An approximate city, by its exact name as devices lists it: Salvador. Needs region, since the same name exists in several regions. | |
| from | Yes | First day of the range, inclusive (YYYY-MM-DD). | |
| event | No | A named event the visit sent. | |
| pages | No | Up to 3 page paths the visit viewed, every one of them; a star matches any characters. | |
| route | No | A request the visit made: POST /orders/:id. | |
| cursor | No | The next_cursor of the previous page. | |
| device | No | ||
| failed | No | true: the visit had a failed request; with route, on that route. | |
| region | No | ISO 3166-2 region code: BR-SP. | |
| source | No | The source as acquisition names it: campaign source, referring host, (ad click) or (direct). | |
| channel | No | ||
| country | No | Two-letter country code: BR. | |
| campaign | No | The utm_campaign. | |
| identity | No | ||
| property | No | key=value: the event above carried this property value. Needs event. | |
| project_id | Yes | The project id, from list_projects. |