> ## Documentation Index
> Fetch the complete documentation index at: https://docs.connectedfleet.michelin.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Driver Behaviour Vehicle Summary

> Returns the behaviour summary metrics for a vehicle.<br/><br/>The value specified for the endDate cannot be before startDate and the date range between startDate and endDate must be at least 7 days and cannot be more than 31 days.<br/><br/>A value for either vehicleId or groupId must be specified.<br/><br/>If there are more than 50 details that match the search criteria, then by default only the first 50 summary details are returned. To view details of the summary details you will need to specify values for pageSize and pageIndex.



## OpenAPI

````yaml /api-reference/performance.json get /public/v1/customer/{customerId}/driverbehaviourmetrics/vehicle/summary
openapi: 3.0.1
info:
  title: Performance
  description: >-
    Delivers deeper insights into driver behaviour, fuel efficiency, CO₂ impact
    and safe driving practices.
  contact:
    name: Masternaut
    url: https://www.masternaut.com
    email: support@masternautconnect.com
  version: 124.0.2607160821
servers:
  - url: https://api.masternautconnect.com/connect-webservices/services
    description: Product Server
security:
  - basicAuth: []
tags:
  - name: /alert
    description: Alert history and notification management operations
  - name: /driver
    description: Driver Operations
  - name: /driverbehaviourmetrics
    description: Driver Behaviour Metrics
  - name: customers
    description: Customer Behaviour Metrics
  - name: /ecoscore
    description: EcoScore
  - name: /fuel
    description: Fuel
  - name: /idling
    description: Idling
  - name: /speeding
    description: Speeding
  - name: /tokenInformation
    description: Token operations
  - name: /utilisation
    description: Utilisation
  - name: /vehicle
    description: Vehicle management operations
paths:
  /public/v1/customer/{customerId}/driverbehaviourmetrics/vehicle/summary:
    get:
      tags:
        - /driverbehaviourmetrics
        - customers
      summary: Driver Behaviour Vehicle Summary
      description: >-
        Returns the behaviour summary metrics for a vehicle.<br/><br/>The value
        specified for the endDate cannot be before startDate and the date range
        between startDate and endDate must be at least 7 days and cannot be more
        than 31 days.<br/><br/>A value for either vehicleId or groupId must be
        specified.<br/><br/>If there are more than 50 details that match the
        search criteria, then by default only the first 50 summary details are
        returned. To view details of the summary details you will need to
        specify values for pageSize and pageIndex.
      operationId: getSummaryByAsset
      parameters:
        - name: customerId
          in: path
          required: true
          schema:
            type: string
        - name: pageIndex
          in: query
          description: >-
            Specifies the pagination page index.<br/>Pages are zero indexed,
            i.e. the first page has an index value of zero.
          required: false
          schema:
            type: integer
            description: >-
              Specifies the pagination page index.<br/>Pages are zero indexed,
              i.e. the first page has an index value of zero.
            format: int32
        - name: pageSize
          in: query
          description: >-
            Specifies the number of items to include on a page.<br/>Must be
            specified if pageIndex has been specified.
          required: false
          schema:
            type: integer
            description: >-
              Specifies the number of items to include on a page.<br/>Must be
              specified if pageIndex has been specified.
            format: int32
        - name: startDate
          in: query
          description: >-
            Start date and time for the search period. Format:
            yyyy-MM-dd'T'HH:mm:ss in UTC. Required.
          required: true
          schema:
            type: string
            description: >-
              Start date and time for the search period. Format:
              yyyy-MM-dd'T'HH:mm:ss in UTC. Required.
            format: date-time
        - name: endDate
          in: query
          description: >-
            End date and time for the search period. Format:
            yyyy-MM-dd'T'HH:mm:ss in UTC. Required and must be within 7 days of
            startDate.
          required: true
          schema:
            type: string
            description: >-
              End date and time for the search period. Format:
              yyyy-MM-dd'T'HH:mm:ss in UTC. Required and must be within 7 days
              of startDate.
            format: date-time
        - name: driverId
          in: query
          description: >-
            Unique, unchangeable system generated identifier (alphanumeric) for
            the driver.
          required: false
          schema:
            type: string
            description: >-
              Unique, unchangeable system generated identifier (alphanumeric)
              for the driver.
        - name: groupId
          in: query
          description: >-
            Identifier (alphanumeric) of a group. Must be provided if a value
            for vehicleId is not provided
          required: false
          schema:
            type: string
            description: >-
              Identifier (alphanumeric) of a group. Must be provided if a value
              for vehicleId is not provided
        - name: vehicleId
          in: query
          description: >-
            Identifier (alphanumeric) of a vehicle. Must be provided if a value
            for groupId is not provided.
          required: false
          schema:
            type: string
            description: >-
              Identifier (alphanumeric) of a vehicle. Must be provided if a
              value for groupId is not provided.
      responses:
        '200':
          description: Successful operation
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: >-
                  #/components/schemas/WithPaginationResultDrivingBehaviourSummaryDto
        '400':
          description: Bad input parameters
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ApiErrorDto'
        '404':
          description: Resource not found
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ApiErrorDto'
components:
  schemas:
    WithPaginationResultDrivingBehaviourSummaryDto:
      type: object
      properties:
        totalPages:
          type: integer
          description: Total number of pages based on the pageSize.
          format: int32
        totalCount:
          type: integer
          description: Total number of items that matched the search parameters.
          format: int64
        items:
          type: array
          description: Array of items.
          items:
            $ref: '#/components/schemas/DrivingBehaviourSummaryDto'
    ApiErrorDto:
      type: object
      properties:
        errorCode:
          type: integer
          format: int32
        errorMessage:
          type: string
        offendingFields:
          type: array
          items:
            type: string
    DrivingBehaviourSummaryDto:
      type: object
      properties:
        totalPages:
          type: integer
          description: Total number of pages based on the pageSize.
          format: int32
        totalCount:
          type: integer
          description: Total number of input blocks that matched the search parameters.
          format: int32
        items:
          type: array
          description: Array of behaviour metrics.
          items:
            type: object
        fuel:
          type: number
          description: Amount of fuel used (in litres)
          format: double
        stops:
          type: integer
          description: Count of the number of stops.
          format: int32
        harshBraking:
          type: integer
          description: Number of harsh braking events.
          format: int64
        harshAcceleration:
          type: integer
          description: Number of harsh acceleration events.
          format: int64
        idleTime:
          type: integer
          description: Total idle time.
          format: int64
        ptoIdle:
          type: integer
          description: Total time idling with PTO active.
          format: int64
        distanceKm:
          type: number
          description: Distance travelled (in Kms).
          format: double
        speedingKms:
          type: number
          description: Distance travelled whilst speeding (in kms)
          format: double
        countOfSpeedingEpisodes:
          type: integer
          description: Count of the number of speeding episodes.
          format: int32
        driveTime:
          type: integer
          description: Total time driving.
          format: int64
        harshEvents:
          type: integer
          description: Number of harsh events.
          format: int64
        drivePlusIdleTime:
          type: integer
          description: Sum of idle and drive time.
          format: int64
        smootherHarshPer100km:
          type: number
          description: Number of harsh events per 100 kms.
          format: double
        smootherPercentage:
          type: number
          description: Smoother KPI as a percentage.
          format: double
        safeSpeedPercentage:
          type: number
          description: Safe speed KPI as a percentage.
          format: double
        cleanerPercentage:
          type: number
          description: Cleaner KPI as a percentage.
          format: double
        groupId:
          type: string
          description: >-
            Unique, unchangeable system generated identifier (alphanumeric) for
            the group.
        groupName:
          type: string
          description: Name of the group.
        totalCo2Kg:
          type: number
          description: >-
            Total CO2 (in Kg) for the total fuel/gas used for all journeys in
            this period.
          format: double
        co2gPerKm:
          type: number
          description: CO2 in grams per Km
          format: double
        startDate:
          type: string
          description: Summary start date and time, in UTC in format YYYY-MM-DDThh:mm:ss
          format: date-time
        endDate:
          type: string
          description: Summary end date and time, in UTC in format YYYY-MM-DDThh:mm:ss
          format: date-time
        vehicleRegistration:
          type: string
          description: Vehicle registration number.
        vehicleName:
          type: string
          description: Name of the vehicle.
        vehicleId:
          type: string
          description: Unique identifier for the vehicle.
        driverName:
          type: string
          description: Name of the driver.
        driverId:
          type: string
          description: >-
            Unique, unchangeable system generated identifier (alphanumeric) for
            the driver.
        energyType:
          type: string
          description: Energy type used by the vehicle.
          enum:
            - ICE
            - EV
            - HEV
            - PHEV
            - CNG
            - LNG
            - LPG
            - FCEV
            - BI_FUEL
            - UNDEFINED
        fuelType:
          uniqueItems: true
          type: array
          description: Set of fuel types used by the vehicle.
          items:
            type: string
            description: Set of fuel types used by the vehicle.
            enum:
              - PETROL
              - DIESEL
              - METHANE
              - PROPANE
              - HYDROGEN
              - ELECTRIC
        fuelUsedPetrolEquivalentLitres:
          type: number
          description: >-
            The total energy (Electricity, Gas,Petrol, Diesel) used for all
            journeys expressed as the petrol equivalent in litres. Consumption
            as MPGe or Le/100km can derived as follows:<ul><li>Le/100km =
            (fuelUsedPetrolEquivalentLitres / distanceKm) * 100</li><li>MPGe =
            (distanceKm / 1.609) / (fuelUsedPetrolEquivalentLitres /
            4.546)</li></ul>
          format: double
        gasUsedKg:
          type: number
          description: Gas for all journeys in Kg.
          format: double
        electricUsedkWh:
          type: number
          description: Electricity used for all journeys in kWh.
          format: double
        fuelUsedLitres:
          type: number
          description: Petrol or Diesel fuel used for all journeys, in litres.
          format: double
      description: The driver behaviour summary metrics for a driver
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````