Get Top Locations - Formo Docs

Get top countries / regions / cities

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": "visits",
      "type": "UInt64"
    },
    {
      "name": "users",
      "type": "UInt64"
    },
    {
      "name": "hits",
      "type": "UInt64"
    }
  ],
  "data": [
    {
      "project_id": "proj_abc",
      "location": "US",
      "visits": 482,
      "users": 387,
      "hits": 824
    },
    {
      "project_id": "proj_abc",
      "location": "GB",
      "visits": 184,
      "users": 156,
      "hits": 312
    },
    {
      "project_id": "proj_abc",
      "location": "DE",
      "visits": 142,
      "users": 124,
      "hits": 268
    },
    {
      "project_id": "proj_abc",
      "location": "JP",
      "visits": 98,
      "users": 86,
      "hits": 187
    }
  ],
  "rows": 4,
  "rows_before_limit_at_least": 32
}

GET

top_locations

Get top countries / regions / cities

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": "visits",
      "type": "UInt64"
    },
    {
      "name": "users",
      "type": "UInt64"
    },
    {
      "name": "hits",
      "type": "UInt64"
    }
  ],
  "data": [
    {
      "project_id": "proj_abc",
      "location": "US",
      "visits": 482,
      "users": 387,
      "hits": 824
    },
    {
      "project_id": "proj_abc",
      "location": "GB",
      "visits": 184,
      "users": 156,
      "hits": 312
    },
    {
      "project_id": "proj_abc",
      "location": "DE",
      "visits": 142,
      "users": 124,
      "hits": 268
    },
    {
      "project_id": "proj_abc",
      "location": "JP",
      "visits": 98,
      "users": 86,
      "hits": 187
    }
  ],
  "rows": 4,
  "rows_before_limit_at_least": 32
}

Returns the top geographic locations of visitors over the selected window.

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 locations

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[]