MOmonta
Reports

Retrieve a report related to a charge point.

Changed on

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

get/api/v1/reports/{reportId}

Request

  • Base URL
    https://partner-api.monta.com
  • URL
    https://partner-api.monta.com/api/v1/reports/{reportId}
  • Auth
    HTTP bearer

Path parameters

reportIdinteger required

Response

report with provided id

idinteger required

Id of the report

reportedByUserIdinteger nullable

Id of the user who reported

operatorIdinteger required

Id of the operator related to the report

relationTypestring required

Type of the relation

relationIdinteger required

Id of the relation

bodystring nullable

Body of the report

statestring required

State of the report

sourcestring nullable

Source of the report

imageUrlsstring[] required

List of image URLs

assignedToOperatorIdinteger nullable

Id of the operator assigned to the report

assignedToUserIdinteger nullable

Id of the user assigned to the report

resolvedByUserIdinteger nullable

Id of the user who resolved the report

operatorNotestring nullable

Note from the operator

adminNotestring nullable

Note from the admin

userNotestring nullable

Note from the user

resolvedAtstring date-time nullable

Time when the report was resolved

escalatedAtstring date-time nullable

Time when the report was escalated

assignedAtstring date-time nullable

Time when the report was assigned

payloadobject nullable

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

createdAtstring date-time required

Time when the report was created

updatedAtstring date-time nullable

Time when the report was updated

deletedAtstring date-time nullable

Time when the report was deleted

Example response

{
  "id": 10,
  "reportedByUserId": 10,
  "operatorId": 10,
  "relationId": 10,
  "body": "available but can not start",
  "reason": {
    "id": 10
  },
  "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"
}

Changes