API reference / Analytics
Identify a visitor
Says who a visitor is, from a server: a user id, a name, an image and traits. Troopy merges them into what identify said before. The same user id on another device links the two devices.
post
/api/v1/analytics/visitors/{visitor}/identifyOther ways to call it
CLI
troopy analytics visitors identifyMCP 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.Path parameters
visitor*stringThe visitor's id, as the script or SDK sent it
Body
application/jsonuserId*stringAt least 1 characters · At most 200 characters
namestring | nullimagestring | nulltraitsobject10 at most. Troopy keeps them as text
Response
200 · application/jsondata*object1 properties
identified*trueErrors
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.
404 not_foundCheck the path and any id in it. Every operation is listed in /api/v1/openapi.json.
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.