Insights

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}

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

teamId

integer · int64 · required

Filter to retrieve charges insights by the specified teamId

Example: 13

fromDate

string · 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

string · 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

page

integer · int32

page number to retrieve (starts with 0)

Default: 0

perPage

integer · int32

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

Default: 10

datesFilteredBy

string | null · enum

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.

Enum values:

charge-transaction

wallet-transaction

Example: charge-transaction

Default: charge-transaction

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

Charge Auth Token report for the given filter

OffsetBasedResponse_28

ChargesInsightByChargeAuthTokenReportDto[] · required

MontaPage.Meta · required

GET/api/v1/insights/charges/charge-auth-token-report

curl 'https://partner-api.monta.com/api/v1/insights/charges/charge-auth-token-report?teamId=<number>&fromDate=<string>&toDate=<string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": 1,
      "identifier": "38C58DB85F4",
      "type": "vehicleId",
      "consumptions": [
        {
          "chargeType": "chargeType",
          "totalSessions": 0,
          "totalKwh": 0,
          "totalNetPrice": 0,
          "totalVat": 0,
          "totalGrossPrice": 0,
          "memberCostGroupId": 0,
          "memberCostGroupName": "memberCostGroupName",
          "memberCostGroupPrice": 0
        }
      ]
    }
  ],
  "meta": {
    "itemCount": 0,
    "currentPage": 0,
    "perPage": 0,
    "totalPageCount": 0,
    "totalItemCount": 0
  }
}

json

application/json

Retrieve insights about charge points.

GET

https://partner-api.monta.com

/api/v1/insights/charges/charger-report

Required scope: insights:read

Returns a list of charge points (owned by that teamId) with the number of charging sessions and the total Kwh consumed.

Retrieve insights about charge points. › query Parameters

teamId

integer · int64 · required

Filter to retrieve charge point insights by the specified teamId

Example: 13

fromDate

string · 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

string · 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

page

integer · int32

page number to retrieve (starts with 0)

Default: 0

perPage

integer · int32

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

Default: 10

chargePointIds

string | null

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

Example: 13,14,15

Retrieve insights about charge points. › Responses

Charger report for the given filter

OffsetBasedResponse_29

ChargesInsightChargerReport[] · required

MontaPage.Meta · required

Retrieve insights about charges broken down by team members and member cost groups of a team.

GET

https://partner-api.monta.com

/api/v1/insights/charges/driver-member-costs-report

Required scope: insights:read

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

Retrieve insights about charges broken down by team members and member cost groups of a team. › query Parameters

teamId

integer · int64 · required

Filter to retrieve charges insights by the specified teamId

Example: 13

fromDate

string · 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')
The maximum gap between from and to data cannot be longer than 31 days

toDate

string · 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')
The maximum gap between from and to data cannot be longer than 31 days

page

integer · int32

page number to retrieve (starts with 0)

Default: 0

perPage

integer · int32

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

Default: 10

teamMemberIds

string | null

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

Example: 13,14,15

datesFilteredBy

string | null · enum

Enum values:

charge-transaction

wallet-transaction

Example: charge-transaction

Default: charge-transaction

Retrieve insights about charges broken down by team members and member cost groups of a team. › Responses

Driver report for the given filter

OffsetBasedResponse_27

ChargesInsightDriverMemberCostsReport[] · required

MontaPage.Meta · required

GET/api/v1/insights/charges/driver-member-costs-report

curl 'https://partner-api.monta.com/api/v1/insights/charges/driver-member-costs-report?teamId=<number>&fromDate=<string>&toDate=<string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "teamId": 0,
      "teamMemberId": 0,
      "userId": 0,
      "consumptions": [
        {
          "chargeType": "chargeType",
          "totalSessions": 0,
          "totalKwh": 0,
          "totalNetPrice": 0,
          "totalVat": 0,
          "totalGrossPrice": 0,
          "memberCostGroupId": 0,
          "memberCostGroupName": "memberCostGroupName",
          "memberCostGroupPrice": 0,
          "countryBreakdown": [
            {
              "countryCode": "countryCode",
              "totalSessions": 0,
              "totalKwh": 0,
              "totalNetPrice": 0,
              "totalVat": 0,
              "totalGrossPrice": 0,
              "memberCostGroupPrice": 0
            }
          ]
        }
      ]
    }
  ],
  "meta": {
    "itemCount": 0,
    "currentPage": 0,
    "perPage": 0,
    "totalPageCount": 0,
    "totalItemCount": 0
  }
}

json

application/json

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

GET

https://partner-api.monta.com

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

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}

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

teamId

integer · int64 · required

Filter to retrieve charges insights by the specified teamId

Example: 13

fromDate

string · 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')
The maximum gap between from and to data cannot be longer than 31 days

toDate

string · 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')
The maximum gap between from and to data cannot be longer than 31 days

page

integer · int32

page number to retrieve (starts with 0)

Default: 0

perPage

integer · int32

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

Default: 10

teamMemberIds

string | null

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

Example: 13,14,15

datesFilteredBy

string | null · enum

Enum values:

charge-transaction

wallet-transaction

Example: charge-transaction

Default: charge-transaction

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

Driver report for the given filter

OffsetBasedResponse_26

ChargesInsightDriverReport[] · required

MontaPage.Meta · required

Feature Groups Installer Jobs