Sign in
Reports

Create report

post/reports

Request body

Example request

{
  "report": {
    "start_date": "2024-02-29",
    "end_date": "2024-03-07",
    "time_zone": "America/New_York"
  }
}

Response

OK

idinteger required

The ID of the report

resource_type'Report' required

The resource type of the report

namestring required

The name of the report

status'waiting' | 'in_progress' | 'finished' | 'failed' required

The status of the report.

created_atstring date-time required

When the report was created

updated_atstring date-time required

When the report was updated

start_datestring date required

The start date of the interval used to filter the data for the report. This timestamp is expected to be in date format, YYYY-MM-DD. If provided, it defines the beginning of the reporting period. The interval cannot be shorter than the minimum and cannot be longer than the maximum, as defined by the reporter. Current minimum interval days: no limit Current maximum interval days: 180

end_datestring date required

The end date of the interval used to filter the data for the report. This timestamp is expected to be in date format, YYYY-MM-DD. If provided, it defines the end of the reporting period. The interval cannot be shorter than the minimum and cannot be longer than the maximum, as defined by the reporter. Current minimum interval days: no limit Current maximum interval days: 180

time_zonestring time-zone nullable required

The time zone used for interpreting the start and end dates of the report. This should be provided as a valid time zone identifier (e.g., "America/New_York"). If not provided, it defaults to the organization's time zone.

organization_idinteger required

The organization ID of the report

place_idinteger nullable required

The place ID of the report

reporter_idinteger required

The reporter ID of the report

Example response

{
  "start_date": "2024-02-29",
  "end_date": "2024-03-07",
  "time_zone": "America/New_York"
}

Changes

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