> ## 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 setting > Returns which alert types your organization records and which of them are also sent as notifications. When nothing has been saved yet, every type is off (`false`) and every notification flag is on (`true`). Alert types not listed here, such as panic alerts, are always recorded and notified. `thresholds` lists the limits each alert type fires on, for example the speed limit of the overspeed alert. The values are the effective limits of your organization: the defaults (80 km/h, 50 m within 30 min, 2 min, 150 m, 15%, 30 min) unless you changed them with `PUT /alert-setting`. The number of location updates in a row (`consecutivePings`) and the repeat time (`repeatMinutes`) are fixed. Requires permission `view/alertSetting`. ## OpenAPI ````yaml /openapi/public/openapi-monitoring.json get /alert-setting 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: /alert-setting: servers: - url: https://apiweb.mile.app/api/v4 get: tags: - Alert Setting summary: Read alert setting description: >- Returns which alert types your organization records and which of them are also sent as notifications. When nothing has been saved yet, every type is off (`false`) and every notification flag is on (`true`). Alert types not listed here, such as panic alerts, are always recorded and notified. `thresholds` lists the limits each alert type fires on, for example the speed limit of the overspeed alert. The values are the effective limits of your organization: the defaults (80 km/h, 50 m within 30 min, 2 min, 150 m, 15%, 30 min) unless you changed them with `PUT /alert-setting`. The number of location updates in a row (`consecutivePings`) and the repeat time (`repeatMinutes`) are fixed. Requires permission `view/alertSetting`. operationId: getAlertSetting 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: >- Alert type flags, notification flags, `updatedBy`, `updatedTime` and the read-only `thresholds`. type: object properties: thresholds: $ref: '#/components/schemas/AlertSettingThresholds' additionalProperties: true example: status: true message: Success data: geofence: true idle: true lateness: false routeDeviation: false overspeed: false lowBattery: false driverOffline: false geofenceNotification: true idleNotification: false latenessNotification: true routeDeviationNotification: true overspeedNotification: true lowBatteryNotification: true driverOfflineNotification: true updatedBy: admin@example.com updatedTime: '2026-10-10T04:00:00.000Z' thresholds: overspeed: speedKmh: 80 consecutivePings: 3 repeatMinutes: 10 idle: distanceMeters: 50 windowMinutes: 30 repeatMinutes: 10 lateness: graceMinutes: 2 routeDeviation: distanceMeters: 150 consecutivePings: 3 lowBattery: percent: 15 resetPercent: 25 repeatMinutes: 30 driverOffline: minutes: 30 deprecated: false security: - bearerAuth: [] components: schemas: AlertSettingThresholds: type: object description: >- Effective limits each alert type fires on for your organization, as the server applies them. Geofence has no entry. Change a limit by sending its flat field (for example `overspeedSpeedKmh`) in `PUT /alert-setting`; this object itself is ignored when sent. properties: overspeed: type: object description: Limits of the overspeed alert. properties: speedKmh: type: integer description: >- Speed limit, in km/h. Only a location update faster than this counts; exactly this speed does not. consecutivePings: type: integer description: Location updates in a row above the limit that raise an alert. repeatMinutes: type: integer description: >- Minutes between repeated alerts while the user keeps speeding. The same time without a fast location update ends the episode. idle: type: object description: Limits of the idle alert. properties: distanceMeters: type: integer description: >- The user counts as idle when they move less than this distance, in metres, within `windowMinutes`. windowMinutes: type: integer description: Time window the distance is measured over, in minutes. repeatMinutes: type: integer description: Minutes between repeated alerts while the user is still idle. lateness: type: object description: Limits of the predicted lateness alert. properties: graceMinutes: type: integer description: >- An alert is raised when the predicted arrival is more than this many minutes after the planned ETA. routeDeviation: type: object description: Limits of the route deviation alert. properties: distanceMeters: type: integer description: >- Distance from the planned route that counts as off-route, in metres. consecutivePings: type: integer description: Off-route location updates in a row that raise an alert. lowBattery: type: object description: Limits of the low battery alert. properties: percent: type: integer description: >- Battery limit, in percent. A level at or below it raises an alert. resetPercent: type: integer description: >- The alert can be raised again once the battery has been at or above this level (the limit plus 10). repeatMinutes: type: integer description: >- Minutes between repeated alerts while the battery stays at or below the limit. driverOffline: type: object description: Limit of the driver offline alert. properties: minutes: type: integer description: >- Minutes without a location after which a user on a trip is offline. Default `30`. example: overspeed: speedKmh: 80 consecutivePings: 3 repeatMinutes: 10 idle: distanceMeters: 50 windowMinutes: 30 repeatMinutes: 10 lateness: graceMinutes: 2 routeDeviation: distanceMeters: 150 consecutivePings: 3 lowBattery: percent: 15 resetPercent: 25 repeatMinutes: 30 driverOffline: minutes: 30 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.