Reporting API

Number of APIs: 5

1. Report types - List report types

GET https://{{host}}/reporting-api/v1/reports

List all versions of all report types, optionally filtering out older deprecated versions.

---

2. Report types - List versions

GET https://{{host}}/reporting-api/v1/reports/:name/versions

List all versions for a specific report type.

---

3. Report types - Get a report type

GET https://{{host}}/reporting-api/v1/reports/:name/versions/:version

Get a specific version of a report type.

---

4. Reports - Generate a report

POST https://{{host}}/reporting-api/v1/reports/:name/versions/:version/report-data?start={{start}}&end={{end}}&interval={{interval}}

Produce a report in either JSON or CSV format for a specific version of a type of report. In CSV data, values with commas or space characters are quoted. Query parameters specify the range of data and the aggregation interval for each record.

---

5. Reports - Get a cacheable report

GET https://{{host}}/reporting-api/v1/reports/:name/versions/:version/report-data?start={{start}}&end={{end}}&interval={{interval}}

Produce a report in either JSON or CSV format for a specific version of a type of report. While functionally identical to Generate a report, this alternative GET operation specifies all request data as query parameters.

---