Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Analytics

List short links and pixels

The short links and the pixels of the site, newest first, each with its hits in the period. hits counts every click or open, and visitors counts each person one time a day. A link sends a visitor on to a page of the site with ref=<slug>, so the visit shows where it came from. A pixel counts the opens of an email, or the views of a page with no script.

get/api/v1/analytics/links

Authorization

HeaderAuthorization: Bearer <API key>
Or the headerX-API-Key: <API key>
API keyMake one in Troopy under Settings > API keys. It acts as you, in its workspace.

Other ways to call it

CLItroopy analytics links list
MCP tooltroopy_list_analytics_links
Rate limit60 calls in 60 seconds, for each key

Query parameters

periodenum<string>

now is the last 10 minutes. 7d and 30d end today. 3m, 6m and 12m are whole months that end with this month. week starts on Monday. custom needs from and to

nowtodayyesterday24h7d30d3m6m12mweekmonthyearallcustom

Default "30d"

fromstring

YYYY-MM-DD, in the workspace's time zone

date

tostring

YYYY-MM-DD. The period includes this day

date

Response

200 · application/json
data*array<object>
8 properties
id*string

A 24-character id

kind*enum<string>

linkpixel

name*string
url*string | null

Links only: the page of the site

short*string

The address to share: the link, or the image of the pixel

hits*integer

Clicks or opens in the period

visitors*integer

People in the period, each one time a day

createdAt*string

ISO 8601 date and time

Errors

400 invalid_inputFix the field named in detail. Each operation's schema is in /api/v1/openapi.json.
401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask an organization owner or admin.
429 rate_limitedWait the number of seconds in Retry-After, then retry.