API reference / Analytics
Make a new bot token
Makes a new bot token that the site's server sends with crawls (Authorization: Bearer tpbot_...). The answer shows the token this one time only. The old token stops at once. Owners and admins.
post
/api/v1/analytics/crawlers/tokenOther ways to call it
CLI
troopy analytics crawlers tokenMCP toolNone. Call it over REST or with the CLI.
Rate limit10 calls in 60 seconds, for each key
Response
201 · application/jsondata*object2 properties
token*stringTroopy shows it one time only
settings*object5 properties
token*object | null2 properties
hint*stringThe token's last 4 characters
createdAt*stringISO 8601 date and time
requireToken*booleanTroopy rejects requests without the token
verifiedOnly*booleanTroopy leaves out a crawl from outside the published IP ranges of its company. When false, such a crawl counts as unverified, by its user agent alone
hidden*booleanThe dashboard leaves the card of AI crawlers out
catalog*array<object>2 properties
company*stringagents*array<object>6 properties
id*stringCompany::Agent
agent*stringcategory*enum<string>answersearchtrainingother
about*stringWhat the crawler does
verifiable*booleanThe company publishes its IP ranges
enabled*booleanErrors
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.