Dynamic Queries¶
Note that Dynamic Queries are currently in preview mode - as such, some features may not be fully functional.
Dynamic Queries are a set of advanced video analytics tools that allow you to set up queries for specific use cases. They can be run on both live and historic videos, and can be integrated with third-party systems such as Milestone XProtect.
Traffic Counting¶
Traffic Counting is a query that counts the number of objects crossing a line.
- Name: A name identifying your query. By default, a unique ID is auto-generated, which can be changed here.
- Description (optional): Describe your Query here.
Select videos¶
Select a video from the list. Note that currently, only one video may be used with Dynamic Queries at a time.
Object parameters¶
Set the parameters of the object type you'd like to run your query on:
- Object type - Select an object type category: person, vehicle, animal, background or other then select an object type from the drop-down list. Person is chosen by default.
- Classes (optional): Some object types may have additional classes available for filtering (such as helmet and gender for person objects). Select any number of them, then tick the necessary checkbox(es).
Select date¶
Select a time frame for the analytics to run, depending on the type of video selected above:
- Earliest: Run the query from the time shown (set during video registration as the beginning timestamp of the video).
- Latest: Run the query until the time shown (set during video registration as the end timestamp of the video).
- Given Date: You can select a custom start and end date and time to run the query on. Type the desired date and time or select them by clicking the calendar icon.
- Live: Analysis is run live, continously.
- Interval: You can select a custom start and end date and time to run the query on. Type the desired date and time or select them by clicking the calendar icon.
- Set interval to: Choose from the presets below to run the query on a given time inmterval.
Line crossed attributes¶
The detector filters results to objects that cross the line in a direction set here; click Edit Line to set the line attributes. Click Assign to save the line attributes.
Set Window¶
The interval between aggregating the counted objects, in milliseconds (5000 by default).
External Integrations (optional)¶
The query can optionally be integrated with third-party systems, such as Milestone XProtect or a webhook to trigger alarms.
Currently, alarm integration with Milestone XProtect or Webhook is only available for live videos.
Webhook¶
The query can be configured to send detections to a Webhook URL.
- URL: The URL of the Webhook.
- Custom header key: The key of the custom header.
- Custom header value: The value of the custom header.
Hazardous Area¶
Hazardous Area is a query that detects people entering a zone considered to be hazardous. The query can be configured to alert only if a secondary object is present in the configured area.
- Name: A name identifying your query. By default, a unique ID is auto-generated, which can be changed here.
- Description (optional): Describe your Query here.
Select videos¶
Select a video from the list. Note that currently, only one video may be used with Dynamic Queries at a time.
Select date¶
Select a time frame for the analytics to run, depending on the type of video selected above:
- Earliest: Run the query from the time shown (set during video registration as the beginning timestamp of the video).
- Latest: Run the query until the time shown (set during video registration as the end timestamp of the video).
- Given Date: You can select a custom start and end date and time to run the query on. Type the desired date and time or select them by clicking the calendar icon.
- Live: Analysis is run live, continously.
- Interval: You can select a custom start and end date and time to run the query on. Type the desired date and time or select them by clicking the calendar icon.
- Set interval to: Choose from the presets below to run the query on a given time inmterval.
Optional condition¶
Hazardous Area optionally allows for the definition of a secondary object type, an additional condition; if ticked, the query will only trigger an alert if a person enters an area and the secondary object is present there.
Appear attributes¶
-
Min. track duration: The minimum time objects need to be tracked to trigger an alert. If the time duration of the track is less than the min track duration parameter, the query will not trigger an alert. If set to 0, the query will trigger an alert immediately once the object enters the area.
-
After out of zone fire again: If ticked, the query will trigger an additional alert if the person leaves the area.
Object parameters¶
Set the parameters of the secondary object (optional) type you'd like to run your query on:
- Object type - Select an object type category: person, vehicle, animal, background or other then select an object type from the drop-down list. Person is chosen by default.
- Classes (optional): Some object types may have additional classes available for filtering (such as helmet and gender for person objects). Select any number of them, then tick the necessary checkbox(es).
Sampling attributes¶
- Sampling interval (in seconds): The interval between sampling images from the video.
Space Join¶
- Max time diff (in milliseconds): The maximum time difference between the person and the secondary object to trigger an alert. If the time difference between the two objects is less than the value set here, the query will trigger an alert.
- Join order: The order in which objects need to enter the area to trigger an alert.
External Integrations (optional)¶
Currently, alarm integration with Milestone XProtect or Webhook is only available for live videos.
The query can optionally be integrated with third-party systems, such as Milestone XProtect or a webhook to trigger alarms.
- Cooldown (in seconds): The minimum time between two alerts sent to the chosen integration.
Milestone XProtect Analytics Event Integration¶
The query can be configured to send detections to Milestone XProtect, appearing as Analytics Events.
- Milestone XProtect host address: The IP address of the Milestone XProtect server.
- Analytics event name: The name of the Milestone XProtect Analytics Event that triggers the query.
- Event display name: The display name of the event that will be shown in the event list.
- Description: The description of the event that will be shown in the event list.
- Timestamp offset (in seconds): The time offset between the Milestone XProtect Analytics Event and the query trigger.
Webhook¶
The query can be configured to send detections to a Webhook URL.
- URL: The URL of the Webhook.
- Custom header key: The key of the custom header.
- Custom header value: The value of the custom header.
Loitering Detection¶
Loitering Detection is a query that detects people or vehicles staying in are for a configurable amount of time.
- Name: A name identifying your query. By default, a unique ID is auto-generated, which can be changed here.
- Description (optional): Describe your Query here.
Select videos¶
Select a video from the list. Note that currently, only one video may be used with Dynamic Queries at a time.
Object parameters¶
Set the parameters of the object type you'd like to run your query on:
- Object type - Select an object type category: person, vehicle, animal, background or other then select an object type from the drop-down list. Person is chosen by default.
- Classes (optional): Some object types may have additional classes available for filtering (such as helmet and gender for person objects). Select any number of them, then tick the necessary checkbox(es).
Select date¶
Select a time frame for the analytics to run, depending on the type of video selected above:
- Earliest: Run the query from the time shown (set during video registration as the beginning timestamp of the video).
- Latest: Run the query until the time shown (set during video registration as the end timestamp of the video).
- Given Date: You can select a custom start and end date and time to run the query on. Type the desired date and time or select them by clicking the calendar icon.
- Live: Analysis is run live, continously.
- Interval: You can select a custom start and end date and time to run the query on. Type the desired date and time or select them by clicking the calendar icon.
- Set interval to: Choose from the presets below to run the query on a given time inmterval.
Appear attributes¶
- Min. track duration: The minimum time objects need to be tracked to trigger an alert. If the time duration of the track is less than the min track duration parameter, the query will not trigger an alert. If set to 0, the query will trigger an alert immediately.
After out of zone fire again: If ticked, the query will trigger an alert if the person leaves the area.
External Integrations (optional)¶
Currently, alarm integration with Milestone XProtect or Webhook is only available for live videos.
The query can optionally be integrated with third-party systems, such as Milestone XProtect or a webhook to trigger alarms.
- Cooldown (in seconds): The minimum time between two alerts sent to the chosen integration.
Milestone XProtect Analytics Event Integration¶
The query can be configured to send detections to Milestone XProtect, appearing as Analytics Events.
- Milestone XProtect host address: The IP address of the Milestone XProtect server.
- Analytics event name: The name of the Milestone XProtect Analytics Event that triggers the query.
- Event display name: The display name of the event that will be shown in the event list.
- Description: The description of the event that will be shown in the event list.
- Timestamp offset (in seconds): The time offset between the Milestone XProtect Analytics Event and the query trigger.
Webhook¶
The query can be configured to send detections to a Webhook URL.
- URL: The URL of the Webhook.
- Custom header key: The key of the custom header.
- Custom header value: The value of the custom header.
Multiple Crossline Counting¶
Multiple Crossline Counting is a query that counts the number of objects crossing exactly two lines. The query uses the following parameters:
- Name: A name identifying your query. By default, a unique ID is auto-generated, which can be changed here.
- Description (optional): Describe your Query here.
Select videos¶
Select a video from the list. Note that currently, only one video may be used with Dynamic Queries at a time.
Object parameters¶
Set the parameters of the object type you'd like to run your query on:
- Object type - Select an object type category: person, vehicle, animal, background or other then select an object type from the drop-down list. Person is chosen by default.
- Classes (optional): Some object types may have additional classes available for filtering (such as helmet and gender for person objects). Select any number of them, then tick the necessary checkbox(es).
Select date¶
Select a time frame for the analytics to run, depending on the type of video selected above:
- Earliest: Run the query from the time shown (set during video registration as the beginning timestamp of the video).
- Latest: Run the query until the time shown (set during video registration as the end timestamp of the video).
- Given Date: You can select a custom start and end date and time to run the query on. Type the desired date and time or select them by clicking the calendar icon.
- Live: Analysis is run live, continously.
- Interval: You can select a custom start and end date and time to run the query on. Type the desired date and time or select them by clicking the calendar icon.
- Set interval to: Choose from the presets below to run the query on a given time inmterval.
Line crossed attributes¶
The detector filters results to objects that cross both lines in directions set here; click Edit Line to set the line attributes. Click Assign to save the line attributes.
Space Join¶
The detector looks for objects close in space to determine if they are tailgating.
- Max time diff (in milliseconds): The maximum time difference between two objects crossing both lines. If the time difference between the two objects is less than the value set here, the query will trigger an alert.
- Join order: The order in which objects need to cross the lines to trigger an alert.
Set Window¶
The interval between aggregating the counted objects, in milliseconds (5000 by default).
External integrations (optional)¶
The query can optionally be integrated with third-party systems, such as Milestone XProtect or a webhook to trigger alarms.
Currently, alarm integration with Milestone XProtect or Webhook is only available for live videos.
Webhook¶
The query can be configured to send detections to a Webhook URL.
- URL: The URL of the Webhook.
- Custom header key: The key of the custom header.
- Custom header value: The value of the custom header.
Tailgating¶
Tailgating is a security breach where an unauthorized person follows an authorized person into a secure area. This is a common security breach in many organizations. The Tailgating query is designed to detect tailgating events in real-time, for both people and vehicles.
- Name: A name identifying your query. By default, a unique ID is auto-generated, which can be changed here.
- Description (optional): Describe your Query here.
Select videos¶
Select a video from the list. Note that currently, only one video may be used with Dynamic Queries at a time.
Object parameters¶
Set the parameters of the object type you'd like to run your query on:
- Object type - Select an object type category: person, vehicle, animal, background or other then select an object type from the drop-down list. Person is chosen by default.
- Classes (optional): Some object types may have additional classes available for filtering (such as helmet and gender for person objects). Select any number of them, then tick the necessary checkbox(es).
Select date¶
Select a time frame for the analytics to run, depending on the type of video selected above:
- Earliest: Run the query from the time shown (set during video registration as the beginning timestamp of the video).
- Latest: Run the query until the time shown (set during video registration as the end timestamp of the video).
- Given Date: You can select a custom start and end date and time to run the query on. Type the desired date and time or select them by clicking the calendar icon.
- Live: Analysis is run live, continously.
- Interval: You can select a custom start and end date and time to run the query on. Type the desired date and time or select them by clicking the calendar icon.
- Set interval to: Choose from the presets below to run the query on a given time inmterval.
Line crossed attributes¶
The detector filters results to objects that cross the line in a direction set here; click Edit Line to set the line attributes. Click Assign to save the line attributes.
Space Join¶
The detector looks for people close in space to determine if they are tailgating.
- Max time diff (in milliseconds): The maximum time difference between the two people to be considered tailgating; If the time difference between the two people is less than the value set here, the query will trigger an alert.
External Integrations (optional)¶
Currently, alarm integration with Milestone XProtect or Webhook is only available for live videos.
The query can optionally be integrated with third-party systems, such as Milestone XProtect or a webhook to trigger alarms.
- Cooldown (in seconds): The minimum time between two alerts sent to the chosen integration.
Milestone XProtect Analytics Event Integration¶
The query can be configured to send detections to Milestone XProtect, appearing as Analytics Events.
- Milestone XProtect host address: The IP address of the Milestone XProtect server.
- Analytics event name: The name of the Milestone XProtect Analytics Event that triggers the query.
- Event display name: The display name of the event that will be shown in the event list.
- Description: The description of the event that will be shown in the event list.
- Timestamp offset (in seconds): The time offset between the Milestone XProtect Analytics Event and the query trigger.
Webhook¶
The query can be configured to send detections to a Webhook URL.
- URL: The URL of the Webhook.
- Custom header key: The key of the custom header.
- Custom header value: The value of the custom header.
Object Counting¶
Object Counting is a query that counts the number of objects in a video.
- Name: A name identifying your query. By default, a unique ID is auto-generated, which can be changed here.
- Description (optional): Describe your Query here.
Select videos¶
Select a video from the list. Note that currently, only one video may be used with Dynamic Queries at a time.
Object parameters¶
Set the parameters of the object type you'd like to run your query on:
- Object type - Select an object type category: person, vehicle, animal, background or other then select an object type from the drop-down list. Person is chosen by default.
- Classes (optional): Some object types may have additional classes available for filtering (such as helmet and gender for person objects). Select any number of them, then tick the necessary checkbox(es).
Select date¶
Select a time frame for the analytics to run, depending on the type of video selected above:
- Earliest: Run the query from the time shown (set during video registration as the beginning timestamp of the video).
- Latest: Run the query until the time shown (set during video registration as the end timestamp of the video).
- Given Date: You can select a custom start and end date and time to run the query on. Type the desired date and time or select them by clicking the calendar icon.
- Live: Analysis is run live, continously.
- Interval: You can select a custom start and end date and time to run the query on. Type the desired date and time or select them by clicking the calendar icon.
- Set interval to: Choose from the presets below to run the query on a given time inmterval.
Line crossed attributes¶
The detector filters results to objects that cross the line in a direction set here; click Edit Line to set the line attributes. Click Assign to save the line attributes.
Set Window¶
The interval between aggregating the counted objects, in milliseconds (5000 by default).
External Integrations (optional)¶
The query can optionally be integrated with third-party systems, such as Milestone XProtect or a webhook to trigger alarms.
Currently, alarm integration with Milestone XProtect or Webhook is only available for live videos.
Webhook¶
The query can be configured to send detections to a Webhook URL.
- URL: The URL of the Webhook.
- Custom header key: The key of the custom header.
- Custom header value: The value of the custom header.