Get outcome totals

GET

/api/v1/insights/outcomes

How many outcomes were recorded in the range. An outcome is a conversion event the AI or a component contributed to.

Parameters

Header Parameters

x-api-key

required

string

Your API key from account settings.

x-user-email

required

string

The email address of your user.

x-account-id

required

string

The ID of your account. You can find this in the account settings.

x-website-id

required

string

The ID of the workspace you want to use.

Query Parameters

startTime

required

string format: date

First day of the range, inclusive, as YYYY-MM-DD.

endTime

required

string format: date

Last day of the range, inclusive, as YYYY-MM-DD.

forceRefresh

boolean

Recompute instead of reading the query cache. Slow - only worth it when you know the cache is stale.

Responses

200

Outcome total for the range.

object

status

string

lastUpdate

number

outcomes

number

Example

{
  "status": "ready",
  "lastUpdate": 1757462400000,
  "outcomes": 143
}

401

Unauthorized - invalid API key.

500

StartTime or endTime was missing.