Sign in

v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Charges Insights

Retrieve insights about charges.

Required scope: charge-transactions:read. Deprecated, use /insights/charges/driver-report and /insights/charges/charger-report instead.

get/api/v1/charges/insights

Query parameters

fromDatestring date required

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

Example:2022-05-01
toDatestring date required

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

Example:2022-05-30
teamIdinteger nullable

Filter to retrieve charges insights by the specified teamId

Example:13
chargePointIdinteger nullable

Filter to retrieve charges insights by the specified chargePointId

Example:13
siteIdinteger nullable

Filter to retrieve charges insights by the specified siteId

Example:13
teamMemberIdinteger nullable

Filter to retrieve charges insights by the specified teamMemberId

Example:13

Response

Charge insights for the given filter

type'completed-charges-insights' | 'unknown' required

Enumerate the various types of charges insights

fromDatestring date required

Indicates the starting period (fromDate) used calculate the insights, format (YYYY-MM-DD)</br></br>Note: The date will be always in UTC

toDatestring date required

Indicates the end period (toDate) used calculate the insights, format (YYYY-MM-DD), always in UCT</br></br>Note: The date will be always in UTC

titlestring required

The title for for this charge insight

Example response

{
  "fromDate": "2023-11-01",
  "toDate": "2023-11-01",
  "title": "Completed charge sessions insights",
  "operator": {
    "id": 14,
    "name": "Monta",
    "identifier": "monta",
    "partnerId": 1,
    "vatNumber": "FOO-123-ABC"
  },
  "currency": {
    "identifier": "dkk",
    "name": "Danish krone",
    "decimals": 2
  },
  "insights": [
    {
      "summary": {
        "totalKwh": 10.5,
        "totalPrice": 50,
        "totalCost": 25
      }
    }
  ]
}