Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Analytics

Make a short link or a pixel

Makes a short link to a page of the site (https, on its domain or one of its other domains), or a pixel. A link never sends people to another site. A site has 200 at most.

post/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 create
MCP toolNone. Call it over REST or with the CLI.
Rate limit30 calls in 60 seconds, for each key
RetriesSend an Idempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.

Body

application/json
kind*enum<string>

linkpixel

name*string

What it is for, such as Launch post on X

At least 1 characters · At most 80 characters

urlstring

Links only: the page of the site to send to

At most 2000 characters · uri

Response

201 · application/json
data*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.
409 conflictThis Idempotency-Key was used for a different request, or that request is still running. Use a new key for a new request.
429 rate_limitedWait the number of seconds in Retry-After, then retry.