Request a Report

GET

/api/reporting/request

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params text/plain

Example

Example:{ "name": "ResidualExport", "params": { "format": "csv", "date": "2022-02", "isPublished": "Yes", "isHeld": "No", "dbaId": 1, }

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET '/api/reporting/request' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: text/plain' \
--data-raw '{
    "name": "ResidualExport",
    "params": {
        "format": "csv",
        "date": "2022-02",
        "isPublished": "Yes",
        "isHeld": "No",
        "dbaId": 1,
    }'

Responses

🟢200Request a Report

application/json

Body

Example

{
    "id": 1
}

Modified at 2025-08-09 05:39:41

Other Reports

Check Status