Skip to main content
GET
Get top pages by sessions or visitors, optionally restricted to entry or exit pages
Returns the most-visited pages, ranked by visits, with unique visitor counts. Use limit and offset for pagination.

Authorizations

Authorization
string
header
required

Workspace API key (e.g. formo_xxx). Create one in the Formo dashboard under Team Settings > API.

Query Parameters

date_from
string<date>

Inclusive start date (YYYY-MM-DD). Defaults to 7 days before date_to.

date_to
string<date>

Inclusive end date (YYYY-MM-DD). Defaults to today.

limit
integer
default:50

Maximum results to return (default 50, max 1000)

Required range: 1 <= x <= 1000
offset
integer
default:0

Number of results to skip for pagination (default 0)

Required range: 0 <= x <= 100000
mode
enum<string>
default:all

Page-flow mode. all (default) returns project-wide page metrics with anon-per-session visitor counts (sessions, visitors, hits). entry returns landing pages with bounce_rate. exit returns exit pages with exit_rate. The visitor count is omitted in entry/exit modes since those metrics are session-scoped.

Available options:
all,
entry,
exit

Response

Top pages

Analytics endpoint response. The data array contains the rows; the exact row shape depends on the endpoint. meta carries column type information for rendering, rows is the row count, and statistics holds query timing metadata.

data
object[]
meta
object[]
rows
integer
rows_before_limit_at_least
integer
statistics
object