Skip to main content
PUT
/
v1
/
public
/
reports
/
{report_id}
Update Report
curl --request PUT \
  --url https://api.sanka.com/v1/public/reports/{report_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reportMetadata": {
    "name": "<string>",
    "description": "<string>",
    "reportType": {
      "type": "<string>"
    },
    "reportFormat": "<string>",
    "reportFilters": {
      "filters": [
        {
          "filter_select": "<string>",
          "filter_operator": "<string>",
          "filter_source": "<string>",
          "filter_type": "<string>",
          "filter_input": [
            {
              "value": "<unknown>"
            }
          ]
        }
      ]
    },
    "detailColumns": [
      "<string>"
    ],
    "groupingsDown": [
      "<string>"
    ],
    "groupingsAcross": [
      "<string>"
    ]
  },
  "panels": [
    {
      "name": "<string>",
      "description": "<string>",
      "panelType": "<string>",
      "dataSourceType": "<string>",
      "dataSource": "<string>",
      "dataSources": [
        "<string>"
      ],
      "ratio": 50,
      "filter": {},
      "metaData": {},
      "typeObjects": [
        "<string>"
      ],
      "metrics": [
        {
          "metric": "<string>",
          "role": "<string>",
          "name": "<string>",
          "metricType": "<string>",
          "order": 123,
          "filter": {},
          "dataSource": "<string>",
          "sort": "<string>",
          "metaData": {},
          "rawSql": "<string>",
          "displayResult": "<string>"
        }
      ],
      "order": 123
    }
  ],
  "createDefaultPanel": false
}
'
{
  "ok": true,
  "status": "<string>",
  "report_id": "<string>",
  "ctx_id": "<string>",
  "report_metadata": {},
  "report_extended_metadata": {}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

report_id
string
required

Query Parameters

workspace_id
string | null

Body

application/json
reportMetadata
PublicUpdateReportMetadataRequest · object
panels
PublicReportPanelRequest · object[] | null
createDefaultPanel
boolean
default:false

Response

OK

ok
boolean
required
status
string
required
report_id
string | null
ctx_id
string | null
report_metadata
Report Metadata · object
report_extended_metadata
Report Extended Metadata · object