Skip to content
UltimateTeam.ai Docs

Revenue metrics

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

Revenue dashboard with pipeline, outreach, and attribution metrics for the selected period.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
period
Period

Reporting period: 7d, 30d, or 90d

string
default: 7d

Reporting period: 7d, 30d, or 90d

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
RevenueDashboardResponse

Response for GET /api/v1/dashboard/revenue.

object
data
required
RevenueDashboardData

Revenue metrics payload.

Attributes: total_revenue: Total revenue in the selected period. revenue_change_pct: Percentage change from prior period. new_customers: Number of new customers acquired. pipeline: Pipeline summary with stage breakdowns. outreach: Outreach metrics (sent, responses, response rate). attributed_revenue: Revenue attributed to AI agent activity. period: The reporting period requested. generated_at: When this dashboard was generated.

object
attributed_revenue
Attributed Revenue
number
0
generated_at
Generated At
string format: date-time
new_customers
New Customers
integer
0
outreach
Outreach
object
key
additional properties
any
period
Period
string
default: 7d
pipeline
Pipeline
object
key
additional properties
any
revenue_change_pct
Any of:
number
total_revenue
Total Revenue
number
0
meta
ApiMeta

Standard metadata included in every API response.

Attributes: request_id: Unique identifier for request tracing. timestamp: UTC timestamp of the response.

object
request_id
Request Id

Unique identifier for request tracing

string
timestamp
Timestamp

UTC timestamp of the response

string format: date-time
Example
{
  "data": {
    "attributed_revenue": 0,
    "new_customers": 0,
    "period": "7d",
    "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"
    }
  ]
}