---
title: "List Explore metric entities"
method: GET
path: "/metrics/explore/entities"
tags: ["Metrics"]
---

# List Explore metric entities

`GET /metrics/explore/entities`

## Request

- Base URL: `https://sandbox-api.paddle.com`
- URL: `https://sandbox-api.paddle.com/metrics/explore/entities`
- Auth: HTTP bearer

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.

## Query parameters

- `entity` 'transactions.completed' | 'adjustments.refunds' | 'adjustments.chargebacks' | 'checkouts' | 'subscriptions': 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`.

## Response `200`

The request has succeeded.

- object
  - `data` MetricEntityDefinition[], required
    - `entity` 'transactions.completed' | 'adjustments.refunds' | 'adjustments.chargebacks' | 'checkouts' | 'subscriptions', required: 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`.
    - `time_dimension` MetricEntityTimeDimension, required: The metric's time axis and the bucketing it allows when querying.
      - `intervals` MetricsBucketInterval[], required: Allowed grouping intervals for the metric's time dimension.
      - `max_lookback_days` integer, required: Maximum supported look-back window, in days, when querying this metric.
    - `dimensions` MetricEntityDimension[], required: Dimensions available to group and filter this metric by.
      - `name` string, required: Dimension identifier.
      - `type` 'string' | 'integer' | 'decimal' | 'currency', required: Value type of a metrics field, whether a dimension or a measure. Numeric values are returned as strings to preserve precision.
      - `filter_ops` MetricsFilterOperator[], required: Filter operators supported for this dimension.
      - `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.
    - `measures` MetricEntityMeasure[], required: Measures available to select and aggregate.
      - `name` string, required: Measure identifier.
      - `type` 'string' | 'integer' | 'decimal' | 'currency', required: Value type of a metrics field, whether a dimension or a measure. Numeric values are returned as strings to preserve precision.
      - `aggs` MetricsAggregation[], nullable, required: Allowed aggregations for this measure. `null` means the field is returned as-is and cannot be aggregated.
  - `meta` Meta, 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.

## Other responses

- `default`: An unexpected error response.

## Changes

- **2026-10-19** (v1) `4f35a8c6ea4d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/paddlehq/apis/paddle-api/changes/metrics/explore/entities/get.md)

---

[API](https://skmtc.dev/paddlehq/apis/paddle-api.md) - [All operations](https://skmtc.dev/paddlehq/apis/paddle-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paddlehq/apis/paddle-api/revisions/bbc0c72039c8?raw)