---
title: "Create a report"
method: POST
path: "/api/v1/deployments/{deploymentId}/reports"
tags: ["Reports"]
---

# Create a report

`POST /api/v1/deployments/{deploymentId}/reports`

## Path parameters

- `deploymentId` number, required

## Request body

- CreateReportInput
  - `endResultCell` string, nullable
  - `externalWorkbookId` string, nullable
  - `folderId` integer, nullable
  - `jsonQuery` string, nullable
  - `meta` object, nullable
  - `name` string, nullable
  - `pivotItems` PivotItemsInput
    - `columns` string[], required
    - `filters` string[], required
    - `measures` string[], required
    - `rows` string[], required
  - `publicId` string, nullable
  - `resultLocation` string, nullable
  - `source` 'GOOGLE_SHEETS' | 'EXCEL' | 'PLAYGROUND' | 'D3'
  - `sqlQuery` string, nullable
  - `title` string, nullable
  - `workbookId` integer, nullable

## Response `200`

- Report
  - `canEdit` boolean, nullable
  - `canManage` boolean, nullable
  - `createdAt` union, required
    - string, date
    - string, date-time
  - `createdBy` integer
  - `deploymentId` integer, required
  - `description` string, nullable
  - `endResultCell` string, nullable
  - `externalWorkbookId` string, nullable
  - `externalWorkbookPlacements` ReportPlacement[], nullable
    - `endResultCell` string, nullable
    - `resultLocation` string, required
    - `workbookId` string, required
  - `folderId` integer, nullable
  - `folderPath` WorkspaceFolderPathEntry[]
    - `id` integer, required
    - `name` string, required
  - `id` integer, required
  - `jsonQuery` string, nullable
  - `meta` object, nullable
  - `name` string, required
  - `pivotItems` PivotItems
    - `columns` string[], required
    - `filters` string[], required
    - `measures` string[], required
    - `rows` string[], required
  - `publicId` string, required
  - `refreshedBy` integer, nullable
  - `refreshedByUser` ResourceOwner, required
    - `email` string, required
    - `firstName` string, nullable
    - `id` integer, required
    - `picture` string, nullable
  - `resultLocation` string, nullable
  - `rolesWithAccess` RoleWithAccess[], nullable
    - `actions` string[], required
    - `id` integer, required
    - `name` string, required
  - `source` 'GOOGLE_SHEETS' | 'EXCEL' | 'PLAYGROUND' | 'D3'
  - `sqlQuery` string, nullable
  - `title` string, nullable
  - `type` 'FOLDER' | 'WORKBOOK' | 'REPORT', required
  - `updatedAt` union, required
    - string, date
    - string, date-time
  - `user` ResourceOwner, required
    - `email` string, required
    - `firstName` string, nullable
    - `id` integer, required
    - `picture` string, nullable
  - `userId` integer, required
  - `version` integer, nullable
  - `workbookId` integer, nullable

---

[API](https://skmtc.net/cube-js/apis/cube-cloud-rest-api.md) · [All operations](https://skmtc.net/cube-js/apis/cube-cloud-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cube-js/cube-cloud-rest-api/revisions/a0c6b1d2ac96/schema)