Retrieve insights about charges broken down by charge auth token and member cost groups of a team.

get

https://partner-api.monta.com/api/v1/insights/charges/charge-auth-token-report

Required scope: insights:read

Returns charge insights for the given teamId (and optionally chargeAuthTokenIds) broken down by charge auth token and the member cost groups.
Takes only charges into consideration that were paid for by the provided teamId.

Note: Any values related to money are in the teams' currency. You can fetch them from GET /api/v1/teams/{teamId}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

int32

Defaults to 0

page number to retrieve (starts with 0)

perPage

int32

Defaults to 10

number of items per page (between 1 and 100, default 10)

teamId

int64

required

> 0

Filter to retrieve charges insights by the specified teamId

fromDate

date

required

Filter to retrieve charge insights created from date, we expecta date in UTC and ISO8601 (YYYY-MM-DD'T'HH:MM:SS'Z')
The maximum gap between from and to data cannot be longer than 31 days

toDate

date

required

Filter to retrieve charge insights created to date, we expecta date in UTC and ISO8601 (YYYY-MM-DD'T'HH:MM:SS'Z')
The maximum gap between from and to data cannot be longer than 31 days

datesFilteredBy

string | null

enum

Defaults to charge-transaction

Use this to determine if the report should be filtered based on completion dates of charges or wallet transactions.

Accepted values:
- charge-transaction: Generates report based on charges' completedAt. Default.- wallet-transaction: Generates report based on wallet transactions' completedAt. Will not include any charges without wallet transactions.

Allowed:

Responses

200Charge Auth Token report for the given filter

400The request is invalid

401Unauthorized access

403Operator doesn't have access to resource

404Entity with the provided id was not found