API reference

Overview

Base URL, authentication, errors and paging, plus every control-plane endpoint at a glance.

The control-plane API configures BreezeIQ and reads its profiles, segments and members.

Conventions#

Base URL	`https://api.breeze.in/cdp/control-plane`
Format	JSON in and out (`Content-Type: application/json`)
Auth	`Authorization: Bearer <token>`, with a `cpt_...` or `cpw_...` token. See Authentication.
Errors	`{"error": "human-readable message"}` with an HTTP status. See Errors.
Paging	List endpoints return `next_cursor`. Pass it back as `?cursor=`. `null` means the last page.

Scopes#

Each endpoint shows the token it needs.

Scope	Accepts
tenant	A tenant token (`cpt_...`)
workspace	A tenant token, or that workspace's own token (`cpw_...`)

Endpoints#

Workspaces #

Endpoint	Request	Scope
Create a workspace	`POST /v1/tenants/{tenant}/workspaces`	tenant
List workspaces	`GET /v1/tenants/{tenant}/workspaces`	workspace
Add an alias	`PUT /v1/tenants/{tenant}/workspaces/{ws}/aliases/{alias}`	tenant
Remove an alias	`DELETE /v1/tenants/{tenant}/workspaces/{ws}/aliases/{alias}`	tenant

Tokens #

Endpoint	Request	Scope
Check a token	`GET /v1/whoami`	any
Create a workspace token	`POST /v1/tenants/{tenant}/workspaces/{ws}/tokens`	tenant
List tokens	`GET /v1/tenants/{tenant}/tokens`	tenant
Revoke a token	`DELETE /v1/tenants/{tenant}/tokens/{token_id}`	tenant

Event types #

Endpoint	Request	Scope
Register an event type	`PUT /v1/tenants/{tenant}/event-types/{event_name}`	tenant
List event types	`GET /v1/tenants/{tenant}/event-types`	workspace
Delete an event type	`DELETE /v1/tenants/{tenant}/event-types/{event_name}`	tenant

Metric definitions #

Endpoint	Request	Scope
Create a metric definition	`PUT /v1/tenants/{tenant}/metric-definitions`	tenant
List metric definitions	`GET /v1/tenants/{tenant}/metric-definitions`	workspace
Delete a metric definition	`DELETE /v1/tenants/{tenant}/metric-definitions`	tenant

Segments #

Endpoint	Request	Scope
Preview a segment	`POST /v1/tenants/{tenant}/segments/preview`	tenant
Create a segment	`PUT /v1/tenants/{tenant}/segments/{segment_id}`	tenant
List segments	`GET /v1/tenants/{tenant}/segments`	workspace
Get a segment	`GET /v1/tenants/{tenant}/segments/{segment_id}/definition`	workspace
Update segment status	`PUT /v1/tenants/{tenant}/segments/{segment_id}/status`	tenant
Delete a segment	`DELETE /v1/tenants/{tenant}/segments/{segment_id}`	tenant

Profiles #

Endpoint	Request	Scope
Look up a profile	`GET /v1/tenants/{tenant}/workspaces/{ws}/profiles/lookup`	workspace
Get a profile	`GET /v1/tenants/{tenant}/workspaces/{ws}/profiles/{profile_id}`	workspace
List profile summaries	`GET /v1/tenants/{tenant}/workspaces/{ws}/profiles/summary`	workspace
List profiles	`GET /v1/tenants/{tenant}/workspaces/{ws}/profiles`	workspace
Get profile segments	`GET /v1/tenants/{tenant}/workspaces/{ws}/profiles/{profile_id}/segments`	workspace
Erase a profile	`DELETE /v1/tenants/{tenant}/workspaces/{ws}/profiles/{profile_id}`	tenant

Segment members #

Endpoint	Request	Scope
Check membership	`GET /v1/tenants/{tenant}/workspaces/{ws}/segments/{segment_id}/membership`	workspace
List segment members	`GET /v1/tenants/{tenant}/workspaces/{ws}/segments/{segment_id}/members`	workspace
Export segment members	`GET /v1/tenants/{tenant}/segments/{segment_id}/members`	workspace