Sign in

v1

latestOpenAPI 3.0.42026-08-06124112344.5 KB
Report

Generate and export a report.

post/report/export

Query parameters

exclude_bodyboolean

Exclude the generated report body in the response. This report is always available at the URL provided in the X-RevelDigital-GeneratedReportUrl response header value.

Request body

report_idstring nullable required

Report name

format'XML' | 'CSV' | 'IMAGE' | 'PDF' | 'EXCEL' | 'WORD' | 'HTML' | 'MHTML'
activity_typestring nullable

Activity type

interval_type'Minute' | 'Hour' | 'Day' | 'Month'

Specifies the time interval granularity for aggregating analytics data. Used with reporting and analytics endpoints to control data grouping.

start_datestring date-time nullable

Report start date.

Provide in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

end_datestring date-time nullable

Report end date.

Provide in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

start_timestring date-time nullable

Report start time.

Provide in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

end_timestring date-time nullable

Report end time.

Provide in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

device_idstring[] nullable

Array of devices by Id to include in report

user_idstring[] nullable

Array of users by Id to include in report

media_idstring[] nullable

Array of media items by Id to include in report

Response

OK