Every integration sends events to the Rankly ingest API. You rarely call it directly (the integrations do it for you), but here is the full contract.

Base URL

https://ingest.tryrankly.com

Authentication

Every request carries your ingest token (tnt_...), in one of two ways:
  • As a query parameter: ?tenant=tnt_your_token
  • As a header (log-drain integrations): Authorization: Bearer tnt_your_token
The token only allows sending events. It cannot read your dashboard or change settings. Rotate it from Settings if it leaks.

Endpoints

Send events (per platform)

POST /ingest/{adapter}?tenant=tnt_your_token
{adapter} is your platform’s slug. The integration formats the body in that platform’s native log shape; Rankly normalizes it.
Adapter slugPlatform
cloudflare-workerCloudflare Worker
cloudfrontAWS CloudFront (via Firehose)
gcp-logsinkGoogle Cloud (via Pub/Sub)
fastlyFastly real-time logs
akamaiAkamai DataStream 2
vercelVercel middleware or Log Drain
netlifyNetlify edge function or Log Drain
nginx-agentnginx via Fluent Bit
customYour own code
Response
{
  "success": true,
  "data": { "accepted": 100, "stored": 95, "dropped": 5 }
}

Custom events

POST /ingest/custom?tenant=tnt_your_token
Content-Type: application/json
Body: one event object, or an array of event objects. See Custom integration for the accepted fields.

Batch backfill

POST /ingest/_batch?tenant=tnt_your_token
Content-Type: application/json
Body: { "events": [ ... ] }, up to 5,000 pre-normalized events per request. Use this to load historical data without sending one request per event.

Health check

GET /ingest/status
Returns { "status": "ok" }. Use it to confirm the endpoint is reachable from your network.

How events are processed

Each event runs through the same pipeline regardless of source:
1

Authenticate

The ingest token maps the event to your account.
2

Normalize

The adapter converts the platform’s log shape into Rankly’s event fields.
3

Filter by domain

Events for hosts you have not verified are dropped.
4

Classify and verify

Rankly names the agent, groups it by purpose, and verifies its identity.
5

Store

The event is saved and rolled into your dashboard within about a minute.