API reference / Analytics
List funnels
The workspace's funnels, oldest first: each with a name and its 2 to 8 steps. Get one for its numbers.
get
/api/v1/analytics/funnelsOther ways to call it
CLI
troopy analytics funnels listMCP tool
troopy_list_analytics_funnelsRate limit120 calls in 60 seconds, for each key
Response
200 · application/jsondata*array<object>6 properties
id*stringA 24-character id
name*stringsteps*array<object>6 properties
kind*enum<string>pagegoal
value*stringA path like /pricing, or a goal's name
At least 1 characters · At most 200 characters
match*enum<string>Pages only: how the path matches
exactstarts_withcontains
Default "exact"
hostname*string | nullPages only: on this hostname alone
Default null
completed*booleanGoals only: false counts visitors who did not complete it after the step before
Default true
property*object | nullGoals only: the goal counts only when it has this property, such as plan pro
Default null
2 properties
name*stringvalue*stringAt least 1 characters · At most 255 characters
hours*integer | nullThe visitor completes every step within this many hours of the first. Null: any time in the period
strict*booleantrue: no other page between two steps
createdAt*stringISO 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.