reportChart

Update an existing report chart

patch/v1/org/{orgId}/report/chart/{chartId}

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/org/{orgId}/report/chart/{chartId}
  • Auth: none declared

Path parameters

orgIdstring required

Org identifier (either id or slug)

chartIdstring required

Chart id

Request body

labelstring

chart label

type'LINE' | 'AREA' | 'STACKED' | 'BAR' | 'VERTICAL_BAR' | 'HORIZONTAL_BAR' | 'PIE' | 'TABLE' | 'TABLE_CROSSTAB' | 'SINGLE_METRIC' | 'BUBBLE' | 'HEADER' | 'TEXT' | 'GAUGE' | 'WATERFALL' | 'WATERFALL_TIMESERIES' | 'HEATMAP' | 'GEO' | 'GEO_HEATMAP' | 'GEO_SCATTER' | 'RADAR' | 'N_GRID' | 'NETWORK' | 'COMBO' | 'COMBO_TIMESERIES' | 'DONUT' | 'FUNNEL' | 'FUNNEL_TIMESERIES' | 'SANKEY' | 'SANKEY_TIMESERIES' | 'WORDCLOUD' | 'EMOJI_CLOUD' | 'CALENDAR_HEATMAP' | 'GANTT'

chart type

filterstring

filter that applies to this chart

filterOverrideboolean

whether the chart filter overrides the global filter

sortinteger

sort order

isAdvancedQueryModeboolean

whether the chart configuration is using advanced mode

Example request

{
  "label": "Headcount Report",
  "filter": "department='Engineering'",
  "query": {
    "series": [
      {
        "y": "sum{headcount, gender:f} / sum{headcount}",
        "groupByConfigs": [
          {
            "fieldId": "588f7ee98f138b19220041a7",
            "questionId": "588f7ee98f138b19220041a7"
          }
        ]
      }
    ]
  }
}

Response

updated

Changes

No recorded changes to this operation across all 20 revisions of this API.