---
title: "Get all charts"
method: GET
path: "/datainsights/v1.1/charts"
tags: ["Chart"]
---

# Get all charts

`GET /datainsights/v1.1/charts`

## Query parameters

- `offset` integer
- `limit` integer
- `sort` 'id,asc' | 'id,desc' | 'title,asc' | 'title,desc' | 'kind,asc' | 'kind,desc' | 'created_at,asc' | 'created_at,desc' | 'updated_at,asc' | 'updated_at,desc'
- `ids` integer[]
- `datasource_kind` 'report' | 'stock_report'
- `tag_ids` integer[]
- `chart_kind` string[]
- `dataset_ids` integer[]

## Headers

- `X-PROPERTY-ID` integer, required

## Response `200`

OK

- Charts
  - `offset` integer — The difference between start of the data and the start of the response data
  - `limit` integer — The maximum number of results in the response
  - `total` integer — The total number of records
  - `charts` Chart[]
    - `id` integer, required — Chart Id
    - `datasource_id` integer, required — ID of the datasource
    - `datasource_kind` 'report' | 'stock_report', required — Datasource Kind
    - `datasource_title` string — Title of the datasource
    - `datasource_description` string — Description of the datasource
    - `title` string, required — Chart title
    - `kind` 'line' | 'bar' | 'area' | 'pie' | 'donut' | 'sunburst' | 'treemap' | 'geomap' | 'heatmap' | 'combo', required — Kind of chart
    - `settings` ChartSettings
      - `legend` boolean — Toggle to show/hide legend
      - `toolbox` boolean — Toggle to show/hide the toolbox
      - `metrics` ChartSettingsMetrics[] — List of CDFs with metrics and vertical axis to represent data.
        - `cdf` ReportCDF, required
          - `type` 'default' | 'custom' — Report cdf type
          - `column` string, required — Report cdf name
          - `multi_level_id` 1 | 2 | 3 | 4 — Multi-level where CDF is located
        - `metric` 'sum' | 'mean' | 'max' | 'min' | 'count' | 'std' | 'var' — Chart metric. Not required for dynamic cdfs
        - `kind` 'line' | 'bar' | 'area', required — Kind of chart
        - `axis` 'left' | 'right', required — Left or right vertical axis
      - `stack` 'normalized' | 'standard' — Stack option of Chart kind bar
    - `categories` string — List of CDFs in group rows or group columns (or the text string "Periods" for period comparison reports) to categorize data. Categories are represented horizontally (x-axis) on most charts
    - `metrics` ReportColumns[] — List of CDFs with metrics to represent data. Metrics will be represented vertically (y-axis) on most charts.
      - `cdf` ReportCDF, required
        - `type` 'default' | 'custom' — Report cdf type
        - `column` string, required — Report cdf name
        - `multi_level_id` 1 | 2 | 3 | 4 — Multi-level where CDF is located
      - `metrics` string[] — Report column metrics
    - `user_id` integer, required — User id
    - `created_at` string — Created At Time
    - `updated_at` string — Updated At Time

## Other responses

- `400` — Bad Request
- `500` — Internal Server Error

---

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