Connections Setup API
The Setup API from Connections — 11 operation(s) for setup.
The Setup API from Connections — 11 operation(s) for setup.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/connections-icu:connections-icu-setup-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Connections Icu Setup API
version: 1.0.0
description: 'Operations tagged Setup across 4 of this provider''s published API definitions: connections-icu-analytics-openapi-original.json, connections-icu-studio-openapi-original.json, connections-icu-analytics-openapi.yml, connections-icu-studio-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://analytics.connectionsapi.com
- url: https://studio.connectionsapi.com
tags:
- name: Setup
paths:
/setup/guide:
get:
summary: Full setup guide (AI-first)
description: The complete step-by-step wiring playbook (JSON, or ?format=md for raw markdown). An agent can wire a whole site from this without a dashboard.
parameters:
- name: format
in: query
required: false
schema:
type: string
enum:
- json
- md
responses:
'200':
description: '{ host, guide }'
tags:
- Setup
operationId: getSetupGuide
x-operation-id-source: derived
servers:
- url: https://analytics.connectionsapi.com
/setup/prompt:
get:
summary: AI install prompt (fetchable markdown)
description: 'The full ''hand it to your AI'' install playbook as raw markdown (text/markdown): the target of the dashboard''s one-line `Fetch ` copy button. Pass ?site= to personalize and ?key=ak_… to bake in the public ingest key (so an unauthenticated agent fetch still gets a key-ready prompt). Also served at /setup/prompt.md.'
parameters:
- name: site
in: query
required: false
schema:
type: string
- name: key
in: query
required: false
schema:
type: string
responses:
'200':
description: Markdown install prompt.
tags:
- Setup
operationId: getSetupPrompt
x-operation-id-source: derived
servers:
- url: https://analytics.connectionsapi.com
/setup/pixel:
get:
summary: Ready-to-paste pixel snippet
description: Framework-tailored install snippet. Pass ?framework=html|react|nextjs|vue|nuxt|svelte|remix (default all). The real ingest key is injected when authed or ?key=ak_… is given; otherwise a placeholder.
parameters:
- name: framework
in: query
required: false
schema:
type: string
- name: site
in: query
required: false
schema:
type: string
- name: key
in: query
required: false
schema:
type: string
responses:
'200':
description: '{ pixel_key, placement, snippet(s) }'
tags:
- Setup
operationId: getSetupPixel
x-operation-id-source: derived
servers:
- url: https://analytics.connectionsapi.com
/setup/issue-reporter:
get:
summary: Issue-reporter widget snippet
description: Snippet that mounts a visitor-facing report button. Reports surface at /api/v2/analytics/user-reports.
parameters:
- name: framework
in: query
required: false
schema:
type: string
responses:
'200':
description: '{ note, snippet(s) }'
tags:
- Setup
operationId: getSetupIssueReporter
x-operation-id-source: derived
servers:
- url: https://analytics.connectionsapi.com
/setup/privacy:
get:
summary: Suggested privacy text for the pixel's behavior
description: Renders a privacy-policy, terms-of-service, or paste-in analytics-section document from what the ARGUS pixel collects and stores (infra/shared/privacy/analytics-disclosure.ts is the single source of truth for the cookie/collection tables, never hand-authored here). A DRAFT, not legal advice - every response carries that disclaimer. retentionDays/name/domain come from the resolved site's tracked_sites row when one resolves (an owner session or key selects it, same as /setup/pixel); site/company/contact override or supply them directly. Email is ACCOUNTS-only and analytics never resolves one - contact is caller-supplied only, and absent it renders a placeholder.
parameters:
- name: kind
in: query
required: false
schema:
type: string
enum:
- analytics-section
- privacy-policy
- terms-of-service
default: analytics-section
- name: format
in: query
required: false
schema:
type: string
enum:
- markdown
- html
- text
default: markdown
- 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
- name: contact
in: query
required: false
description: Contact email shown in the document. Omitted renders a placeholder.
schema:
type: string
- name: company
in: query
required: false
description: Publisher name shown in the document. Falls back to the resolved site's name.
schema:
type: string
responses:
'200':
description: '{ kind, format, disclosureVersion, document }'
tags:
- Setup
operationId: getSetupPrivacy
x-operation-id-source: derived
servers:
- url: https://analytics.connectionsapi.com
/setup/privacy.md:
get:
summary: Suggested privacy text, as a fetchable markdown file
description: The raw-markdown counterpart of GET /setup/privacy - the same document, always rendered as markdown (no ?format=), served as text/markdown the way /setup/prompt.md serves the install prompt.
parameters:
- name: kind
in: query
required: false
schema:
type: string
enum:
- analytics-section
- privacy-policy
- terms-of-service
default: analytics-section
- 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
- name: contact
in: query
required: false
schema:
type: string
- name: company
in: query
required: false
schema:
type: string
responses:
'200':
description: Markdown document.
tags:
- Setup
operationId: getSetupPrivacyMd
x-operation-id-source: derived
servers:
- url: https://analytics.connectionsapi.com
/setup/assist:
get:
summary: Help-widget install snippet
description: 'A drop-in REPLACEMENT for the GET /setup/pixel snippet (same id="argus-pixel" guard, so having both on a page is idempotent) that also configures window.ArgusPixel.assist - the pixel''s built-in ''having a problem?'' panel. It offers help at the moment a visitor gets stuck (a rage click or a rage refresh, both of which the pixel has always detected), plus an always-on Help button and optional exit intent. THE WIDGET IS OFF UNTIL A PAGE CARRIES THIS CONFIG: a customer pastes the plain pixel snippet to get measurement, so we never add an uninvited control to their site. Also returns triggerLinkSnippet, a tiny ''Report a problem'' link calling window.ArgusPixel.openAssist(). destination picks where a report goes: form (default - the report lands in your dashboard as a user_reported_issue event), chat (opens the Connections chat widget, needs chatKey), url (sends them to your help page), or email. Config keys ride as query params: enabled, firstParty, destination, url, newTab, email, emailSubject, chatKey, chatTitle, chatOrigin, chatSeed, askEmail, accent, theme (light|dark), position (right|left|top-right|top-left), policyUrl, policyLabel, rageClick, rageRefresh, exitIntent, button (each true|false; omit one to keep the pixel''s default), heading, description, placeholder, fieldLabel, emailLabel, emailPlaceholder, sendLabel, dismissLabel, closeLabel, buttonLabel, thanksLabel.'
parameters:
- name: framework
in: query
required: false
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
- name: key
in: query
required: false
schema:
type: string
responses:
'200':
description: '{ note, snippet(s), triggerLinkSnippet }'
tags:
- Setup
operationId: getSetupAssist
x-operation-id-source: derived
servers:
- url: https://analytics.connectionsapi.com
/setup/consent-banner:
get:
summary: Cookie-banner install snippet
description: 'A drop-in REPLACEMENT for the GET /setup/pixel snippet (same id="argus-pixel" guard, so having both on a page is idempotent, not a double install) that also configures and turns on window.ArgusPixel.consentBanner (brand, theme, position, which purposes to ask about, and copy overrides) - it sets that config before pixel.js is fetched, since the banner reads it at render time. The pixel never shows a banner on its own: where consent would be needed it measures cookieless (the page, referrer, campaign tags and events with no identifier and nothing written to the device; the server counts a visitor within one day by a key it throws away at midnight) and asks nobody. This snippet is for a site that wants the identified tier from those visitors - durable ids, cross-visit recognition, the other purposes - and has decided to ask; it bakes in the enabled:true switch that turns the banner on. Also returns footerLinkSnippet, a tiny ''Cookie settings'' link/button for a site''s footer that calls window.ArgusPixel.openConsentPreferences(). Config keys ride as query params: brandName, logoSrc, policyUrl, policyLabel, accent, theme (light|dark), position (top|bottom), purposes (comma-separated subset of analytics, personalization, marketing, cross_context_advertising, intelligence_graph), reopenHandle=false, reopenLabel, heading, description, manageHeading, manageDescription, acceptLabel, rejectLabel, manageLabel, saveLabel, backLabel.'
parameters:
- name: framework
in: query
required: false
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
- name: key
in: query
required: false
schema:
type: string
responses:
'200':
description: '{ note, snippet(s), footerLinkSnippet }'
tags:
- Setup
operationId: getSetupConsentBanner
x-operation-id-source: derived
servers:
- url: https://analytics.connectionsapi.com
/setup/verify:
get:
summary: Verify the pixel is live
description: 'Checks sessions > 0 and pageviews > 0 in the last 24h for your site. Also returns where the tag was seen when it was NOT the live site: last_dropped_origin/last_dropped_at (the newest local dev origin, e.g. http://localhost:5173, that sent this site''s valid key and was dropped as dev traffic; null when never) and foreign_hosts (the last 7 days'' page hosts that are not the site''s domain, with event and dropped counts). When there is no data and no dev-origin evidence on a third-party site, the server fetches https:/// once (at most once per site per minute; inside the minute the last result is returned) and says why in diagnosis: { code, detail, checked_at }. code is one of unreachable (detail: why nothing answered), http_status (detail: the status), csp_blocks (detail: the Content-Security-Policy directive that refuses the pixel host), snippet_missing (not found in the page''s HTML; an app that adds it with JavaScript cannot be seen), key_mismatch (detail: the other ak_ key the snippet carries), or snippet_found (present with this site''s key; only a real visit is missing). diagnosis is null when the data check passes, a dev origin explains it, or the site is first-party.'
security:
- ApiKeyAuth: []
parameters:
- 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: '{ ok, sessions_24h, pageviews_24h, last_dropped_origin, last_dropped_at, foreign_hosts: [{ host, events, dropped }], diagnosis: { code, detail, checked_at } | null, message }'
'401':
description: Auth required.
tags:
- Setup
operationId: getSetupVerify
x-operation-id-source: derived
servers:
- url: https://analytics.connectionsapi.com
/setup/status:
get:
summary: Setup status
description: 'What''s configured for your site: pixel installed?, total events, read keys, last event time.'
security:
- ApiKeyAuth: []
parameters:
- 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: Status JSON.
'401':
description: Auth required.
tags:
- Setup
operationId: getSetupStatus
x-operation-id-source: derived
servers:
- url: https://analytics.connectionsapi.com
/v1/setup/builder:
get:
summary: 'Your builder Finish-setup path, from Studio''s own records: {facts…'
security:
- aegisBearer: []
x-required-scope: projects:owner
tags:
- Setup
operationId: getV1SetupBuilder
x-operation-id-source: derived
servers:
- url: https://studio.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.
aegisBearer:
type: http
scheme: bearer
bearerFormat: JWT
description: The AEGIS SSO access token (Cognito JWT from the shared sign-in) presented as a Bearer on every /v1 call.
apiKey:
type: http
scheme: bearer
bearerFormat: cnx_live_* | cnx_pub_*
description: 'A key minted in the console, sent as a bearer token. `cnx_live_` carries cross-plane data scopes AND (when granted) Studio management scopes (apps:*, keys:*, projects:*, webhooks:*) that authorize the console-management operations below. `cnx_pub_` is the publishable, browser-safe tier (Stripe''s pk_ model): mint-time capped to :read scopes, requires a non-empty allowed-origins allowlist, refused on any non-GET/HEAD route, and rate-limited - safe to embed in client-side code.'
oauthUserToken:
type: http
scheme: bearer
description: EITHER (a) a Sign-in-with-Connections USER access token issued by accounts.connectionsapi.com to a registered OAuth app - the app acts on behalf of its signed-in user, rows are keyed by the token's own sub + client_id; OR (b) an app-bound publishable key (cnx_pub_, minted with an appId) presented on X-Connections-Api-Key ALONGSIDE the signed-in user's own plain AEGIS bearer on Authorization - the server derives (app_id, sub) from the two verified credentials. The publishable key alone authorizes nothing; both credentials are required. This second form is for a developer who wants the locker without standing up a full OAuth client - mint one publishable key bound to a registered app instead.
x-refined-from:
- connections-icu-analytics-openapi-original.json
- connections-icu-studio-openapi-original.json
- connections-icu-analytics-openapi.yml
- connections-icu-studio-openapi.yml