Reports

The reporting engine and saved views.

8 endpoints · base URL https://api.aerscheduler.com

get/reports/catalog

List available reports

Every report you may run, with its id and category. Start here: the ids returned are what POST /reports/run and POST /reports/export take, and the catalog is filtered to what your roles allow, so you never see a report you cannot run.

Responses

`200`	OK	Success.→ { data: object }
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl https://api.aerscheduler.com/reports/catalog \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"

post/reports/export

Export a report as CSV

Same inputs as run, but the response is text/csv rather than the usual JSON envelope.

Request body

Which report, over what window.

`reportId`required	`string`
`startDate`	`string`
`endDate`	`string`
`format`	`"csv"`

Responses

`200`	OK	The report as CSV.
`400`	Bad Request	Unknown report id.
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl -X POST https://api.aerscheduler.com/reports/export \
  -H "Authorization: Bearer $AERSCHEDULER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reportId":"…"}'

get/reports/overview

Organization overview

The headline numbers for a window , the figures behind the dashboard.

Query parameters

`startDate`	`string`	Start of the window, ISO 8601. Include an offset or `Z`.
`endDate`	`string`	End of the window, ISO 8601.

Responses

`200`	OK	Success.→ { data: object }
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl https://api.aerscheduler.com/reports/overview \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"

post/reports/run

Run a report

Runs one report from the catalog and returns columns, rows, and totals.

Request body

Which report, over what window.

`reportId`required	`string`
`startDate`	`string`
`endDate`	`string`
`config`	`object`

Responses

`200`	OK	Success.→ { data: ReportResult }
`400`	Bad Request	Unknown report id, or an unparseable window.
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl -X POST https://api.aerscheduler.com/reports/run \
  -H "Authorization: Bearer $AERSCHEDULER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reportId":"revenue"}'

get/reports/views

List saved report views

Every saved report view in your organization.

Query parameters

`limit`	`integer`	Rows to return, 1,1000. Defaults to 1000; a larger value is clamped rather than rejected.
`offset`	`integer`	Rows to skip, for paging. Defaults to 0.
`sort`	`string`	Field to order by before paging, as a dot path into the row , `total`, `user.firstName`. Omit to keep the endpoint's own order. Numbers and ISO timestamps order as numbers and instants, not as text, and empty values always sort last regardless of direction. Ordering happens before the page is cut, so it orders the whole collection rather than the page you are holding.
`order`	`"asc" \| "desc"`	`asc` (default) or `desc`. Only meaningful with `sort`.

Responses

`200`	OK	The saved report views.→ { data: ReportDefinition[] }
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl https://api.aerscheduler.com/reports/views \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"

post/reports/views

Create a saved report view

Adds a saved report view to your organization.

Request body

The saved view.

`reportId`required	`string`
`name`required	`string`
`config`	`object`
`isShared`	`boolean`

Responses

`201`	Created	The saved report view that was created.→ { data: ReportDefinition }
`400`	Bad Request	The body failed validation. `message` says which field.
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl -X POST https://api.aerscheduler.com/reports/views \
  -H "Authorization: Bearer $AERSCHEDULER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reportId":"…","name":"…"}'

patch/reports/views/{viewId}

Update a saved report view

Changes the fields you send and leaves the rest alone.

Path parameters

viewIdrequired integer The saved view id.

Request body

Fields to change.

`name`	`string`
`config`	`object`
`isShared`	`boolean`

Responses

`200`	OK	The updated saved report view.→ { data: ReportDefinition }
`400`	Bad Request	The body failed validation.
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl -X PATCH https://api.aerscheduler.com/reports/views/:viewId \
  -H "Authorization: Bearer $AERSCHEDULER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"…","config":{}}'

delete/reports/views/{viewId}

Delete a saved report view

Removes the saved report view.

Path parameters

viewIdrequired integer The saved view id.

Responses

`204`	No Content	Success. No body.
`400`	Bad Request	The saved report view could not be deleted , usually because something still references it.
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl -X DELETE https://api.aerscheduler.com/reports/views/:viewId \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"

PreviousPublic bookingUnauthenticated guest request pages. A guest picks an offering slot, confirms by email, and the front desk approves or declines the request. Members keep booking as they do today.NextSearchOne search across the organization.

API overview Talk to us