> For the complete documentation index, see [llms.txt](https://developer.paddle.com/llms.txt).

# GET /metrics/explore/entities

**List Explore metric entities**

Returns a list of queryable Explore metrics and their related metadata, including time dimension, the dimensions you can group by, and measures with their allowed aggregations.

`subscriptions` isn't available in sandbox, where it's treated as `unknown_entity`.

By default, Paddle returns all metrics that are available. Use the `entity` query parameter to return a single one.

The response is not paginated.

**Required permissions:** `metrics.read`

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `entity` | string | optional | Entity name for a queryable Explore metric. Pass it as the `entity` when you query.

`subscriptions` isn't available in sandbox, where it's treated as `unknown_entity`. |

Values for `entity`:

- `transactions.completed` — Completed transactions and paid invoices. Measures gross revenue and transaction counts.
- `adjustments.refunds` — Refunds issued to customers, excluding chargebacks. Measures refunded amounts and counts.
- `adjustments.chargebacks` — Chargebacks raised against completed transactions, excluding warnings and reversals.
- `checkouts` — Checkout sessions. Measures checkout conversion and completed checkouts.
- `subscriptions` — Active subscriptions. Measures monthly recurring revenue and MRR growth. Not available in sandbox.

## Response (200)

- `data`: array (required)
  - `entity`: string (required) — Entity name for this metric. Pass it as the `entity` when you query.
    - `transactions.completed` — Completed transactions and paid invoices. Measures gross revenue and transaction counts.
    - `adjustments.refunds` — Refunds issued to customers, excluding chargebacks. Measures refunded amounts and counts.
    - `adjustments.chargebacks` — Chargebacks raised against completed transactions, excluding warnings and reversals.
    - `checkouts` — Checkout sessions. Measures checkout conversion and completed checkouts.
    - `subscriptions` — Active subscriptions. Measures monthly recurring revenue and MRR growth. Not available in sandbox.
  - `time_dimension`: object (required) — The metric's time axis and allowed bucketing.
    - `intervals`: array (required) — Allowed grouping intervals for the metric's time dimension.
      - `day` — Daily buckets.
      - `week` — Weekly buckets, starting Monday (UTC).
      - `month` — Monthly buckets, starting on the 1st (UTC).
    - `max_lookback_days`: integer (required) — Maximum supported look-back window, in days, when querying this metric.
  - `dimensions`: array (required) — Dimensions available to group and filter this metric by.
    - `name`: string (required) — Dimension identifier.
    - `type`: string (required) — Value type for the dimension.
      - `string` — String value, such as an identifier or categorical value, e.g. a product ID or country code.
      - `integer` — Integer value.
      - `decimal` — Non-integer numeric value, such as a rate (returned as a string).
      - `currency` — Monetary value, denominated in the response `currency_code` (returned as a string).
    - `filter_ops`: array (required) — Filter operators supported for this dimension.
      - `in` — In the supplied list of values.
    - `multi_valued`: boolean — Whether the dimension can hold more than one value per record. When `true`, a single record can appear under more than one value, so a breakdown on this dimension can total more than the figure with no breakdown applied. `false` if omitted. (default: `false`)
  - `measures`: array (required) — Measures available to select and aggregate.
    - `name`: string (required) — Measure identifier.
    - `type`: string (required) — Value type for the measure.
      - `string` — String value, such as an identifier or categorical value, e.g. a product ID or country code.
      - `integer` — Integer value.
      - `decimal` — Non-integer numeric value, such as a rate (returned as a string).
      - `currency` — Monetary value, denominated in the response `currency_code` (returned as a string).
    - `aggs`: array | null (required) — Allowed aggregations for this measure. `null` means the field is returned as-is and cannot be aggregated.
      - `count` — Count of rows.
      - `count_distinct` — Count of distinct values.
      - `sum` — Sum of values.
- `meta`: object (required) — Information about this response.
  - `request_id`: string (required) — Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.

### Response example

```json
{
  "data": [
    {
      "entity": "adjustments.chargebacks",
      "time_dimension": {
        "intervals": [
          "day",
          "week",
          "month"
        ],
        "max_lookback_days": 1096
      },
      "dimensions": [
        {
          "name": "product",
          "type": "string",
          "filter_ops": [
            "in"
          ],
          "multi_valued": true
        },
        {
          "name": "country",
          "type": "string",
          "filter_ops": [
            "in"
          ]
        },
        {
          "name": "billing_cycle",
          "type": "string",
          "filter_ops": [
            "in"
          ],
          "multi_valued": true
        }
      ],
      "measures": [
        {
          "name": "id",
          "type": "string",
          "aggs": [
            "count",
            "count_distinct"
          ]
        }
      ]
    },
    {
      "entity": "adjustments.refunds",
      "time_dimension": {
        "intervals": [
          "day",
          "week",
          "month"
        ],
        "max_lookback_days": 1096
      },
      "dimensions": [
        {
          "name": "product",
          "type": "string",
          "filter_ops": [
            "in"
          ]
        },
        {
          "name": "country",
          "type": "string",
          "filter_ops": [
            "in"
          ]
        },
        {
          "name": "billing_cycle",
          "type": "string",
          "filter_ops": [
            "in"
          ]
        }
      ],
      "measures": [
        {
          "name": "amount",
          "type": "currency",
          "aggs": [
            "sum"
          ]
        },
        {
          "name": "id",
          "type": "string",
          "aggs": [
            "count",
            "count_distinct"
          ]
        },
        {
          "name": "txn_id",
          "type": "string",
          "aggs": [
            "count",
            "count_distinct"
          ]
        }
      ]
    },
    {
      "entity": "checkouts",
      "time_dimension": {
        "intervals": [
          "day",
          "week",
          "month"
        ],
        "max_lookback_days": 1096
      },
      "dimensions": [
        {
          "name": "product",
          "type": "string",
          "filter_ops": [
            "in"
          ],
          "multi_valued": true
        },
        {
          "name": "country",
          "type": "string",
          "filter_ops": [
            "in"
          ]
        },
        {
          "name": "billing_cycle",
          "type": "string",
          "filter_ops": [
            "in"
          ],
          "multi_valued": true
        }
      ],
      "measures": [
        {
          "name": "id",
          "type": "string",
          "aggs": [
            "count",
            "count_distinct"
          ]
        },
        {
          "name": "completed_checkouts",
          "type": "integer",
          "aggs": null
        },
        {
          "name": "checkout_conversion",
          "type": "decimal",
          "aggs": null
        }
      ]
    },
    {
      "entity": "subscriptions",
      "time_dimension": {
        "intervals": [
          "month"
        ],
        "max_lookback_days": 1096
      },
      "dimensions": [
        {
          "name": "product",
          "type": "string",
          "filter_ops": [
            "in"
          ]
        },
        {
          "name": "country",
          "type": "string",
          "filter_ops": [
            "in"
          ]
        },
        {
          "name": "billing_cycle",
          "type": "string",
          "filter_ops": [
            "in"
          ]
        },
        {
          "name": "subscription_activity",
          "type": "string",
          "filter_ops": [
            "in"
          ]
        }
      ],
      "measures": [
        {
          "name": "mrr",
          "type": "currency",
          "aggs": null
        },
        {
          "name": "mrr_growth",
          "type": "currency",
          "aggs": null
        }
      ]
    },
    {
      "entity": "transactions.completed",
      "time_dimension": {
        "intervals": [
          "day",
          "week",
          "month"
        ],
        "max_lookback_days": 1096
      },
      "dimensions": [
        {
          "name": "product",
          "type": "string",
          "filter_ops": [
            "in"
          ]
        },
        {
          "name": "country",
          "type": "string",
          "filter_ops": [
            "in"
          ]
        },
        {
          "name": "billing_cycle",
          "type": "string",
          "filter_ops": [
            "in"
          ]
        }
      ],
      "measures": [
        {
          "name": "gross_revenue",
          "type": "currency",
          "aggs": [
            "sum"
          ]
        },
        {
          "name": "id",
          "type": "string",
          "aggs": [
            "count",
            "count_distinct"
          ]
        }
      ]
    }
  ],
  "meta": {
    "request_id": "ecd52aa1-a73c-43df-af3b-e87edec3b435"
  }
}
```