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 chart notes

The period's notes on the analytics chart, oldest first. They are what people and teammates wrote, and the commits that Troopy synced from the repo of the site. kind keeps only notes or only commits.

get/api/v1/analytics/notes

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 notes list
MCP tooltroopy_list_analytics_notes
Rate limit120 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

kindenum<string>

allnotescommitsmentions

Default "all"

Response

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

A 24-character id

text*string
at*string

ISO 8601 date and time

author*object
2 properties
type*enum<string>

personagentapigithubxreddit

name*string
commit*object | null

A commit that Troopy synced from GitHub. null for a note that someone wrote

6 properties
sha*string
repo*string
branch*string
url*string
additions*integer
deletions*integer
mention*object | null

For a post on X or Reddit that named the site. null for the other notes

5 properties
platform*enum<string>

xreddit

url*string
where*string | null

The subreddit, for Reddit

score*integer

Likes on X, upvotes on Reddit

comments*integer

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.