Skip to main content
GET
/
v0
/
top_pages
Get top pages by visits or users, optionally restricted to entry or exit pages
curl --request GET \
  --url https://api.formo.so/v0/top_pages \
  --header 'Authorization: Bearer <token>'
{
  "meta": [
    {
      "name": "project_id",
      "type": "String"
    },
    {
      "name": "origin",
      "type": "String"
    },
    {
      "name": "pathname",
      "type": "String"
    },
    {
      "name": "visits",
      "type": "UInt64"
    },
    {
      "name": "users",
      "type": "UInt64"
    },
    {
      "name": "hits",
      "type": "UInt64"
    }
  ],
  "data": [
    {
      "project_id": "proj_abc",
      "origin": "app.example.com",
      "pathname": "/",
      "visits": 1284,
      "users": 982,
      "hits": 1456
    },
    {
      "project_id": "proj_abc",
      "origin": "app.example.com",
      "pathname": "/trade",
      "visits": 612,
      "users": 487,
      "hits": 1024
    },
    {
      "project_id": "proj_abc",
      "origin": "app.example.com",
      "pathname": "/earn",
      "visits": 412,
      "users": 318,
      "hits": 587
    }
  ],
  "rows": 3,
  "rows_before_limit_at_least": 24
}
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 Keys.

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 identity-stitched user counts (visits, users, hits). entry returns landing pages with bounce_rate. exit returns exit pages with exit_rate. Identity stitching is skipped 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