Reports

Retrieve a list of reports for charge point(s).

GET

https://partner-api.monta.com

/api/v1/reports

For operational/system alerts use /alerts and /issues; source=system reports will stop being produced when the legacy alerting is switched off (CPONETOPS-872).

Required scope: reports:read

Retrieve a list of reports for charge point(s). › query Parameters

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

chargePointId

integer | null · int64

Filter to retrieve reports with specified chargePointId

Example: 10

state

string | null · enum

Filter to retrieve reports by state

Enum values:

new

action

assigned-owner

assigned-monta

assigned-operator

resolved

Example: new

fromDate

string | null · date-time

Filter to retrieve reports where createdAt >= fromDate (ISO8601: yyyy-MM-ddTHH:mm:ssZ)

Example: 2022-05-22T09:30:03Z

toDate

string | null · date-time

Filter to retrieve reports where createdAt <= toDate (ISO8601: yyyy-MM-ddTHH:mm:ssZ)

Example: 2022-05-22T09:30:03Z

priority

string | null · enum

Priority of the report

Enum values:

low

medium

high

reasonIdentifier

string | null

Filter to retrieve reports with specified reason identifier

Example: driver-support

Retrieve a list of reports for charge point(s). › Responses

List of reports that match the criteria

OffsetBasedResponse_47

ReportDto[] · required

MontaPage.Meta · required

GET/api/v1/reports

curl https://partner-api.monta.com/api/v1/reports \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": 10,
      "reportedByUserId": 10,
      "operatorId": 10,
      "relationType": "relationType",
      "relationId": 10,
      "body": "available but can not start",
      "state": "state",
      "reason": {
        "id": 10,
        "identifier": "identifier",
        "reason": "reason",
        "type": "type",
        "priority": "priority"
      },
      "source": "source",
      "imageUrls": [
        "https://monta.imgix.net/reports/example-image-1.png",
        "https://monta.imgix.net/reports/example-image-2.png"
      ],
      "assignedToOperatorId": 10,
      "assignedToUserId": 10,
      "resolvedByUserId": 10,
      "operatorNote": "The charge point is not working",
      "adminNote": "The charge point is not working",
      "userNote": "The charge point is not working",
      "resolvedAt": "2023-02-06T11:00:00Z",
      "escalatedAt": "2023-02-06T10:00:00Z",
      "assignedAt": "2023-02-06T09:00:00Z",
      "payload": {
        "ticket_id": 12345,
        "user_email": "test@example.com"
      },
      "createdAt": "2023-02-06T08:00:00Z",
      "updatedAt": "2023-02-06T11:00:00Z",
      "deletedAt": "2023-02-06T12:00:00Z"
    }
  ],
  "meta": {
    "itemCount": 0,
    "currentPage": 0,
    "perPage": 0,
    "totalPageCount": 0,
    "totalItemCount": 0
  }
}

json

application/json

GET

https://partner-api.monta.com

/api/v1/reports/{reportId}

For operational/system alerts use /alerts and /issues; source=system reports will stop being produced when the legacy alerting is switched off (CPONETOPS-872).

Required scope: reports:read

reportId

integer · int64 · required

report with provided id

ReportDto

id

integer · int64 · required

Id of the report

Example: 10

operatorId

integer · int64 · required

Id of the operator related to the report

Example: 10

relationType

string · required

Type of the relation

relationId

integer · int64 · required

Id of the relation

Example: 10

state

string · required

State of the report

imageUrls

string[] · required

List of image URLs

Example: ["https://monta.imgix.net/reports/example-image-1.png","https://monta.imgix.net/reports/example-image-2.png"]

createdAt

string · date-time · required

Time when the report was created

Example: 2023-02-06T08:00:00Z

reportedByUserId

integer | null · int64

Id of the user who reported

Example: 10

body

string | null

Body of the report

Example: available but can not start

object

Reason of the report

source

string | null

Source of the report

assignedToOperatorId

integer | null · int64

Id of the operator assigned to the report

Example: 10

assignedToUserId

integer | null · int64

Id of the user assigned to the report

Example: 10

resolvedByUserId

integer | null · int64

Id of the user who resolved the report

Example: 10

operatorNote

string | null

Note from the operator

Example: The charge point is not working

adminNote

string | null

Note from the admin

Example: The charge point is not working

userNote

string | null

Note from the user

Example: The charge point is not working

resolvedAt

string | null · date-time

Time when the report was resolved

Example: 2023-02-06T11:00:00Z

escalatedAt

string | null · date-time

Time when the report was escalated

Example: 2023-02-06T10:00:00Z

assignedAt

string | null · date-time

Time when the report was assigned

Example: 2023-02-06T09:00:00Z

object | null

Additional raw payload data, ie. for driver-support reports coming from Zendesk

Example: {"ticket_id":12345,"user_email":"test@example.com"}

updatedAt

string | null · date-time

Time when the report was updated

Example: 2023-02-06T11:00:00Z

deletedAt

string | null · date-time

Time when the report was deleted

Example: 2023-02-06T12:00:00Z

GET/api/v1/reports/{reportId}

curl https://partner-api.monta.com/api/v1/reports/:reportId \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": 10,
  "reportedByUserId": 10,
  "operatorId": 10,
  "relationType": "relationType",
  "relationId": 10,
  "body": "available but can not start",
  "state": "state",
  "reason": {
    "id": 10,
    "identifier": "identifier",
    "reason": "reason",
    "type": "type",
    "priority": "priority"
  },
  "source": "source",
  "imageUrls": [
    "https://monta.imgix.net/reports/example-image-1.png",
    "https://monta.imgix.net/reports/example-image-2.png"
  ],
  "assignedToOperatorId": 10,
  "assignedToUserId": 10,
  "resolvedByUserId": 10,
  "operatorNote": "The charge point is not working",
  "adminNote": "The charge point is not working",
  "userNote": "The charge point is not working",
  "resolvedAt": "2023-02-06T11:00:00Z",
  "escalatedAt": "2023-02-06T10:00:00Z",
  "assignedAt": "2023-02-06T09:00:00Z",
  "payload": {
    "ticket_id": 12345,
    "user_email": "test@example.com"
  },
  "createdAt": "2023-02-06T08:00:00Z",
  "updatedAt": "2023-02-06T11:00:00Z",
  "deletedAt": "2023-02-06T12:00:00Z"
}

json

application/json

deprecated

POST

https://partner-api.monta.com

/api/v1/reports/{reportId}/resolve

For operational/system alerts use /alerts and /issues; source=system reports will stop being produced when the legacy alerting is switched off (CPONETOPS-872).

Required scope: reports:write

reportId

integer · int64 · required

Resolved report with provided id

ReportDto

id

integer · int64 · required

Id of the report

Example: 10

operatorId

integer · int64 · required

Id of the operator related to the report

Example: 10

relationType

string · required

Type of the relation

relationId

integer · int64 · required

Id of the relation

Example: 10

state

string · required

State of the report

imageUrls

string[] · required

List of image URLs

Example: ["https://monta.imgix.net/reports/example-image-1.png","https://monta.imgix.net/reports/example-image-2.png"]

createdAt

string · date-time · required

Time when the report was created

Example: 2023-02-06T08:00:00Z

reportedByUserId

integer | null · int64

Id of the user who reported

Example: 10

body

string | null

Body of the report

Example: available but can not start

object

Reason of the report

source

string | null

Source of the report

assignedToOperatorId

integer | null · int64

Id of the operator assigned to the report

Example: 10

assignedToUserId

integer | null · int64

Id of the user assigned to the report

Example: 10

resolvedByUserId

integer | null · int64

Id of the user who resolved the report

Example: 10

operatorNote

string | null

Note from the operator

Example: The charge point is not working

adminNote

string | null

Note from the admin

Example: The charge point is not working

userNote

string | null

Note from the user

Example: The charge point is not working

resolvedAt

string | null · date-time

Time when the report was resolved

Example: 2023-02-06T11:00:00Z

escalatedAt

string | null · date-time

Time when the report was escalated

Example: 2023-02-06T10:00:00Z

assignedAt

string | null · date-time

Time when the report was assigned

Example: 2023-02-06T09:00:00Z

object | null

Additional raw payload data, ie. for driver-support reports coming from Zendesk

Example: {"ticket_id":12345,"user_email":"test@example.com"}

updatedAt

string | null · date-time

Time when the report was updated

Example: 2023-02-06T11:00:00Z

deletedAt

string | null · date-time

Time when the report was deleted

Example: 2023-02-06T12:00:00Z

POST/api/v1/reports/{reportId}/resolve

curl https://partner-api.monta.com/api/v1/reports/:reportId/resolve \
  --request POST \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": 10,
  "reportedByUserId": 10,
  "operatorId": 10,
  "relationType": "relationType",
  "relationId": 10,
  "body": "available but can not start",
  "state": "state",
  "reason": {
    "id": 10,
    "identifier": "identifier",
    "reason": "reason",
    "type": "type",
    "priority": "priority"
  },
  "source": "source",
  "imageUrls": [
    "https://monta.imgix.net/reports/example-image-1.png",
    "https://monta.imgix.net/reports/example-image-2.png"
  ],
  "assignedToOperatorId": 10,
  "assignedToUserId": 10,
  "resolvedByUserId": 10,
  "operatorNote": "The charge point is not working",
  "adminNote": "The charge point is not working",
  "userNote": "The charge point is not working",
  "resolvedAt": "2023-02-06T11:00:00Z",
  "escalatedAt": "2023-02-06T10:00:00Z",
  "assignedAt": "2023-02-06T09:00:00Z",
  "payload": {
    "ticket_id": 12345,
    "user_email": "test@example.com"
  },
  "createdAt": "2023-02-06T08:00:00Z",
  "updatedAt": "2023-02-06T11:00:00Z",
  "deletedAt": "2023-02-06T12:00:00Z"
}

json

application/json

Report Reasons Revenue Share

Reports

Retrieve a list of reports for charge point(s).

Retrieve a list of reports for charge point(s). › query Parameters

Retrieve a list of reports for charge point(s). › Responses

Retrieve a report related to a charge point.

Retrieve a report related to a charge point. › path Parameters

Retrieve a report related to a charge point. › Responses

Resolve a report related to a charge point.

Resolve a report related to a charge point. › path Parameters

Resolve a report related to a charge point. › Responses