Reports
Revenue reports
Revenue reports for the authenticated team.
get/reports/revenue
Query parameters
fromstring required
Start date (ISO 8601 format)
Example:2023-01-01
Start date (ISO 8601 format)
tostring required
End date (ISO 8601 format)
Example:2023-12-31
End date (ISO 8601 format)
currencystring
Currency code (ISO 4217)
Example:USD
Currency code (ISO 4217)
revenueType'gross' | 'net'
Type of revenue calculation
Example:net
Type of revenue calculation
Response
Revenue reports for the authenticated team.
Example response
{
"summary": {
"currentTotal": 10000,
"prevTotal": 8000,
"currency": "USD"
},
"meta": {
"type": "revenue",
"currency": "USD"
},
"result": [
{
"date": "2023-01-31",
"percentage": {
"value": 25,
"status": "positive"
},
"current": {
"date": "2023-01-31",
"value": 1000,
"currency": "USD"
},
"previous": {
"date": "2022-01-31",
"value": 800,
"currency": "USD"
}
}
]
}