API reference / Analytics
Create an alert
Emails the caller when a visitor completes a goal, a payment arrives or a free trial starts. The email says who did it and how they came. A site has 25 alerts at most, and each alert sends 60 emails an hour at most.
post
/api/v1/analytics/alertsOther ways to call it
CLI
troopy analytics alerts createMCP 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/jsonname*stringAt least 1 characters · At most 100 characters
trigger*objectA goal by name, any payment, or the start of a free trial
2 properties
type*"goal"goal*stringLowercase letters, digits, _ - and :
subjectstring | nullThe subject of the email. Without it, the email has a plain subject
messagestring | nullThe first line of the email. The details of the visitor follow it
enabledbooleanResponse
201 · application/jsondata*object11 properties
id*stringA 24-character id
name*stringtrigger*object2 properties
type*enum<string>goalpaymentfree_trial
goal*string | nullsubject*string | nullmessage*string | nullenabled*booleanto*stringWho it emails: the person who made it (a user id)
count*integerTimes it fired
lastAt*string | nulllastError*string | nullcreatedAt*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.