GOgovernment-digital-service
Reports

Get platform performance report (total volume and total_amount) for the date range and transaction state. Queries transaction_summary table for stats

Changed on
get/v1/report/performance-report

Request

  • Base URL
    http://ledger_url
  • URL
    http://ledger_url/v1/report/performance-report
  • Auth
    none declared

Query parameters

from_datestring

From date of the transaction summary to be searched (this date is inclusive). Required when to_date is provided

to_datestring

To date of the transaction summary to be searched (this date is inclusive). Required when from_date is provided

state'UNDEFINED' | 'STARTED' | 'CAPTURABLE' | 'FAILED_REJECTED' | 'FAILED_EXPIRED' | 'FAILED_CANCELLED' | 'CANCELLED' | 'CREATED' | 'SUBMITTED' | 'SUCCESS' | 'ERROR' | 'ERROR_GATEWAY' | 'NEEDS_RESPONSE' | 'UNDER_REVIEW' | 'LOST' | 'WON'

Transaction state

Response

OK

average_amountnumber
total_amountnumber
total_volumeinteger

Example response

{
  "average_amount": 1000,
  "total_amount": 1000,
  "total_volume": 1
}

Changes

  • 450e568b5b08Revision changes
    • warning

      added the new AMOUNT_BELOW_MINIMUM_FOR_ADYEN enum value to the response property for the response status

    • warning

      added the new AMOUNT_BELOW_MINIMUM_FOR_STRIPE enum value to the response property for the response status

    • info

      removed the AMOUNT_BELOW_MINIMUM enum value from the response property for the response status

  • ef12d134c115Revision changes
    • warning

      added the new AMOUNT_BELOW_MINIMUM enum value to the response property for the response status