---
title: "Update Public Report"
method: PUT
path: "/v2/public/reports/{report_id}"
tags: ["reports"]
---

# Update Public Report

`PUT /v2/public/reports/{report_id}`

## Request

- Base URL: `https://api.sanka.com`
- URL: `https://api.sanka.com/v2/public/reports/{report_id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/sankahq/apis/sanka-public-api/docs/v2/public/reports/:report_id/put.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `report_id` string, required

## Query parameters

- `workspace_id` string, nullable

## Headers

- `X-Workspace-Code` string

## Request body

- ReportUpdateMutationRequest
  - `name` string, nullable
  - `description` string, nullable
  - `description_ja` string, nullable
  - `panel_type` string, nullable
  - `data_source_type` string, nullable
  - `object_sources` string[], nullable
  - `breakdown` string, nullable
  - `x_axis` string, nullable
  - `owner_id` string, nullable
  - `dashboard_id` string, nullable
  - `update_dashboard_assignment` boolean, nullable
  - `is_forecast` boolean, nullable
  - `is_stacked_chart` boolean, nullable
  - `is_realtime` boolean, nullable
  - `ratio` integer, nullable
  - `filter` object, nullable
  - `meta_data` object, nullable
  - `metrics` ReportMetricMutationItem[], nullable
    - `id` string, nullable
    - `role` string, nullable
    - `name` string, nullable
    - `metric` string, required
    - `metric_type` string, nullable
    - `order` integer, nullable
    - `filter` object, nullable
    - `data_source` string, nullable
    - `sort` string, nullable
    - `meta_data` object, nullable
    - `raw_sql` string, nullable
    - `display_result` string, nullable
  - `advanced` object, nullable

## Response `200`

Successful Response

- UpdatePublicReportApiV2PublicReportsReportIdPut200Envelope
  - `success` true, required
  - `data` object, required
  - `meta` EnvelopeMeta, required
    - `ctx_id` string, required
    - `pagination` PaginationMeta
      - `page` integer, required
      - `page_size` integer, required
      - `total` integer, required
      - `next_cursor` string, nullable
    - `toast` ToastMessage
      - `variant` 'success' | 'error' | 'info' | 'warning', required
      - `code` string, required
      - `message` string, required
      - `i18n` ToastMessageI18n, required
        - `en` string, required
        - `ja` string, required

## Other responses

- `401`: Error response
- `403`: Error response
- `422`: Error response

## Changes

- **2026-07-06** `6ce94a6be72c`: 8 info
  - added the optional property `meta/pagination/next_cursor` to the response with the `200` status
  - added the optional property `meta/pagination/next_cursor` to the response with the `401` status
  - added the optional property `meta/pagination/next_cursor` to the response with the `403` status
  - added the optional property `meta/pagination/next_cursor` to the response with the `422` status
  - …4 more
- **2026-06-10** `9099b22c3aae`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/sankahq/apis/sanka-public-api/changes/v2/public/reports/:report_id/put.md)

---

[API](https://skmtc.dev/sankahq/apis/sanka-public-api.md) - [All operations](https://skmtc.dev/sankahq/apis/sanka-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sankahq/apis/sanka-public-api/revisions/16f03a9e3ab9?raw)