Sign in

v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Reports

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

Required scope: reports:read

get/api/v1/reports

Query parameters

pageinteger

page number to retrieve (starts with 0)

perPageinteger

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

chargePointIdinteger nullable

Filter to retrieve reports with specified chargePointId

Example:10
state'new' | 'action' | 'assigned-owner' | 'assigned-monta' | 'assigned-operator' | 'resolved' nullable

Filter to retrieve reports by state

Example:new
fromDatestring date-time nullable

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

Example:2022-05-22T09:30:03Z
toDatestring date-time nullable

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

Example:2022-05-22T09:30:03Z
priority'low' | 'medium' | 'high' nullable

Priority of the report

reasonIdentifierstring nullable

Filter to retrieve reports with specified reason identifier

Example:driver-support

Response

List of reports that match the criteria

Example response

{
  "data": [
    {
      "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",
      "createdAt": "2023-02-06T08:00:00Z",
      "updatedAt": "2023-02-06T11:00:00Z",
      "deletedAt": "2023-02-06T12:00:00Z"
    }
  ]
}