These are the endpoints that are available under the /reports path, which lists all the different reports you have available on your business' reports page.
Endpoint | Description |
|---|---|
| GET /reports/category | Returns an array of strings representing each report category code on an account. |
| GET /report/category/{categoryCode} | Returns a list of report objects in the specified category. |
| POST /report/print/file/{reportFileName} | Runs the specified report. |
Data points passed on in the request URL portion of the API call that are used to filter the data being requested.
Parameter | Type | Endpoints to be used with | Description |
|---|---|---|---|
| attach | boolean | POST /report/print/file | Indicates whether the report should download (if set to 'true') or show on screen (if set to 'false'). |
| endDate | string | POST /report/print/file | Should be set as the end date of the report to be returned following a GET report call, formatted as YYYY-MM-DD. |
| format | string | POST /report/print/file | Should be set as the format of the report to be returned. Accepts "print", "pdf", "xls" or "xlsx". |
| locationId | integer | POST /report/print/file | Should be set as the ID of the location of the report to be returned. Only applicable for reports in the "locations" report category. |
| startDate | string | POST /report/print/file | Should be set as the start date of the report to be returned following a GET report call, formatted as YYYY-MM-DD. |
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
"startDate": 2023-06-02,
"endDate": 2023-06-02,
"format": pdf,
"attach": 0,
"locationId": undefined |
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"0": "closed_appointments",
"1": "open_appointments",
"2": "coupon",
"3": "client_service",
"4": "cancelled_appointments",
"5": "classes",
"6": "by_location",
"7": "staff",
"8": "noshow_appointments",
"9": "booking_site_reports",
"10": "email_reports",
"11": "repeating_appointments",
"12": "working_hours",
"13": "all_appts",
"14": "waitlist",
"15": "client",
"16": "invoice"
} |
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
[{
"active": true,
"businessId": null,
"category": "closed_appointments",
"createdDate": 1462475855691,
"createdUser": null,
"modifiedDate": null,
"modifiedUser": null,
"planIds": [1, 3, 5, 6, 7, 8, 9, 11, 12, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 30, 31, 32, 33,…],
"reportFileName": "appt-closed-daily-staff",
"reportId": 10,
"reportName": "Completed Appointments by Staff",
"reportType": null,
"resellerIds": [1, 2, 3],
"securityFunctions": ["dashboardReportView", "accessAllStaffAtLocations", "accessAllLocations"]
}] |
| Property name | Type | Description |
|---|---|---|
| active | boolean | Indicates whether or not the specified report is active. |
| businessId | integer | Provides the unique numeric ID for the business that the specified report belongs to. |
| category | string | Displays as the category of the specified report. |
| createdDate | integer | Displays as the date the specified report was created, in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. |
| createdUser | string | Displays the username of the user who created the specified report. |
| modifiedDate | integer | Displays as the date the specified report was last modified, in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. |
| modifiedUser | string | Displays the username of the user who last modified the specified report. |
| planIds | integer | Provides a comma-separated list of the IDs of the plans that can run the specified report. |
| reportFileName | string | Displays as the file name of the specified report. |
| reportId | integer | Provides the unique numeric ID for the specified report. |
| reportName | string | Displays as the name of the specified report. |
| reportType | string | Displays as the type of the specified report. |
| resellerIds | integer | Provides unique numeric IDs for the resellers of the specified report. |
| securityFunctions | string | Displays the names of the security role functions required for a staff to be able to access the specified report. |