Skip to content

Periodic report generation - API Contracts #557

Description

@chetanr25

Periodic report generation

Part of #541

Depends on: Async job infrastructure (#545), Summary statistics (#556)

Contract reference

Endpoints

POST /api/v1/reports/generate

Generates a periodic (monthly, quarterly, or annual) aggregate report as PDF or JSON. Includes statistics, incident summaries, and compliance metrics required by agencies like USFA/NERIS.

This is async, returns 202 with report_id and job_id. Full request/error details in the contract reference above.

GET /api/v1/reports/{report_id}

Returns the generated report. If still processing, returns 202 with retry_after_seconds. When complete, returns PDF binary or JSON depending on the original request format.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Fields

No fields configured for issues without a type.

Projects

Status
No status

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions