NEnextbillion-ai
Tracking_Monitor

Update a Monitor

Changed on
put/skynet/monitor/{id}

Request

Path parameters

idstring required

ID of the monitor to be updated. This is the same ID that was generated at the time of creating the monitor.

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

descriptionstring

Use this parameter to update the description of the monitor.

geofence_idsstring[]

Use this parameter to update the geofences linked to the monitor by providing the geofence id as , separated strings. 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

Use this parameter to update the name of the monitor. Users can add meaningful names to the monitors like "warehouse_exit", "depot_entry" etc.

tagsstring[]

Use this parameter to update the tags of 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. Using this parameter overwrites the existing tags of the monitor.

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

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

Use this parameter to update the type of the monitor. 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.

Example request

{
  "name": "\"name\":\"warehouse_exit\"",
  "type": "\"type\":\"idle\"",
  "speeding_config": {
    "customer_speed_limit": "\"customer_speed_limit\":8"
  }
}

Response

OK

messagestring

Displays the error message in case of a failed request. If the request is successful, this field is not present in the 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.

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