---
title: "Create Report"
method: POST
path: "/v1/public/reports"
tags: ["Reports"]
---

# Create Report

`POST /v1/public/reports`

## Request body

- PublicCreateReportRequest
  - `reportMetadata` PublicReportMetadataRequest, required
    - `name` string, required
    - `description` string, nullable
    - `reportType` PublicReportTypeSchema, required
      - `type` string, required
    - `reportFormat` string, nullable
    - `reportFilters` PublicReportFiltersSchema
      - `filters` PublicReportFilterSchema[]
        - `filter_select` string, required
        - `filter_operator` string, required
        - `filter_source` string, nullable
        - `filter_type` string, nullable
        - `filter_input` PublicReportFilterInputSchema[]
          - `value` unknown, required
    - `detailColumns` string[]
    - `groupingsDown` string[]
    - `groupingsAcross` string[]
  - `panels` PublicReportPanelRequest[]
    - `name` string, nullable
    - `description` string, nullable
    - `panelType` string, nullable
    - `dataSourceType` string, nullable
    - `dataSource` string, nullable
    - `dataSources` string[]
    - `widthUnits` integer, nullable
    - `heightPx` integer, nullable
    - `ratio` integer, nullable
    - `breakdown` string, nullable
    - `filter` object, nullable
    - `metaData` object, nullable
    - `typeObjects` string[]
    - `metrics` PublicReportMetricRequest[]
      - `role` string, nullable
      - `name` string, nullable
      - `metric` string, required
      - `metricType` string, nullable
      - `order` integer, nullable
      - `filter` object, nullable
      - `dataSource` string, nullable
      - `sort` string, nullable
      - `metaData` object, nullable
      - `rawSql` string, nullable
      - `displayResult` string, nullable
    - `order` integer, nullable
  - `createDefaultPanel` boolean

## Response `200`

OK

- PublicCreateReportResponse
  - `ok` boolean, required
  - `status` string, required
  - `report_id` string, nullable
  - `ctx_id` string, nullable
  - `report_metadata` object, nullable
  - `report_extended_metadata` object, nullable

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/sankahq/apis/ninjaapi.md) · [All operations](https://skmtc.net/sankahq/apis/ninjaapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sankahq/ninjaapi/revisions/c273ff62266a/schema)