> ## Documentation Index
> Fetch the complete documentation index at: https://docsy3.mile.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Read alert summary

> Returns the emails of users that have at least one unresolved alert on the given local day (Asia/Jakarta time).

Pass `hubId` to count only that hub's alerts plus the alerts with no hub.

Requires permission `view/alert`.



## OpenAPI

````yaml /openapi/public/openapi-monitoring.json get /alerts/summary
openapi: 3.0.0
info:
  title: API - Monitoring
  version: 3.0.0
  description: API Documentation - RESTful API for field operations management.
servers:
  - url: https://apiweb.mile.app/api/v3
security:
  - bearerAuth: []
tags:
  - name: Alert
    description: >-
      An alert is an event raised while monitoring field users and vehicles, for
      example entering or leaving a geofence, idling too long, a predicted late
      task, a route deviation, driving above the speed limit or a panic button
      press. You can list alerts, read a daily summary, and mark them resolved.
      These endpoints are served under `/api/v4`.
  - name: Alert Setting
    description: >-
      Alert settings switch each alert type on or off for your organization.
      They also return the limits each alert type fires on. These endpoints are
      served under `/api/v4`.
  - name: Geofence
    description: >-
      A geofence is an area drawn on the map, as a polygon or a circle. Alerts
      and automations can react when a field user enters or leaves it, or stays
      inside longer than its dwell time.
  - name: Geofence Group
    description: >-
      Geofence groups organize geofences so you can filter and manage them
      together.
paths:
  /alerts/summary:
    servers:
      - url: https://apiweb.mile.app/api/v4
    get:
      tags:
        - Alert
      summary: Read alert summary
      description: >-
        Returns the emails of users that have at least one unresolved alert on
        the given local day (Asia/Jakarta time).


        Pass `hubId` to count only that hub's alerts plus the alerts with no
        hub.


        Requires permission `view/alert`.
      operationId: getAlertSummary
      parameters:
        - name: date
          in: query
          required: true
          description: |-
            Local day (Y-m-d).
            **Example:** `2026-10-15`
          schema:
            type: string
            format: date
        - name: hubId
          in: query
          required: false
          description: >-
            Only alerts of this hub, plus alerts with no hub. Alerts recorded
            before hubs were stored on alerts have no hub, so they are returned
            for every hub. Leave it out to get the alerts of every hub.

            **Example:** `6a712e4c2385f1c14e04beeb`
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    description: Status of response.
                  message:
                    description: Message of API response.
                    type: string
                  data:
                    description: >-
                      Object with `driverEmails`, a list of distinct user
                      emails.
                    type: object
                    additionalProperties: true
                example:
                  status: true
                  message: Success
                  data:
                    driverEmails:
                      - user@example.com
                      - user2@example.com
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    description: Shows if the request was successful.
                  message:
                    type: string
                    description: A short message explaining what went wrong.
                example:
                  status: false
                  message: Bad request - invalid parameters provided.
      deprecated: false
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Use a valid Bearer token to authenticate.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.