Reports API

Generate reports in PDF, Excel, Word, CSV and HTML, send them by email, run schedules and import data.

Version

Service: Reports service
Base path: https://your-reports-host/api/v1
Authentication: Bearer token and context headers.

POST/api/v1/report/export

Generate a report for preview

Authentication: Bearer token and context headers
Permissions: Your role's access to the resource

Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

POST/api/v1/report/download

Generate a report file

Authentication: Bearer token and context headers
Permissions: Your role's access to the resource

Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

POST/api/v1/report/SendReport

Generate a report and email it

Authentication: Bearer token and context headers
Permissions: Your role's access to the resource

Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

POST/api/v1/report/schedules/{scheduleId}/run-now

Run a report schedule now

Authentication: Bearer token and context headers
Permissions: Your role's access to the resource

Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

POST/api/v1/report/schedules/{scheduleId}/re-sync

Re-register a schedule with the scheduler

Authentication: Bearer token and context headers
Permissions: Your role's access to the resource

Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

POST/api/v1/import/data

Validate or import an uploaded file

Runs an import mapping against an uploaded Excel or CSV file, either as a validation dry run or as a real import, with row-level errors.

Authentication: Bearer token and context headers
Permissions: Your role's access to the resource

Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.