Skip to content

Get revenue attribution report

GET
/api/v1/reports/revenue

Returns revenue attribution data broken down by channel for the specified period.

Authorizations

Parameters

Query Parameters

period

Attribution period

string
default: 30d
Allowed values: 7d 30d 90d

Attribution period

Responses

200

Successful Response

Envelope response for the revenue attribution endpoint.

Attributes: data: The revenue attribution payload. meta: Standard response metadata.

object
data
required

Inner data payload for revenue attribution responses.

Attributes: period: The reporting period (e.g. “7d”, “30d”, “90d”). total_revenue: Total revenue across all channels. channels: Per-channel revenue breakdown. generated_at: When the report was generated.

object
channels
Array<object>

Revenue attributed to a single channel or source.

Attributes: channel: Name of the revenue channel. revenue: Total revenue from this channel. percentage: Share of total revenue. actions_count: Number of agent actions that contributed.

object
actions_count
integer
channel
required
string
percentage
number
revenue
number
generated_at
required
string format: date-time
period
required
string
total_revenue
number
meta

Standard metadata included in every API response.

Attributes: request_id: Unique identifier for this request. timestamp: When the response was generated.

object
request_id

Unique identifier for this request

string
timestamp

When the response was generated

string format: date-time

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string