Endpoint
GET/analytics/geo/regions
Développeurs
APIs that can be used to work with State programmatically
APIs that can be used to work with State programmatically
This API method returns regions grouped by country and region, sorted by click count in descending order.
Authorization required.
All parameters are optional. By default, it returns clicks from the last 30 days, with results paginated.
| Parameter | Description |
|---|---|
| link_id | Exact match |
| period | today, yesterday, week, lastweek, month, lastmonth, year, all, or a custom range, period=YYYY-MM-DD,YYYY-MM-DD, i.e. period=2025-10-01,2025-10-13 |
| domain_id | filter by domain id. You can get a list of available domains from Domains API |
| folder_id | filter by folder id. You can get IDs from Folders API |
| tag_id | filter by tag id. You can get IDs from Tags API |
| search | Case-insensitive string to match anywhere in the URL, or short link |
| country | Two-letter uppercase country code |
| city | City name in English (exact match) |
| region | Region name in English (exact match) |
| continent | Continent name in English (exact match) |
| browser | Browser name |
| os | Operating system |
| device | Device type |
| page | the page number for pagination, default 0 |
| limit | the number of items per page. default 25. available values: 10,25,50,75,100 |
Available values for country, city, region, continent, browser, os, and device can be retrieved via a dedicated API.
curl https://state.sk/api/analytics/geo/regions \
-H 'x-api-key: state_xxxxxxxxxx'
The response returns paginated regions grouped by country and region, sorted by click count.
both country and region could be null if not available
{
"items": [
{
"title": null,
"country": null,
"clicks": 9
},
{
"title": null,
"country": "US",
"clicks": 9
},
{
"title": "Shanghai",
"country": "CN",
"clicks": 2
},
{
"title": "Florida",
"country": "US",
"clicks": 1
}
],
"total": 4,
"limit": 25,
"offset": 0
}