Skip to main content
TroopyDocs
GuidesSet up and use TroopyAppsConnect your servicesAPIThe API, the CLI and MCPChangelogEach update to Troopy

Developers

Account

Troop

Skills

Tasks and projects

Needs you

Routines and triggers

Brain

Docs

Canvas

Email

CRM

Outreach

Customers

Analytics

Sessions

Surveys

Support Agent

Tests and incidents

Disputes

Apps

Vault

Computer

Open Troopy
Troopy

API reference / Analytics

List alerts

The site's email alerts, oldest first: what fires each (a goal, a payment, a free trial), whether it's on, and how often it fired.

get/api/v1/analytics/alerts

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.
Scopesanalytics:read

Other ways to call it

CLItroopy analytics alerts list
MCP tooltroopy_list_analytics_alerts
Rate limit120 calls in 60 seconds, for each key

Response

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

A 24-character id

name*string
trigger*object
2 properties
type*enum<string>

goalpaymentfree_trial

goal*string | null
subject*string | null
message*string | null
enabled*boolean
to*string

Who it emails: the person who made it (a user id)

count*integer

Times it fired

lastAt*string | null
lastError*string | null
createdAt*string

ISO 8601 date and time

Errors

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.