Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Reports

get/datainsights/v1.1/reports/{report_id}/charts

Path parameters

report_idinteger required

Report id of the resource

Headers

X-PROPERTY-IDinteger required

Property id of the client

Response

OK

idinteger required

Chart Id

datasource_idinteger required

ID of the datasource

datasource_kind'report' | 'stock_report' required

Datasource Kind

datasource_titlestring

Title of the datasource

datasource_descriptionstring

Description of the datasource

titlestring required

Chart title

kind'line' | 'bar' | 'area' | 'pie' | 'donut' | 'sunburst' | 'treemap' | 'geomap' | 'heatmap' | 'combo' required

Kind of chart

categoriesstring

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

user_idinteger required

User id

created_atstring

Created At Time

updated_atstring

Updated At Time

Example response

[
  {
    "datasource_kind": "stock_report",
    "datasource_title": "My Report",
    "datasource_description": "Detailed Report Description",
    "title": "My cool new chart",
    "kind": "bar",
    "settings": {
      "metrics": [
        {
          "cdf": {
            "type": "default",
            "column": "credit_amount"
          },
          "metric": "sum",
          "kind": "line",
          "axis": "left"
        }
      ],
      "stack": "normalized"
    },
    "categories": "\"Periods\"",
    "metrics": [
      {
        "cdf": {
          "type": "default",
          "column": "credit_amount"
        },
        "metrics": [
          "sum"
        ]
      }
    ],
    "created_at": "2022-01-01T00:00:00Z",
    "updated_at": "2022-01-01T00:00:00Z"
  }
]