API reference / Analytics
Change AI crawler settings
excluded lists the crawlers that Troopy does not record: Company::Agent, or Company::* for all the crawlers of a company. The new list replaces the old list. requireToken rejects requests without the bot token. It needs a token first. verifiedOnly leaves out a crawl from outside the published IP ranges of its company. hidden takes the card of AI crawlers off the dashboard.
/api/v1/analytics/crawlersOther ways to call it
troopy analytics crawlers updateIdempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.Body
application/jsonexcludedarray<string>At most 100 items
requireTokenbooleanverifiedOnlybooleanhiddenbooleanResponse
200 · application/jsondata*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*boolean