Skip to main content
GET
/
v0
/
top_locations
Get top countries
curl --request GET \
  --url https://api.formo.so/v0/top_locations \
  --header 'Authorization: Bearer <token>'
{
  "meta": [
    {
      "name": "project_id",
      "type": "String"
    },
    {
      "name": "location",
      "type": "String"
    },
    {
      "name": "sessions",
      "type": "UInt64"
    },
    {
      "name": "visitors",
      "type": "UInt64"
    },
    {
      "name": "hits",
      "type": "UInt64"
    }
  ],
  "data": [
    {
      "project_id": "proj_abc",
      "location": "US",
      "sessions": 482,
      "visitors": 387,
      "hits": 824
    },
    {
      "project_id": "proj_abc",
      "location": "GB",
      "sessions": 184,
      "visitors": 156,
      "hits": 312
    },
    {
      "project_id": "proj_abc",
      "location": "DE",
      "sessions": 142,
      "visitors": 124,
      "hits": 268
    },
    {
      "project_id": "proj_abc",
      "location": "JP",
      "sessions": 98,
      "visitors": 86,
      "hits": 187
    }
  ],
  "rows": 4,
  "rows_before_limit_at_least": 32
}
Returns the top countries of visitors over the selected window. The location field is an ISO 3166-1 alpha-2 country code (for example, US, GB, DE).

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

Response

Top countries

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