Sign in

v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Insights

Retrieve insights about charges broken down by team members of a team.

Required scope: insights:read

Returns charge insights for the given teamId (and optionally teamMemberIds) broken down by team member. 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}

get/api/v1/insights/charges/driver-report

Query parameters

pageinteger

page number to retrieve (starts with 0)

perPageinteger

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

teamIdinteger required

Filter to retrieve charges insights by the specified teamId

Example:13
teamMemberIdsstring nullable

Filter to retrieve charges insights by the specified (comma-separated) list of teamMemberId

Example:13,14,15
fromDatestring date required

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

toDatestring date required

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

datesFilteredBy'charge-transaction' | 'wallet-transaction' nullable

Use this to determine if the report should be filtered based on completion dates of charges or wallet transactions.</br></br>Accepted values:</br>- 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.

Example:charge-transaction

Response

Driver report for the given filter