> ## Documentation Index
> Fetch the complete documentation index at: https://nayax-44d6e37b-docs-marshall-faq-redistribution.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Operator EV Meter Dashboard

> Retrieves the EV meter dashboard for a specific operator, identified by `ActorID`. Optional query parameters allow filtering by date range, machine ID, time period, and machine number.



## OpenAPI

````yaml /openapi/lynx.yaml get /v1/actors/{ActorID}/evDashboard
openapi: 3.0.1
info:
  title: Nayax Operational Lynx API
  version: v1
servers:
  - url: https://qa-lynx.nayax.com/operational
security:
  - Authorization: []
paths:
  /v1/actors/{ActorID}/evDashboard:
    get:
      tags:
        - Actors
      summary: Get Operator EV Meter Dashboard
      description: >-
        Retrieves the EV meter dashboard for a specific operator, identified by
        `ActorID`. Optional query parameters allow filtering by date range,
        machine ID, time period, and machine number.
      operationId: get-operator-ev-meter-dashboard
      parameters:
        - name: ActorID
          in: path
          required: true
          schema:
            type: integer
            format: int64
          description: >-
            The unique identifier of the actor (operator) for whom the EV meter
            dashboard is being retrieved.
        - name: StartDate
          in: query
          schema:
            type: string
            format: date-time
          description: The start date for filtering the EV meter dashboard data.
        - name: EndDate
          in: query
          schema:
            type: string
            format: date-time
          description: The end date for filtering the EV meter dashboard data.
        - name: MachineID
          in: query
          schema:
            type: integer
            format: int64
          description: >-
            The unique identifier of the machine for which the EV meter data is
            being retrieved.
        - name: TimePeriod
          in: query
          schema:
            type: integer
            format: int32
          description: The time period for which the EV meter data is being retrieved.
        - name: MachineNumber
          in: query
          schema:
            type: string
          description: >-
            The number of the machine for which the EV meter data is being
            retrieved.
      responses:
        '200':
          description: The EV meter dashboard data was retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvMeterDashBoard'
components:
  schemas:
    EvMeterDashBoard:
      type: object
      description: >-
        Represents the EV meter dashboard data for an operator, including
        aggregated data at both the operator and machine levels.
      properties:
        OperatorDashboard:
          $ref: '#/components/schemas/OperatorLevelAggregation'
          description: >-
            Aggregated data at the operator level, summarizing the status of all
            machines under the operator.
        MachineDashboard:
          $ref: '#/components/schemas/MachineLevelAggregation'
          description: >-
            Aggregated data at the machine level, providing detailed metrics for
            individual machines.
        TimePeriod:
          type: integer
          format: int32
          nullable: true
          description: The time period over which the dashboard data is aggregated.
      additionalProperties: false
    OperatorLevelAggregation:
      type: object
      description: >-
        Aggregated data at the operator level, summarizing the number and status
        of machines under the operator's management.
      properties:
        TotalOperatorMachines:
          type: integer
          format: int32
          description: The total number of machines managed by the operator.
        TotalCommunicatingMachines:
          type: integer
          format: int32
          description: >-
            The number of machines that are currently communicating and
            reporting data.
        TotalActiveMachines:
          type: integer
          format: int32
          description: The number of machines that are currently active and in operation.
        TotalSilentMachines:
          type: integer
          format: int32
          description: The number of machines that are not communicating or reporting data.
      additionalProperties: false
    MachineLevelAggregation:
      type: object
      description: >-
        Aggregated data at the machine level, providing detailed metrics on the
        performance and usage of individual machines.
      properties:
        UnitOfMeasure:
          type: string
          nullable: true
          description: >-
            The unit of measure used for energy consumption and other metrics
            (e.g., kWh).
        UnitOfMeasureSymbol:
          type: string
          nullable: true
          description: >-
            The symbol representing the unit of measure (e.g., "kWh" for
            kilowatt-hours).
        NumberOfChargingSessions:
          type: number
          format: double
          description: >-
            The total number of charging sessions recorded during the specified
            time period.
        NumberOfTransactionsForTimeInterval:
          type: number
          format: double
          description: >-
            The total number of transactions processed during the specified time
            period.
        SalesAmountForTimeInterval:
          type: number
          format: double
          description: The total sales amount generated during the specified time period.
        TotalChargingSessionsDuration:
          type: number
          format: double
          description: >-
            The total duration of all charging sessions during the specified
            time period.
        TotalEnergyConsumption:
          type: integer
          format: int32
          description: >-
            The total energy consumption recorded during the specified time
            period.
      additionalProperties: false
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      description: Enter your Bearer token. It's required to authenticate API requests.

````