Retrieve all available chart types and their supported axis configurations

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Retrieves all available chart types and their supported axis configurations for creating chart-based custom reports.

Request URL

https://{server-hostname}:8383/dcapi/reports/customReports/availableCharts Copied!

Scope

CustomReport.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/availableCharts.v1+jsonapplication/availableCharts.v1+jsonCopied!

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/dcapi/reports/customReports/availableCharts \
  --header 'Accept: application/availableCharts.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
availableChartsJSON Array

Array of chart type objects with their axis configurations

Show Sub-Attributes
JSON Object
Show Sub-Attributes
chartTypestring

Chart type identifier: bar, line, area, pie, dial, pyramid, funnel. Used in chartMeta.chartType when creating a chart report

displayNamestring

Localized display name of the chart type

axisSupportedarray

Array of supported axis identifiers (e.g., xAxis, yAxis)

chartTypestring

Chart type identifier: bar, line, area, pie, dial, pyramid, funnel. Used in chartMeta.chartType when creating a chart report

displayNamestring

Localized display name of the chart type

axisSupportedarray

Array of supported axis identifiers (e.g., xAxis, yAxis)

- HTTP code 401

Response Body - application/json
JSON Object
Hide Sub-Attributes
error_codestring

Unauthorized error code: API key or OAuth token missing, expired or invalid

error_descriptionstring

Authentication failure reason

- HTTP code 403

Response Body - application/json
JSON Object
Hide Sub-Attributes
error_codestring

Forbidden error code: the user lacks the required MDM_OSUpdateMgmt UEM role

error_descriptionstring

Message indicating insufficient privileges

- HTTP code 417

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodestring

Expectation failed error code: Custom Report V2 is not enabled

errorMessagestring

Message indicating Custom Report V2 feature is not active

- HTTP code 429

Response Body - application/json
JSON Object
Hide Sub-Attributes
error_codestring

Rate limit error code: API call threshold exceeded for this endpoint group

error_descriptionstring

Rate limit exceeded message with retry guidance

Sample Response: HTTP 200

All available chart types with axis configurations

Copied!
  {
    "availableCharts": [
      {
        "displayName": "Bar Chart",
        "axisSupported": [
          "xAxis",
          "yAxis"
        ],
        "chartType": "bar"
      },
      {
        "displayName": "Line Chart",
        "axisSupported": [
          "xAxis",
          "yAxis"
        ],
        "chartType": "line"
      },
      {
        "displayName": "Area Chart",
        "axisSupported": [
          "xAxis",
          "yAxis"
        ],
        "chartType": "area"
      },
      {
        "displayName": "Pie Chart",
        "axisSupported": [
          "xAxis",
          "yAxis"
        ],
        "chartType": "pie"
      },
      {
        "displayName": "Dial Chart",
        "axisSupported": [
          "xAxis",
          "yAxis"
        ],
        "chartType": "dial"
      },
      {
        "displayName": "Pyramid Chart",
        "axisSupported": [
          "xAxis",
          "yAxis"
        ],
        "chartType": "pyramid"
      },
      {
        "displayName": "Funnel Chart",
        "axisSupported": [
          "xAxis",
          "yAxis"
        ],
        "chartType": "funnel"
      }
    ]
  }
                
▼ Show full

Sample Response: HTTP 401

Missing or invalid authentication token

Copied!
  {
    "errorMessage": "Authentication token is missing or invalid",
    "errorCode": "401"
  }
                
▼ Show full

Sample Response: HTTP 403

User does not have the required role

Copied!
  {
    "errorMessage": "User does not have the required role to access this resource",
    "errorCode": "403"
  }
                
▼ Show full

Sample Response: HTTP 417

Custom Report V2 is not enabled

Copied!
  {
    "errorMessage": "Custom Report V2 is not enabled",
    "errorCode": "417"
  }
                
▼ Show full

Sample Response: HTTP 429

Rate limit exceeded

Copied!
  {
    "errorMessage": "Rate limit exceeded. Please retry after some time",
    "errorCode": "429"
  }
                
▼ Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.