Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
reportChart

Return a particular report chart by id

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

Path parameters

orgIdstring required

Org identifier (either id or slug)

chartIdstring required

Chart id

Response

successful operation

idstring required

globally unique id

orgIdstring required

parent organization id

reportIdstring

parent report id

labelstring required

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' required

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

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

updateIdstring

last updated by user id

updateBehalfIdstring

last updated on behalf of user id

updateAtstring

last updated timestamp

deleteIdstring

deleted by user id

deleteBehalfIdstring

deleted on behalf of user id

deleteAtstring

deleted timestamp

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "reportId": "588f7ee98f138b19220041a7",
  "label": "Headcount Report",
  "filter": "department='Engineering'",
  "query": {
    "series": [
      {
        "y": "sum{headcount, gender:f} / sum{headcount}",
        "groupByConfigs": [
          {
            "fieldId": "588f7ee98f138b19220041a7",
            "questionId": "588f7ee98f138b19220041a7"
          }
        ]
      }
    ]
  },
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "createAt": "2017-01-24T13:57:52Z",
  "updateId": "588f7ee98f138b19220041a7",
  "updateBehalfId": "588f7ee98f138b19220041a7",
  "updateAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "updateAt": "2017-01-24T13:57:52Z",
  "deleteId": "588f7ee98f138b19220041a7",
  "deleteBehalfId": "588f7ee98f138b19220041a7",
  "deleteAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "deleteAt": "2017-01-24T13:57:52Z"
}