Skip to main content
GET
/
stats
/
overview
Get statistics overview
curl --request GET \
  --url https://api.h0p.co/stats/overview \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "group": "United States",
      "count": 1247
    },
    {
      "group": "United Kingdom",
      "count": 892
    },
    {
      "group": "Canada",
      "count": 654
    }
  ],
  "totalClicks": 5234
}

Authorizations

​
x-api-key
string
header
required

API Key authentication for programmatic access.

How to use:

  1. Create an API key from your dashboard settings
  2. Include the key in the x-api-key header with each request
  3. API keys have granular permissions (domains, shortLinks, files, stats, apiKeys)

Example:

curl -H "x-api-key: your-api-key-here" https://api.h0p.co/short-link/list

Types of API keys:

  • User keys: Linked to your user account (one per organization)
  • Bot keys: Autonomous machine users (one per organization)

Security notes:

  • Keep your API keys secure and never commit them to version control
  • API keys cannot access authentication endpoints (/auth/*)
  • Keys can be revoked at any time from the dashboard

Query Parameters

​
shortLinkIds
array

Filter by specific short link UUIDs

Example:
["01933eb8-541f-7000-a9f4-e4eee80ff04e"]
​
domainIds
array

Filter by domain UUIDs

Example:
["01933eb8-541f-7000-a9f4-e4eee80ff04e"]
​
folderIds
array

Filter by folder UUIDs

Example:
["01933eb8-541f-7000-a9f4-e4eee80ff04e"]
​
tagIds
array

Filter by tag UUIDs

Example:
["01933eb8-541f-7000-a9f4-e4eee80ff04e"]
​
startDate
string<date-time> | null

Start date for analytics range

Example:

"2024-01-01T00:00:00Z"

​
endDate
string<date-time> | null

End date for analytics range

Example:

"2024-01-31T23:59:59Z"

​
groupBy
enum<string>
required

Dimension to group results by

Available options:
city,
region,
country,
continent,
lang,
device,
browser,
os,
referer,
utmSource,
utmMedium,
utmCampaign,
utmTerm,
utmContent,
qrCode,
destination,
shortLinks,
uniqueVisitors
Example:

"country"

​
limit
number

Limit number of results

Required range: 1 <= x <= 20
Example:

10

Response

Statistics overview retrieved successfully

Statistics overview response

​
data
object[]
required

Array of statistics grouped by dimension

​
totalClicks
number
required

Total clicks across all groups

Required range: x >= 0
Example:

5234