Get statistics overview
curl --request GET \
--url https://api.h0p.co/stats/overview \
--header 'x-api-key: <api-key>'import requests
url = "https://api.h0p.co/stats/overview"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.h0p.co/stats/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.h0p.co/stats/overview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.h0p.co/stats/overview"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.h0p.co/stats/overview")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.h0p.co/stats/overview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"group": "United States",
"count": 1247
},
{
"group": "United Kingdom",
"count": 892
},
{
"group": "Canada",
"count": 654
}
],
"totalClicks": 5234
}{
"code": "VALIDATION_ERROR",
"message": "The provided slug is already in use"
}{
"code": "VALIDATION_ERROR",
"message": "The provided slug is already in use"
}Statistics
Get statistics overview
Retrieve analytics grouped by dimension (country, device, browser, etc.). Filter by short links, domains, folders, or tags.
Multiple dimensions available: Geographic (city, region, country, continent), Technology (device, browser, os, lang), Traffic (referer, UTM params), Other (qrCode, destination, shortLinks)
GET
/
stats
/
overview
Get statistics overview
curl --request GET \
--url https://api.h0p.co/stats/overview \
--header 'x-api-key: <api-key>'import requests
url = "https://api.h0p.co/stats/overview"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.h0p.co/stats/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.h0p.co/stats/overview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.h0p.co/stats/overview"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.h0p.co/stats/overview")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.h0p.co/stats/overview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"group": "United States",
"count": 1247
},
{
"group": "United Kingdom",
"count": 892
},
{
"group": "Canada",
"count": 654
}
],
"totalClicks": 5234
}{
"code": "VALIDATION_ERROR",
"message": "The provided slug is already in use"
}{
"code": "VALIDATION_ERROR",
"message": "The provided slug is already in use"
}Authorizations
API Key authentication for programmatic access.
How to use:
- Create an API key from your dashboard settings
- Include the key in the
x-api-keyheader with each request - 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
Filter by specific short link UUIDs
Example:
["01933eb8-541f-7000-a9f4-e4eee80ff04e"]
Filter by domain UUIDs
Example:
["01933eb8-541f-7000-a9f4-e4eee80ff04e"]
Filter by folder UUIDs
Example:
["01933eb8-541f-7000-a9f4-e4eee80ff04e"]
Filter by tag UUIDs
Example:
["01933eb8-541f-7000-a9f4-e4eee80ff04e"]
Start date for analytics range
Example:
"2024-01-01T00:00:00Z"
End date for analytics range
Example:
"2024-01-31T23:59:59Z"
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 of results
Required range:
1 <= x <= 20Example:
10