---
title: "Get Chart Definitions"
method: GET
path: "/v2/charts/definitions"
tags: ["Charts V2"]
---

# Get Chart Definitions

`GET /v2/charts/definitions`

Returns available chart definitions including y-axis metrics, x-axis dimensions, breakdowns, filters, and date presets. This is static configuration data. Requires charts:read scope.

## Query parameters

- `application_id` string, required — Application ID (required for org resolution)

## Response `200`

Success

- object
  - `object` 'chart_definitions', required — Object type, always `chart_definitions`
  - `y_axis` object[], required — Available y-axis metrics
    - `key` string, required — Metric key
    - `name` string, required — Display name
    - `description` string, required — Description of the metric
    - `value_type` 'number' | 'percentage' | 'currency', required — How to format the value
    - `extra` object[] — Additional values rendered as sub-rows in chart tables
      - `key` string, required — Metric key
      - `name` string, required — Display name
      - `description` string, required — Description of the metric
      - `value_type` 'number' | 'percentage' | 'currency', required — How to format the value
    - `aggregate_total` object — How to aggregate percentage totals from extra metric values
      - `numerator_key` string, required — Extra metric key to sum for the aggregate total numerator
      - `denominator_key` string, required — Extra metric key to sum for the aggregate total denominator
  - `x_axis` object[], required — Available x-axis dimensions
    - `key` string, required — Dimension key
    - `name` string, required — Display name
    - `description` string, required — Description of the dimension
    - `value_type` 'date' | 'string', required — Value type of the dimension
    - `fill_missing_values` 'zero' | 'cumulative' — How missing x-axis values are filled
    - `date_intervals` object[] — Supported date interval options for this x-axis
      - `key` 'auto' | 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year' | 'totals', required — Interval key
      - `name` string, required — Display name
      - `description` string, required — Description of the interval
      - `active` boolean
  - `breakdowns` object[], required — Available breakdown dimensions
    - `key` string, required — Breakdown key
    - `name` string, required — Display name
    - `description` string, required — Description of the breakdown
    - `active` boolean, required — Whether this breakdown is currently active
    - `value_type` 'string' | 'date', required — Value type of the breakdown
    - `group` string — Group this breakdown belongs to
  - `filters` object[], required — Available filters
    - `key` string, required — Filter key
    - `name` string, required — Display name
    - `description` string, required — Description of the filter
    - `active` boolean, required — Whether this filter is currently active
    - `value_type` 'string' | 'date', required — Value type of the filter
    - `value` union[] — Currently selected values
      - union
        - string
        - number
    - `depends_on` string — Filter key that must be selected before this filter is available
  - `date_presets` string[], required — Available date presets
  - `date_intervals` object[], required — Available date intervals
    - `key` 'auto' | 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year' | 'totals', required — Interval key
    - `name` string, required — Display name
    - `description` string, required — Description of the interval
  - `chart_types` object[], required — Available chart types
    - `key` string, required — Chart type key
    - `name` string, required — Display name
    - `description` string, required — Description of the chart type
    - `group` string — Group this chart type belongs to
    - `x_axis` string, required — Default x-axis dimension
    - `y_axis` string, required — Default y-axis metric
    - `date_dimension` 'purchaseDate' | 'installDate' | 'firstPurchaseDate' | 'tsDate' | 'mrrDate', required — Default date dimension
    - `include` string[], required — Additional metrics included by default
    - `default_breakdown` string — Default breakdown dimension
    - `default_chart_type` 'line' | 'stackedArea' | 'bar' | 'stackedBar' — Default visualization type
    - `chart_type_options` string[] — Allowed visualization types
    - `icon` string — Dashboard icon key
    - `force_no_breakdown` boolean — When true, this chart must always render as a single combined series (no breakdown)

## Other responses

- `400` — The request did not match the expected schema
- `401` — No API key was provided in the request
- `403` — The API key does not have permission to perform this action
- `404` — The requested resource was not found
- `429` — Too many requests have been made in a short period
- `500` — An unexpected error occurred on the server

---

[API](https://skmtc.dev/superwall/apis/superwall-api-v2.md) · [All operations](https://skmtc.dev/superwall/apis/superwall-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/superwall/superwall-api-v2/revisions/44900ad77d2c/schema)