# Retrieve all available chart types and their supported axis configurations

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

## Endpoints

**GET** `/dcapi/reports/customReports/availableCharts`

## Request URL

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

## Scope

`CustomReport.READ`

## Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

## Request Parameters

### Request Headers

- **Accept** `string` — **Mandatory**
  - `application/availableCharts.v1+json`

## Sample Request

```curl
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`

- **availableCharts** `JSON array`
  - Array of chart type objects with their axis configurations

### HTTP code 401

#### Response Body — application/json

`JSON object`

- **errorCode** `long`
  - Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)
- **errorMsg** `string`
  - Authentication failure reason

### HTTP code 403

#### Response Body — application/json

`JSON object`

- **errorCode** `long`
  - Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)
- **errorMsg** `string`
  - Message indicating insufficient privileges to access this resource

### HTTP code 417

#### Response Body — application/json

`JSON object`

- **errorCode** `string`
  - Expectation failed error code: Custom Report V2 is not enabled
- **errorMessage** `string`
  - Message indicating Custom Report V2 feature is not active

### HTTP code 429

#### Response Body — application/json

`JSON object`

- **errorCode** `long`
  - Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes
- **errorMsg** `string`
  - Rate limit exceeded message with retry guidance

## Possible Response Codes

- **200** `HTTP code`
- **401** `HTTP code`
- **403** `HTTP code`
- **417** `HTTP code`
- **429** `HTTP code`

## Sample Response: HTTP 200

All available chart types with axis configurations

```json
{
  "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"
    }
  ]
}
```

## Sample Response: HTTP 401

Missing or invalid authentication token

```json
{
  "errorMessage": "Authentication token is missing or invalid",
  "errorCode": "401"
}
```

## Sample Response: HTTP 403

User does not have the required role

```json
{
  "errorMessage": "User does not have the required role to access this resource",
  "errorCode": "403"
}
```

## Sample Response: HTTP 417

Custom Report V2 is not enabled

```json
{
  "errorMessage": "Custom Report V2 is not enabled",
  "errorCode": "417"
}
```

## Sample Response: HTTP 429

Rate limit exceeded

```json
{
  "errorMessage": "Rate limit exceeded. Please retry after some time",
  "errorCode": "429"
}
```

![ ](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png)

**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.