NEnextbillion-ai
Tracking_Monitor

Create a Monitor

Changed on
post/skynet/monitor

Request

Query parameters

keystring 32 character alphanumeric string required
Example:key=API_KEY

A key is a unique identifier that is required to authenticate a request to the API.

Request body

custom_idstring

Set a unique ID for the new monitor. If not provided, an ID will be automatically generated in UUID format. A valid custom_id can contain letters, numbers, "-", & "_" only.

Please note that the ID of an monitor can not be changed once it is created.

type'enter' | 'exit' | 'enter_and_exit' | 'speeding' | 'idle' required

Specify the type of activity the monitor would detect.

The monitor will be able to detect the specified type of activity and create events for eligible asset. A monitor can detect following types of asset activity:

  • enter: The monitor will create an event when a linked asset enters into the specified geofence.

  • exit: The monitor will create an event when a linked asset exits the specified geofence.

  • enter_and_exit: The monitor will create an event when a linked asset either enters or exits the specified geofence.

  • speeding: The monitor will create an event when a linked asset exceeds a given speed limit.

  • idle: The monitor will create an event when a linked asset exhibits idle activity.

Please note that assets and geofences can be linked to a monitor using the match_filter and geofence_config attributes respectively.

tagsstring[] required

Use this parameter to add tags to the monitor. tags can be used for filtering monitors in the Get Monitor List operation. They can also be used for easy identification of monitors.

Please note that valid tags are strings, consisting of alphanumeric characters (A-Z, a-z, 0-9) along with the underscore ('_') and hyphen ('-') symbols.

descriptionstring

Add a description for your monitor using this parameter.

geofence_idsstring[]

Deprecated. Please use the geofence_config to specify the geofence_ids for this monitor.

An array of strings to collect the geofence IDs that should be linked to the monitor. Geofences are geographic boundaries that can be used to trigger events based on an asset's location.

meta_dataMetadata

Any valid json object data. Can be used to save customized data. Max size is 65kb.

namestring

Name of the monitor. Use this field to assign a meaningful, custom name to the monitor being created.

Example request

{
  "type": "\"type\":\"speeding\""
}

Response

statusstring

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 section below for more information.

messagestring

Displays the error message in case of a failed request. If the request is successful, this field is not present in the response.

Changes

  • 7ee76f0ff679Revision changes
    • breaking

      removed the enum value enter_and_exit of the request property

    • breaking

      removed the enum value enter of the request property

    • breaking

      removed the enum value exit of the request property

    • breaking

      removed the enum value idle of the request property

    • breaking

      removed the enum value speeding of the request property

    • info

      added the new enter enum value to the request property

    • info

      added the new enter_and_exit enum value to the request property

    • info

      added the new exit enum value to the request property

    • info

      added the new idle enum value to the request property

    • info

      added the new speeding enum value to the request property

  • a800b73f11c1Revision changes
    • breaking

      removed the enum value enter of the request property

    • breaking

      removed the enum value enter_and_exit of the request property

    • breaking

      removed the enum value exit of the request property

    • breaking

      removed the enum value idle of the request property

    • breaking

      removed the enum value speeding of the request property

    • info

      added the new enter_and_exit enum value to the request property

    • info

      added the new enter enum value to the request property

    • info

      added the new exit enum value to the request property

    • info

      added the new idle enum value to the request property

    • info

      added the new speeding enum value to the request property