Docs

Metrics

Metrics return timeseries data about the information in your Paddle account.

Metrics are a way of querying aggregated data from your Paddle account.

Unlike reports, which export a historical snapshot of your entities as a CSV, metrics return timeseries data directly in the API response. They're typically used for powering dashboards and analytics.

Metrics return information like:

  • An array of timestamped datapoints for a period of time
  • The date range covered
  • The granularity of the data
  • The currency amounts are expressed in, where relevant

You pass a date range using the from and to query parameters, and Paddle returns one datapoint per interval in that range.

Response format

Datapoints include different value fields depending on the metric:

  • Amount-based

    Metrics related to revenue return an amount field, expressed as a string representing a non-decimal amount in the smallest currency unit.

  • Count-based

    Metrics related to subscriber or other actions counts return a count field.

  • Mixed

    Some metrics return both an amount and a count field, and may include other fields. For example, checkout conversion returns count, completed_count, and rate.

Was this page helpful?