---
title: "CreateReport adds a virtual file for a report, triggers a reconcile, and waits for the report to be added to the runtime catalog"
method: POST
path: "/v1/orgs/{org}/projects/{project}/reports"
---

# CreateReport adds a virtual file for a report, triggers a reconcile, and waits for the report to be added to the runtime catalog

`POST /v1/orgs/{org}/projects/{project}/reports`

## Path parameters

- `org` string, required
- `project` string, required

## Request body

- object
  - `options` V1ReportOptions
    - `canvas` string
    - `displayName` string
    - `emailRecipients` string[]
    - `explore` string
    - `exportFormat` 'EXPORT_FORMAT_UNSPECIFIED' | 'EXPORT_FORMAT_CSV' | 'EXPORT_FORMAT_XLSX' | 'EXPORT_FORMAT_PARQUET' | 'EXPORT_FORMAT_PDF'
    - `exportIncludeHeader` boolean
    - `exportLimit` string, uint64
    - `intervalDuration` string
    - `metricsViewFilters` object — Per-metrics-view filters of the canvas at scheduling time (canvas PDF reports only). Baked into the report's security rules so magic-token recipients cannot query unfiltered data.
    - `queryArgsJson` string
    - `queryName` string
    - `refreshCron` string
    - `refreshTimeZone` string
    - `resolver` string
    - `resolverProperties` object
    - `slackChannels` string[]
    - `slackUsers` string[]
    - `slackWebhooks` string[]
    - `webOpenMode` string
    - `webOpenPath` string — Annotation for the subpath of <UI host>/org/project to open for the report.
    - `webOpenState` string — Annotation for the base64-encoded UI state to open for the report.

## Response `200`

A successful response.

- V1CreateReportResponse
  - `name` string

## Other responses

- `default` — An unexpected error response.

## Changes

> 54 revisions in range; 1 could not be searched.

- **2026-08-04** (v1) `289a0ca9ce49` — 2 info
  - added the new optional request property `options/metricsViewFilters`
  - added the new `EXPORT_FORMAT_PDF` enum value to the request property `options/exportFormat`
- **2026-02-19** (v1) `d4ab4aabb90d` — 1 warning, 2 info
  - removed the request property `options/filter`
  - added the new optional request property `options/resolver`
  - added the new optional request property `options/resolverProperties`
- **2026-01-09** (v1) `9517006b9437` — 1 info
  - added the new `OPERATION_CAST` enum value to the request property `options/filter/cond/op`
- **2025-12-11** (v1) `f317ff96998d` — 2 warning, 1 info
  - removed the request property `options/resolver`
  - removed the request property `options/resolverProperties`
  - added the new optional request property `options/filter`

[Change history](https://skmtc.dev/rilldata/apis/rill-admin-api/changes/v1/orgs/:org/projects/:project/reports/post.md)

---

[API](https://skmtc.dev/rilldata/apis/rill-admin-api.md) · [All operations](https://skmtc.dev/rilldata/apis/rill-admin-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/rilldata/rill-admin-api/revisions/abe7a430f373/schema)