Retrieve metrics for analytical purposes

Returns the corresponding metrics based on the provided filter

GET

Headers

string

The Bearer token for authentication.

string

The user agent of the request. Must contain at least two identifiers separated by a space.

string

The content type of the request.

Parameters

string

The resource to filter based on

volumepaymentscustomersinvoicessubscriptions
string

The start date to filter based on.

string

The end date to filter based on.

Response Body

application/json
boolean

Indicates that the request was successful.

unknown

The metrics data.

array

The volume metrics results

string

The currency code.

number

The gross volume.

number

The incoming volume.

number

The settled volume.

number

The refunded volume.

number

The lost volume.

number

The fee volume.

number

The tax volume.