Reported outcomes#

Manage campaign-reported business and brand measurements without presenting them as observed attribution.

Authentication required

All endpoints require a Bearer token in the Authorization header. See the Authentication guide for setup instructions.

GET /v1/outcomes/definitions#

List reusable reported outcome definitions for an organization.

bash

GET /v1/outcomes/definitions?organization_id=1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
organizationId	`string (UUID)`	Required	Organization identifier.

Response#

Returns { items, totalCount, facets, _meta } with paginated results.

POST /v1/outcomes/definitions#

Create a reusable definition for a reported business or brand outcome such as sales value, awareness, or qualified enquiries.

bash

POST /v1/outcomes/definitions
Authorization: Bearer {token}
Content-Type: application/json

{
  "organization_id": "1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01",
  "name": "My Campaign",
  "value_kind": "..."
}

Parameters#

Name	Type	Required	Description
organizationId	`string (UUID)`	Required	Organization identifier.
name	`string`	Required
description	`string \| null`	—
valueKind	`'count' \| 'currency' \| 'percentage' \| 'ratio' \| 'index' \| 'duration' \| 'other'`	Required
unitLabel	`string \| null`	—
defaultCurrency	`string \| null`	—

Response#

Returns { data, _meta } with the result.

PATCH /v1/outcomes/definitions/:id#

Update a reusable reported outcome definition.

bash

PATCH /v1/outcomes/definitions/:id
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
name	`string`	—
description	`string \| null`	—
valueKind	`'count' \| 'currency' \| 'percentage' \| 'ratio' \| 'index' \| 'duration' \| 'other'`	—
unitLabel	`string \| null`	—
defaultCurrency	`string \| null`	—
id	`string (UUID)`	Required	Unique identifier (UUID v4).

Response#

Returns { data, _meta } with the result.

DELETE /v1/outcomes/definitions/:id#

Delete an unused reported outcome definition by soft deletion; definitions with active measurements are blocked.

bash

DELETE /v1/outcomes/definitions/:id
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
id	`string (UUID)`	Required	Unique identifier (UUID v4).

Response#

Returns { data, _meta } with the result.

GET /v1/outcomes/measurements#

List reported outcome measurements for a campaign, including method, period, confidence, units, and definition.

bash

GET /v1/outcomes/measurements?organization_id=1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01&campaign_id=3a8d1f56-9e42-4b7c-a1d8-6f0e2b9c4a03
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
organizationId	`string (UUID)`	Required	Organization identifier.
campaignId	`string (UUID)`	Required	Unique identifier (UUID v4).

Response#

Returns { items, totalCount, facets, _meta } with paginated results.

POST /v1/outcomes/measurements#

Create a campaign-reported outcome measurement with an explicit source method and append-only evidence claim.

bash

POST /v1/outcomes/measurements
Authorization: Bearer {token}
Content-Type: application/json

{
  "organization_id": "1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01",
  "campaign_id": "3a8d1f56-9e42-4b7c-a1d8-6f0e2b9c4a03",
  "outcome_definition_id": "...",
  "value": "...",
  "source_method": "..."
}

Parameters#

Name	Type	Required	Description
organizationId	`string (UUID)`	Required	Organization identifier.
campaignId	`string (UUID)`	Required	Unique identifier (UUID v4).
outcomeDefinitionId	`string (UUID)`	Required	Unique identifier (UUID v4).
periodStart	`string \| null`	—
periodEnd	`string \| null`	—
value	`number`	Required
baselineValue	`number \| null`	—
market	`string \| null`	—
sourceMethod	`'document_reported' \| 'manual' \| 'csv' \| 'api'`	Required
confidence	`number \| null`	—

Response#

Returns { data, _meta } with the result.

PATCH /v1/outcomes/measurements/:id#

Update a reported outcome measurement and supersede its prior active evidence claim when the value changes.

bash

PATCH /v1/outcomes/measurements/:id
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
outcomeDefinitionId	`string (UUID)`	—	Unique identifier (UUID v4).
periodStart	`string \| null`	—
periodEnd	`string \| null`	—
value	`number`	—
baselineValue	`number \| null`	—
market	`string \| null`	—
sourceMethod	`'document_reported' \| 'manual' \| 'csv' \| 'api'`	—
confidence	`number \| null`	—
id	`string (UUID)`	Required	Unique identifier (UUID v4).

Response#

Returns { data, _meta } with the result.

DELETE /v1/outcomes/measurements/:id#

Delete a reported campaign outcome measurement by soft deletion.

bash

DELETE /v1/outcomes/measurements/:id
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
id	`string (UUID)`	Required	Unique identifier (UUID v4).

Response#

Returns { data, _meta } with the result.