Read single section

Get a single section by ID.

POST /api/v1/charts/section/{section_id}

Error

A valid request URL is required to generate request examples

200

{
  "title": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "charts": [
    {
      "data": [
        {
          "series_id": "<string>",
          "timestamp": "2023-11-07T05:31:56Z",
          "value": 123,
          "group": "<string>"
        }
      ],
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "index": 123,
      "series": [
        {
          "name": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "filters": {
            "filter": "<string>",
            "trace_filter": "<string>",
            "tree_filter": "<string>",
            "session": [
              "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            ]
          },
          "feedback_key": "<string>",
          "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "metric_definition": {
            "type": "count",
            "filter": "<string>"
          },
          "group_by_definitions": [
            {
              "attribute": "<string>"
            }
          ],
          "filter_definition": {
            "source_type": "<string>",
            "project_ids": [
              "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            ],
            "run_filter": "<string>",
            "trace_filter": "<string>",
            "tree_filter": "<string>"
          },
          "group_by": {
            "path": "<string>",
            "max_groups": 5
          }
        }
      ],
      "description": "<string>",
      "metadata": {},
      "common_filters": {
        "filter": "<string>",
        "trace_filter": "<string>",
        "tree_filter": "<string>",
        "session": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ]
      }
    }
  ],
  "description": "<string>",
  "index": 123,
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sub_sections": [
    {
      "title": "<string>",
      "index": 123,
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "charts": [
        {
          "data": [
            {
              "series_id": "<string>",
              "timestamp": "2023-11-07T05:31:56Z",
              "value": 123,
              "group": "<string>"
            }
          ],
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "title": "<string>",
          "index": 123,
          "series": [
            {
              "name": "<string>",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "filters": {
                "filter": "<string>",
                "trace_filter": "<string>",
                "tree_filter": "<string>",
                "session": [
                  "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                ]
              },
              "feedback_key": "<string>",
              "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "metric_definition": {
                "type": "count",
                "filter": "<string>"
              },
              "group_by_definitions": [
                {
                  "attribute": "<string>"
                }
              ],
              "filter_definition": {
                "source_type": "<string>",
                "project_ids": [
                  "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                ],
                "run_filter": "<string>",
                "trace_filter": "<string>",
                "tree_filter": "<string>"
              },
              "group_by": {
                "path": "<string>",
                "max_groups": 5
              }
            }
          ],
          "description": "<string>",
          "metadata": {},
          "common_filters": {
            "filter": "<string>",
            "trace_filter": "<string>",
            "tree_filter": "<string>",
            "session": [
              "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            ]
          }
        }
      ],
      "description": "<string>"
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Path Parameters

section_id · string<uuid> · required

Body

application/json

timezone · string · default: UTC

start_time · string<date-time> | null

end_time · string<date-time> | null

stride · TimedeltaInput · object

Timedelta input.

Show child attributes

omit_data · boolean · default: false

group_by · RunStatsGroupBy · object | null

Group by param for run stats.

Show child attributes

Response

200

application/json

Successful Response

title · string · required

id · string<uuid> string · required

charts · SingleCustomChartResponse · object[] · required

Show child attributes

description · string | null

index · integer | null

session_id · string<uuid> | null

sub_sections · SingleCustomChartSubSectionResponse · object[] | null

Show child attributes