Summary

Returns aggregate analytics metrics for the authenticated workspace, including total links, total scans, active links in the last 30 days, and the number of unique countries your links have been scanned from.

GET /v1/analytics/summary

analytics:read

Parameters

Query parameters

Parameter	Type	Required	Default	Description
period	string	No	30d	Time period to aggregate: 7d, 30d, 90d, or all.

Request examples

curl

curl "https://xqr.co/api/v1/analytics/summary?period=30d" \
  -H "Authorization: Bearer YOUR_API_KEY"

TypeScript

const params = new URLSearchParams({ period: "30d" });

const res = await fetch(
  `https://xqr.co/api/v1/analytics/summary?${params}`,
  {
    headers: {
      Authorization: "Bearer YOUR_API_KEY",
    },
  }
);

const { data, meta } = await res.json();

Python

import httpx

res = httpx.get(
    "https://xqr.co/api/v1/analytics/summary",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    params={"period": "30d"},
)

summary = res.json()["data"]

Response

200 OK

{
  "data": {
    "total_links": 142,
    "total_scans": 28450,
    "active_links_30d": 87,
    "unique_countries": 34
  },
  "meta": {
    "request_id": "req_a1b2c3",
    "rate_limit": {
      "remaining": 95,
      "reset_at": "2026-03-21T12:01:00Z"
    }
  }
}