--- title: "Get a Monitor" method: GET path: "/skynet/monitor/{id}" tags: ["Tracking_Monitor"] --- # Get a Monitor `GET /skynet/monitor/{id}` ## Path parameters - `id` string, required ## Query parameters - `key` string, 32 character alphanumeric string, required ## Response `200` OK - DtoGetMonitorResp - `status` string — A string indicating the state of the response. On successful responses, the value will be Ok. Indicative error messages are returned for different errors. See the [API Error Codes](#api-error-codes) section below for more information. - `data` object — A data object containing the details of the monitor. - `monitor` DtoMonitorResponse - `id` string — Unique ID of the monitor. This is the same ID that was generated at the time of creating the monitor. - `type` 'enter' | 'exit' | 'enter_and_exit' | 'speeding' | 'idle' — Type of the monitor. It represents the type of asset activity that the monitor is configured to detect. - `name` string — Name of the monitor. The value would be the same as that provided for the name parameter at the time of creating or updating the monitor. - `tags` string[] — Tags of the monitor. The values would be the same as that provided for the tags parameter at the time of creating or updating the monitor. - `description` string — Description of the monitor. The value would be the same as that provided for the description parameter at the time of creating or updating the monitor. - `meta_data` Metadata — Any valid json object data. Can be used to save customized data. Max size is 65kb. - `geofences` string[] — Geofence IDs that are linked to the monitor. These IDs were associated with the monitor at the time of creating or updating it. The monitor uses the geofences mentioned here to create events of type nature for the eligible asset(s). - `updated_at` integer — A UNIX epoch timestamp in seconds representing the time at which the monitor was last updated. - `created_at` integer — A UNIX epoch timestamp in seconds representing the time at which the monitor was created. - `match_filter` MonitorMatchFilterResponse — Use this object to update the attributes of the monitor. - `include_all_of_attributes` object — A string type dictionary object to specify the attributes which will be used to identify the asset(s) on which the monitor would be applied. Please note that using this parameter overwrites the existing attributes of the monitor. If the attributes added to a monitor do not match fully with the attributes added to any asset, the monitor will be ineffective. Please note that the maximum number of key:value pairs that 'include_all_of_attributes' can take is 100. Also, the overall size of the match_filter object should not exceed 65kb. - `include_any_of_attributes` object — A string dictionary object to specify the attributes, separated by a ,. Only the assets with any one of the attributes added to this parameter will be linked to this monitor. Once an asset and a monitor are linked, the monitor will be able to create events for the asset when an activity specified in type is detected. If no input is provided for this object or if the attributes added here do not match at least one of the attributes added to any asset, the monitor will be ineffective. Please note that the maximum number of key:value pairs that include_any_of_attributes can take is 100. Also, the overall size of match_filter object should not exceed 65kb. - `speeding_config` SpeedConfigResponse — An object returning the details of the over-speeding constraints for a speeding type of monitor. - `time_tolerance` integer — This property returns the time duration value, in milliseconds, for which the monitor will track the speed of the asset. An event is triggered if the speed remains higher than the specified limit for a duration more than the tolerance value. The value returned for this parameter is the same as that provided while creating or updating a speeding type monitor. - `customer_speed_limit` integer — This property returns the actual speed limit that the monitor uses as a threshold for generating a speed limit event. The value returned for this parameter is the same as that provided while creating or updating a speeding type monitor. - `use_admin_speed_limit` boolean — A boolean value denoting if the administrative speed limit of the road was used as speed limit threshold for triggering events. The value returned for this parameter is the same as that provided while creating or updating a speeding type monitor. - `idle_config` IdleConfigResponse — An object returning the details of the idle activity constraints for a idle type of monitor. - `distance_tolerance` number — This parameter returns the distance threshold that was used to determine if the asset was idle or not. The value returned for this parameter is the same as that provided while creating or updating a idle type monitor. - `time_tolerance` integer — This parameter returns the time duration for which the monitor tracks the distance covered by an asset before triggering an idle event. The value returned for this parameter is the same as that provided while creating or updating a idle type monitor. - `geofence_config` GeofenceConfigResponse — An object returning the details of the geofence that are associated with the monitor for an enter, exit or enter_and_exit type of monitor. - `geofence_ids` string[] — An array of geofence IDs that are linked to the monitor. Geofences are geographic boundaries that can be used to trigger events based on an asset's location. - `message` string — Displays the error message in case of a failed request. If the request is successful, this field is not present in the response. ## Other responses - `400` — Bad Request - `500` — Internal Server Error --- [API](https://skmtc.net/nextbillion-ai/apis/one-spec-service.md) · [All operations](https://skmtc.net/nextbillion-ai/apis/one-spec-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nextbillion-ai/one-spec-service/versions/b647f1808dda/schema)