---
title: "Create Report Run"
method: POST
path: "/v1/reporting/reports/runs"
---

# Create Report Run

`POST /v1/reporting/reports/runs`

## Request

- Base URL: `https://app.untetherlabs.com/api`
- URL: `https://app.untetherlabs.com/api/v1/reporting/reports/runs`
- Auth: HTTP bearer

<Warning>This is a beta endpoint. Breaking changes may occur without notice, use at your own risk.</Warning>

Create a new report run for the given report ID.

The report parameters depend on the report being executed,
see the report documentation for more info.

Reports are generated asynchronously. The returned object
will always be marked as `running`, you will have to
periodically poll for status changes.

## Request body

- CreateReportRunRequest
  - `reportId` string, required
  - `parameters` object

## Response `201`

- ReportRun
  - `id` string, uuid, required
  - `reportId` string, required
  - `createdAt` string, required
  - `createdBy` ReportUser, required
    - `id` string, uuid, required
    - `name` string, required
  - `status` 'running' | 'completed' | 'failed', required
  - `file` object: Only present if the report has been completed.
    - `name` string, required
    - `mediaType` string, required
    - `sizeBytes` number, required

## Other responses

- `400`: We follow the [RFC-9457](https://www.rfc-editor.org/rfc/rfc9457.html) Problem Detail specification for error responses. Errors should be identified by their `type` field. You can view extensions for each error response below.
- `404`: We follow the [RFC-9457](https://www.rfc-editor.org/rfc/rfc9457.html) Problem Detail specification for error responses. Errors should be identified by their `type` field. You can view extensions for each error response below.

---

[API](https://skmtc.dev/untetherlabs/apis/untether-labs-api.md) - [All operations](https://skmtc.dev/untetherlabs/apis/untether-labs-api/llms.txt) - [OpenAPI document](https://skmtc.dev/untetherlabs/apis/untether-labs-api/revisions/143223935df3?raw)