Skip to main content
GET
/
v1
/
actors
/
{ActorID}
/
evDashboard
Get Operator EV Meter Dashboard
curl --request GET \
  --url https://qa-lynx.nayax.com/operational/v1/actors/{ActorID}/evDashboard \
  --header 'Authorization: <api-key>'
{
  "OperatorDashboard": {
    "TotalOperatorMachines": 123,
    "TotalCommunicatingMachines": 123,
    "TotalActiveMachines": 123,
    "TotalSilentMachines": 123
  },
  "MachineDashboard": {
    "UnitOfMeasure": "<string>",
    "UnitOfMeasureSymbol": "<string>",
    "NumberOfChargingSessions": 123,
    "NumberOfTransactionsForTimeInterval": 123,
    "SalesAmountForTimeInterval": 123,
    "TotalChargingSessionsDuration": 123,
    "TotalEnergyConsumption": 123
  },
  "TimePeriod": 123
}

Authorizations

Authorization
string
header
required

Enter your API key. It's required to authenticate API requests.

Path Parameters

ActorID
integer<int64>
required

The unique identifier of the actor (operator) for whom the EV meter dashboard is being retrieved.

Query Parameters

StartDate
string<date-time>

The start date for filtering the EV meter dashboard data.

EndDate
string<date-time>

The end date for filtering the EV meter dashboard data.

MachineID
integer<int64>

The unique identifier of the machine for which the EV meter data is being retrieved.

TimePeriod
integer<int32>

The time period for which the EV meter data is being retrieved.

MachineNumber
string

The number of the machine for which the EV meter data is being retrieved.

Response

200 - application/json

The EV meter dashboard data was retrieved successfully.

Represents the EV meter dashboard data for an operator, including aggregated data at both the operator and machine levels.

OperatorDashboard
object

Aggregated data at the operator level, summarizing the status of all machines under the operator.

MachineDashboard
object

Aggregated data at the machine level, providing detailed metrics for individual machines.

TimePeriod
integer<int32> | null

The time period over which the dashboard data is aggregated.