Reporting
Endpoints for generating and retrieving sales reports.# Endpoints
GET/reports/sale-count# Retrieve the sales count for a specified period.GET/reports/revenue# Retrieve the sales revenue for a specified period.
Reporting
labelThe date of the metric value.
valueThe metric value for the date.
{} The Reporting resource
1{
2 "label": "2024-09-30",
3 "value": 0
4}
get
Get Sales Count Report
Retrieve the sales count for a specified period (e.g., day, month).
curl -X GET "https://api.omnilabs.sh/reports/sale-count?period=day" -H "Authorization: Bearer {{BEARER_TOKEN}}"
Parameters
periodstringrequired
The time period for the report. Options: day | month.
[
{
"label": "2024-09-30",
"value": 0
},
{
"label": "2024-10-01",
"value": 0
},
{
"label": "2024-10-02",
"value": 0
},
{
"label": "2024-10-03",
"value": 2
},
{
"label": "2024-10-04",
"value": 15
},
{
"label": "2024-10-05",
"value": 0
},
{
"label": "2024-10-06",
"value": 0
}
]
get
Get Revenue Report
Retrieve the sales revenue for a specified period (e.g., day, month).
curl -X GET "https://api.omnilabs.sh/reports/revenue?period=day" -H "Authorization: Bearer {{BEARER_TOKEN}}"
Parameters
periodstringrequired
The time period for the report (e.g., day, month).
[
{
"label": "2024-09-30",
"value": 0
},
{
"label": "2024-10-01",
"value": 0
},
{
"label": "2024-10-02",
"value": 0
},
{
"label": "2024-10-03",
"value": 5259.9
},
{
"label": "2024-10-04",
"value": 39449.25
},
{
"label": "2024-10-05",
"value": 0
},
{
"label": "2024-10-06",
"value": 0
}
]
omnilabs.sh