Retrieve insights about charges.

get deprecatedhttps://partner-api.monta.com/api/v1/charges/insights

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

Responses

Response body

object

type

string

required

Enumerate the various types of charges insights

completed-charges-insights unknown

fromDate

date

required

Indicates the starting period (fromDate) used calculate the insights, format (YYYY-MM-DD)

Note: The date will be always in UTC

toDate

date

required

Indicates the end period (toDate) used calculate the insights, format (YYYY-MM-DD), always in UCT

Note: The date will be always in UTC

title

string

required

The title for for this charge insight

operator

object

required

The operator to which this charge insight belongs to

int64

ID of the operator

name

string

required

Name of operator

identifier

string

required

Identifier of operator

partnerId

int64 | null

Partner id (owner of this operator)

vatNumber

string | null

VAT number

currency

object

required

The currency applicable for this charge insight

identifier

string

required

Currency identifier, e.g. dkk

name

string

required

Readable name of currency

decimals

int32

Number of decimals for this currency

insights

array of objects

required

The compilation of insights entries composing this charge insight

insights*

object

type

string

required

Enumerate the various types of charge insights

total-completed-sponsored-charges total-completed-operator-charges total-completed-external-charges total-completed-charges unknown

summary

object

required

The summary for this insight entry, The summary contains the compiled statistics for the entry

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url https://partner-api.monta.com/api/v1/charges/insights \
3
     --header 'accept: application/json'


xxxxxxxxxx
29
}
1
{
2
  "type": "completed-charges-insights",
3
  "fromDate": "2023-11-01",
4
  "toDate": "2023-11-01",
5
  "title": "Completed charge sessions insights",
6
  "operator": {
7
    "id": 14,
8
    "name": "Monta",
9
    "identifier": "monta",
10
    "partnerId": null,
11
    "vatNumber": "FOO-123-ABC"
12
  },
13
  "currency": {
14
    "identifier": "dkk",
15
    "name": "Danish krone",
16
    "decimals": 2
17
  },
18
  "insights": [
19
    {
20
      "type": "completed-sponsored-charges-insights",
21
      "summary": {
22
        "totalKwh": 10.5,
23
        "totalPrice": 50,
24
        "totalCost": 25,
25
        "totalSessions": 0

200Charge insights for the given filter

400The request is invalid

401Consumer with provided credentials was not found

403Operator doesn't have access to resource

404Entity with the provided id was not found