Skip to content

Get a report

GET
/api/reports/{reportId}

Get /api/reports/:reportId

Parameters

Path Parameters

reportId
required
string format: uuid

Request Body required

Responses

200

Response for status ok

object
success
required
boolean
report
required
object
id
required
string format: uuid
namespaceId
required
string format: uuid
userId
required
string format: uuid
chargerIds
required
Array<string>
locationIds
required
Array<string>
measurands
required
Array<string>
Allowed values: Current.Export Current.Import Current.Offered Energy.Active.Export.Register Energy.Active.Import.Register Energy.Reactive.Export.Register Energy.Reactive.Import.Register Energy.Active.Export.Interval Energy.Active.Import.Interval Energy.Reactive.Export.Interval Energy.Reactive.Import.Interval Frequency Power.Active.Export Power.Active.Import Power.Factor Power.Offered Power.Reactive.Export Power.Reactive.Import RPM SoC Temperature Voltage
from
required
string format: date-time
to
required
string format: date-time
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
status
required
string
Allowed values: Completed Failed InProgress Idle InQueue
reportType
required
string
Allowed values: ClockAlignedData SessionsData SampledMeterData
aggregation
required
string
Allowed values: ByChargerId ByChargerIdAndConnectorId ByLocationId ByUserId ByAuthMethod Daily Weekly Monthly Yearly None

403

Response for status forbidden

object
success
required
boolean
message
required
string

404

Response for status notFound

object
success
required
boolean
message
required
string

500

Response for status internalServerError

object
success
required
boolean
message
required
string