PApaddlehq
Metrics

Get checkout conversion metrics

Changed on

Returns timeseries data for checkout conversion in a given date range. Trends have a daily granularity. The conversion rate for checkouts in the period. A checkout is considered converted when a payment is successfully completed.

When to and from are the same, returns an empty timeseries.

get/metrics/checkout-conversion

Request

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

Query parameters

fromstring date required

Return data from a specific date. Pass an RFC 3339 full-date string. Interpreted at 00:00 UTC. Must be before or the same as to.

tostring date required

Return data up to a specific date. Pass an RFC 3339 full-date string. Interpreted as 00:00 UTC. Must be after or the same as from.

Response

The request has succeeded.

Example response

{
  "data": {
    "timeseries": [
      {
        "timestamp": "2024-10-12T07:20:50.52Z",
        "count": 151,
        "completed_count": 5,
        "rate": "0.033113"
      }
    ],
    "starts_at": "2024-10-12T07:20:50.52Z",
    "ends_at": "2024-10-12T07:20:50.52Z",
    "updated_at": "2024-10-13T07:20:50.52Z"
  },
  "meta": {
    "request_id": "b15ec92e-8688-40d4-a04d-f44cbec93355"
  }
}

Changes