---
title: "Generate and export a report."
method: POST
path: "/report/export"
tags: ["Report"]
---

# Generate and export a report.

`POST /report/export`

## Request

- Base URL: `https://api.reveldigital.com`
- URL: `https://api.reveldigital.com/report/export`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://id.reveldigital.com/connect/authorize`
    - Token URL: `https://id.reveldigital.com/connect/token` scopes: `webapi`
  - API key in header `X-RevelDigital-ApiKey`
  - API key in query parameter `api_key`
- TypeScript: <https://skmtc.dev/reveldigital/apis/revel-digital-rest-api/docs/report/export/post.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `exclude_body` boolean

## Request body

- ReportExportPostBody: Represents the body of a request to export a report, including details such as the report identifier, export format, activity type, reporting interval, date and time ranges, and filters for devices, users, and media items.
  - `report_id` string, nullable, required: Report name
  - `format` 'XML' | 'CSV' | 'IMAGE' | 'PDF' | 'EXCEL' | 'WORD' | 'HTML' | 'MHTML'
  - `activity_type` string, 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_date` string, date-time, nullable: Report start date. Provide in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
  - `end_date` string, date-time, nullable: Report end date. Provide in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
  - `start_time` string, date-time, nullable: Report start time. Provide in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
  - `end_time` string, date-time, nullable: Report end time. Provide in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
  - `device_id` string[], nullable: Array of devices by Id to include in report
  - `user_id` string[], nullable: Array of users by Id to include in report
  - `media_id` string[], nullable: Array of media items by Id to include in report

## Response `200`

OK

---

[API](https://skmtc.dev/reveldigital/apis/revel-digital-rest-api.md) - [All operations](https://skmtc.dev/reveldigital/apis/revel-digital-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/reveldigital/apis/revel-digital-rest-api/revisions/39d5c8302822?raw)