Crawlsight

REST API

Every report and export over HTTPS with an API key.

Base URL: https://crawlsight.dev/api/v1

Create a key in Settings > API keys and send it as a bearer token:

curl -H "Authorization: Bearer aak_..." https://crawlsight.dev/api/v1/sites

Sites

GET /sites

Your sites.

POST /sites

{ "name": "My store", "origin": "https://shop.example.com", "catalogue_size": 250 }

Returns the new site with AA_SITE_ID and AA_SECRET.

Reports

All take range (24h, 7d, 30d, 90d, default 7d) or since (an ISO time).

EndpointReturns
GET /sites/:id/summaryTotals by verdict, revenue, time series, top agents, countries.
GET /sites/:id/visits?limit=300Visits, newest first, with verdict, score, signals, pages and order. Up to 5,000.
GET /sites/:id/funnelEach kind of visitor with visits, purchases, revenue and furthest stage.
GET /sites/:id/scrapersScraper clusters with their evidence.

Exports

GET /sites/:id/export?dataset=visits&format=csv&range=30d

dataset is one of visits, agents, scrapers, countries, summary. format is csv or json. Large files answer with a redirect to a download link that needs the same key.

Errors

401 with a hint when the key is missing or wrong, 404 when the site is not on your account, 400 for bad input.

On this page