Sign in
reports

Generate a report from a template

Changed on
post/reports/generate

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/reports/generate
  • Auth: one of:
    • API key in cookie session
    • HTTP bearer

Request body

templateIdinteger required
parametersobject
titlestring

Response

Report generated

idinteger required
titlestring required
templateIdinteger nullable
status'draft' | 'under_review' | 'approved' | 'published' | 'archived' required
generatedByinteger nullable
parametersobject nullable
pdfUrlstring nullable
versioninteger required
createdAtstring date-time required
updatedAtstring date-time

Changes