Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Analytics

List the sites of the organization

The site of each workspace of the organization, with its visitors, pageviews and revenue of the period, most visitors first. change compares the visitors with the window before. Revenue is in minor units of the currency of each site. Owners and admins only. Filters stay out, because each site has its own pages.

get/api/v1/analytics/sites

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.

Other ways to call it

CLItroopy analytics sites
MCP tooltroopy_list_analytics_sites
Rate limit30 calls in 60 seconds, for each key

Query parameters

periodenum<string>

now is the last 10 minutes. 7d and 30d end today. 3m, 6m and 12m are whole months that end with this month. week starts on Monday. custom needs from and to

nowtodayyesterday24h7d30d3m6m12mweekmonthyearallcustom

Default "30d"

fromstring

YYYY-MM-DD, in the workspace's time zone

date

tostring

YYYY-MM-DD. The period includes this day

date

Response

200 · application/json
data*array<object>
8 properties
workspaceId*string

A 24-character id

name*string
domain*string
visitors*integer
pageviews*integer
revenue*number
currency*string
change*number | null

The change of visitors, as a share: 0.12 is 12% more

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.
429 rate_limitedWait the number of seconds in Retry-After, then retry.