Skip to main content
GET
/
v1
/
public
/
reports
/
{report_id}
Get Report
curl --request GET \
  --url https://api.sanka.com/v1/public/reports/{report_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "description": "<string>",
  "report_type": "<string>",
  "panel_count": 0,
  "panels": [
    {
      "id": "<string>",
      "order": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "description": "<string>",
      "panel_type": "<string>",
      "data_source_type": "<string>",
      "data_source": "<string>",
      "ratio": 50,
      "filter": {},
      "meta_data": {},
      "type_objects": "<string>",
      "metrics": [
        {
          "id": "<string>",
          "role": "<string>",
          "name": "<string>",
          "metric": "<string>",
          "metric_type": "<string>",
          "order": 0,
          "data_source": "<string>",
          "sort": "<string>",
          "filter": {},
          "meta_data": {}
        }
      ]
    }
  ]
}

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

Response

OK

id
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
name
string | null
description
string | null
report_type
string | null
panel_count
integer
default:0
panels
PublicReportPanelDetailSchema · object[]