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 Entities API
version: 1.0.0
description: 'Operations tagged Entities 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: Entities
paths:
/entities/{namespace}/{id}:
get:
summary: Get entity snapshot
description: The current merged state of an entity (property analytics). Omit /{id} to list a namespace.
security:
- ApiKeyAuth: []
parameters:
- name: namespace
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
- name: site
in: query
required: false
description: Target site id or domain. Optional when the API key owns exactly one site. `all` answers for EVERY site this credential owns (narrow with ?company=), and every row of such a response carries a `site` column; a read with no all-sites form answers 400 rather than one site's numbers.
schema:
type: string
responses:
'200':
description: Entity snapshot.
'404':
description: Not found.
tags:
- Entities
operationId: getEntitiesByNamespaceById
x-operation-id-source: derived
post:
summary: Upsert entity state
description: Merge traits into an entity (last-write-wins). Also auto-upserted from the pixel's upsert_state.
security:
- ApiKeyAuth: []
parameters:
- name: namespace
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
traits:
type: object
responses:
'200':
description: The updated entity.
tags:
- Entities
operationId: postEntitiesByNamespaceById
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