Sign in
Analytics

Get payment analytics

Retrieve payment metrics including success rate, failure rate, total volume, and breakdown by payment provider.

get/api/analytics/payments

Query parameters

dateFromstring
Example:2025-01-01
dateTostring
Example:2025-12-31
currencystring
groupBy'day' | 'week' | 'month'
providerstring

Filter by payment provider name

Response

Payment metrics and provider breakdown

totalPaymentsnumber required
succeedednumber required
failednumber required
pendingnumber required
successRatestring required

Success rate percentage

Example response

{
  "totalPayments": 200,
  "succeeded": 180,
  "failed": 15,
  "pending": 5,
  "successRate": "90.00"
}

Changes

Changed in 1 of the 2 revisions of this API.1

  • 0e449a4e0dc81See the full diff
    • ○

      added the media type application/json for the response with the status 200

      response-media-type-added