API reference / Analytics
Record a goal
Records a goal from a server for a visitor that the site already saw. Examples are a sign-up that an email confirmed, or a plan that a customer bought offline. It counts for the latest visit of that visitor: its source, page and place.
post
/api/v1/analytics/goalsOther ways to call it
CLI
troopy analytics goals trackMCP toolNone. Call it over REST or with the CLI.
Rate limit600 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/jsonvisitor*stringThe visitor's id, as the script or SDK sent it
name*stringLowercase letters, digits, _ - and :
paramsobject10 at most. Troopy keeps them as text
Response
201 · application/jsondata*object1 properties
at*stringISO 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.