Skip to main content

​
Get Revenue Report

​
GET
string
required
/v1/reports/revenue
Get revenue report with breakdown.

​
Query Parameters

​
start_date
string
required
Start date (ISO 8601)
​
end_date
string
required
End date (ISO 8601)
​
group_by
string
Group by (agent, customer, product)
​
revenue
number
Total revenue
​
breakdown
array
Revenue breakdown
curl -X GET "https://api.valmi.io/v1/reports/revenue?start_date=2024-01-01&end_date=2024-01-31&group_by=agent" \
  -H "Authorization: Bearer sk_api_abc123xyz"

​
Get PnL Report

​
GET
string
required
/v1/reports/pnl
Get profit and loss report.

​
Query Parameters

​
start_date
string
required
Start date (ISO 8601)
​
end_date
string
required
End date (ISO 8601)
​
revenue
number
Total revenue
​
costs
number
Total costs
​
margin
number
Margin (revenue - costs)
​
margin_percent
number
Margin percentage
curl -X GET "https://api.valmi.io/v1/reports/pnl?start_date=2024-01-01&end_date=2024-01-31" \
  -H "Authorization: Bearer sk_api_abc123xyz"