Skip to content
UltimateTeam.ai Docs

Get revenue attribution report

GET
/api/v1/reports/revenue
curl --request GET \
  --url 'https://api.ultimateteam.ai/api/v1/reports/revenue?period=7d' \
  --header 'X-API-Key: <X-API-Key>'

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
period
RevenuePeriod

Attribution period

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

Attribution period

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
RevenueReportResponse

Envelope response for the revenue attribution endpoint.

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

object
data
required
RevenueReportData

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
Channels
Array<object>
RevenueChannelSchema

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
Actions Count
integer
0
channel
required
Channel
string
percentage
Percentage
number
0
revenue
Revenue
number
0
generated_at
required
Generated At
string format: date-time
period
required
Period
string
total_revenue
Total Revenue
number
0
meta
ResponseMeta

Standard metadata included in every API response.

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

object
request_id
Request Id

Unique identifier for this request

string
timestamp
Timestamp

When the response was generated

string format: date-time
Example
{
  "data": {
    "channels": [
      {
        "actions_count": 0,
        "percentage": 0,
        "revenue": 0
      }
    ],
    "total_revenue": 0
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}