PApaddlehq
Metrics

List Explore metric entities

Changed on

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.

get/metrics/explore/entities

Request

  • Base URL
    https://sandbox-api.paddle.com
  • Auth
    HTTP bearer

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.

Return the metric that matches the specified entity name. Omit to return all metrics that are available. An unknown value, including subscriptions in sandbox, returns unknown_entity.

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "time_dimension": {
        "max_lookback_days": 1096
      },
      "dimensions": [
        {
          "name": "country"
        }
      ],
      "measures": [
        {
          "name": "gross_revenue"
        }
      ]
    }
  ],
  "meta": {
    "request_id": "b15ec92e-8688-40d4-a04d-f44cbec93355"
  }
}

Changes