AIairtm
Reports

Create a Report

Generate a new report for a given year/month.

To get a PDF or CSV report, you must first request its generation if it does not already exist. To do so, you must provide the year and month

post/reports

Request

Request body

yearnumber double required

The year of the report to generate

monthnumber double required

The month of the report to generate

type'PDF' | 'CSV' | 'XLSX'

Type of activity report

Example request

{
  "year": 2025,
  "month": 6,
  "type": "CSV"
}

Response

Ok

updatedAtstring date-time required

Report end date

createdAtstring date-time required

Report end date

periodTostring date-time required

Report end date

periodFromstring date-time required

Report start date

status'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' required

The current status of the report

  • PENDING: The report is pending generation.
  • IN_PROGRESS: The report is currently being generated.
  • COMPLETED: The report has been generated and is ready for download.
  • FAILED: The report generation failed.
enterpriseUserIdstring uuid required

Unique ID of the enterprise

type'PDF' | 'CSV' | 'XLSX' required

Type of activity report

idstring uuid required

Unique ID of the report

Example response

{
  "type": "CSV"
}

Changes

No recorded changes to this operation across all 1 revision of this API.