Put datainsightsv1.1reportsreport_idchartschart_id

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

Reports

put/datainsights/v1.1/reports/{report_id}/charts/{chart_id}

Path parameters

report_idinteger required

Report id of the resource

chart_idinteger required

Id For the chart

Headers

X-PROPERTY-IDinteger required

Property id of the client

Request body

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 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 request

{
  "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"
}

Response