Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Analytics

Get the AI crawler settings

The AI crawlers that Troopy records, and the last 4 characters of the site's bot token. It also gives whether Troopy rejects requests without the token.

get/api/v1/analytics/crawlers

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 crawlers
MCP tooltroopy_get_analytics_crawler_settings
Rate limit120 calls in 60 seconds, for each key

Response

200 · application/json
data*object
5 properties
token*object | null
2 properties
hint*string

The token's last 4 characters

createdAt*string

ISO 8601 date and time

requireToken*boolean

Troopy rejects requests without the token

verifiedOnly*boolean

Troopy 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*boolean

The dashboard leaves the card of AI crawlers out

catalog*array<object>
2 properties
company*string
agents*array<object>
6 properties
id*string

Company::Agent

agent*string
category*enum<string>

answersearchtrainingother

about*string

What the crawler does

verifiable*boolean

The company publishes its IP ranges

enabled*boolean

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.