Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Connections Icu Atlas API
version: 1.0.0
description: 'Operations tagged Atlas across 2 of this provider''s published API definitions: connections-icu-analytics-openapi-original.json, connections-icu-analytics-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://analytics.connectionsapi.com
tags:
- name: Atlas
paths:
/v1/atlas/traffic:
get:
summary: Atlas - traffic per plane (constellation admins only)
description: 'Every plane the fleet served in the window: requests, error rate, typical and worst latency, route count - with the ingest''s freshness verdict and the account-coverage line in the SAME response, so a self-refreshing page can never show a confident number from a dead feed. 401 without a credential, 403 for anyone who is not a constellation admin.'
security:
- ApiKeyAuth: []
parameters:
- name: window
in: query
required: false
schema:
type: string
enum:
- 1h
- 6h
- 24h
- 7d
default: 6h
description: How far back to read, ending at the ingest's delivery lag rather than at the clock.
responses:
'200':
description: '{ window, planes, freshness, coverage }'
'403':
description: Not a constellation admin.
tags:
- Atlas
operationId: getV1AtlasTraffic
x-operation-id-source: derived
servers:
- url: https://analytics.connectionsapi.com
/v1/atlas/slow:
get:
summary: Atlas - the slowest requests (constellation admins only)
description: The individual requests that took too long in the window, newest first, each with its plane, route key, redacted path, status, total and handler time. Filter to one plane with `plane`.
security:
- ApiKeyAuth: []
parameters:
- name: window
in: query
required: false
schema:
type: string
enum:
- 1h
- 6h
- 24h
- 7d
default: 6h
description: How far back to read, ending at the ingest's delivery lag rather than at the clock.
- name: plane
in: query
required: false
schema:
type: string
description: Restrict to one plane's routes.
- name: limit
in: query
required: false
description: Max rows (default 100, max 500).
schema:
type: integer
default: 100
maximum: 500
responses:
'200':
description: '{ window, plane, requests, freshness }'
'403':
description: Not a constellation admin.
tags:
- Atlas
operationId: getV1AtlasSlow
x-operation-id-source: derived
servers:
- url: https://analytics.connectionsapi.com
/v1/atlas/coverage:
get:
summary: Atlas - which AWS accounts the passive ingest can read (constellation admins…
description: How many organization accounts the passive ingest has swept, how many checked in recently, how many carry an API, and which ones it could NOT read - most often a new account without the Atlas read role yet.
security:
- ApiKeyAuth: []
parameters: []
responses:
'200':
description: The account coverage summary.
'403':
description: Not a constellation admin.
tags:
- Atlas
operationId: getV1AtlasCoverage
x-operation-id-source: derived
servers:
- url: https://analytics.connectionsapi.com
/v1/atlas/freshness:
get:
summary: Atlas - the ingest cursor's freshness (constellation admins only)
description: When the traffic data was last advanced and whether that is within the ingest cadence. The same object /traffic and /slow bundle into their answers; on its own for a health probe.
security:
- ApiKeyAuth: []
parameters: []
responses:
'200':
description: '{ dataThrough, degraded, reason }'
'403':
description: Not a constellation admin.
tags:
- Atlas
operationId: getV1AtlasFreshness
x-operation-id-source: derived
servers:
- url: https://analytics.connectionsapi.com
/v1/atlas/datasets:
get:
summary: Atlas - one site's HUMAN and SUE datasets side by side (constellation admins…
description: 'The two datasets of one tracked site over whole UTC days (`to` inclusive, default the last 7 days): sessions, visitors, pageviews, new identities and revenue for real people and for SUE simulated users (tools/sue), measured the same way on both sides. Every member read counts humans only; this is the one place the Sue dataset is read. `sue_usable_as_proxy` is true while the site''s human visits per day are under `proxy_threshold_visits_per_day` (100). 400 for a malformed window, 404 for an unknown site.'
security:
- ApiKeyAuth: []
parameters:
- name: site
in: query
required: true
schema:
type: string
description: A tracked site id or domain.
- name: from
in: query
required: false
schema:
type: string
format: date
description: First UTC day, YYYY-MM-DD.
- name: to
in: query
required: false
schema:
type: string
format: date
description: Last UTC day, YYYY-MM-DD, inclusive. Default today.
responses:
'200':
description: '{ site, from, to, days, human, sue, human_visits_per_day, proxy_threshold_visits_per_day, sue_usable_as_proxy }'
'403':
description: Not a constellation admin.
tags:
- Atlas
operationId: getV1AtlasDatasets
x-operation-id-source: derived
servers:
- url: https://analytics.connectionsapi.com
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: 'A Studio-minted cnx_live_ key carrying analytics:read (analytics:write to provision sites). The SAME key is also accepted as Authorization: Bearer (see BearerAuth). Studio is the sole key issuer. The legacy per-plane argus_live_ key class was retired 2026-06-21.'
memberSession:
type: http
scheme: bearer
description: The member's Connections session access token, exactly as this product's app sends it. Only operations that declare this scheme accept one.
x-connections-credential: member-session
cnxKey:
type: http
scheme: bearer
description: A cnx_live_ key minted in Studio. It acts as the member who minted it, within its scopes.
x-connections-credential: connections-key
BearerAuth:
type: http
scheme: bearer
description: A cnx_live_ key carrying analytics:read, sent as a bearer token.
x-refined-from:
- connections-icu-analytics-openapi-original.json
- connections-icu-analytics-openapi.yml