Finder API

The Finder addon includes an API function that is extremely useful if you want to search backwards in time for a specific event signature.

Unlike the user-interface version of the function, you can create conditions with multiple property values (ie. when a machine was off and a pressure was high).

The URL is at <base-url>/finder/api/zoomsearch

The following parameters are accepted by the function.

Contains a string that defines the conditions that will be tested for. This is in the form of <asset>.<property><condition><value> (for example, Main Pump.Speed>5). This may include the '&' symbol to combine more than one statement.

The number of samples to request. Default to 2000. This value may be ignored by the system depending on the value of the 'mintime' parameter.

The total time (in seconds) to search. Defaults to 24 hours.

The start time. Defaults to the current time.

If '1', overrides the default scanning resolution and forces 1-second data to be requested.

The minimum length of the event you are looking for (ie. if the event is only important if it remains active for more than 10s, this should be '10'. Defaults to 1 second.

Note that higher minimum times will improve performance, as the system will be able to request data at a substantially lower resolution.

The function returns a JSON object that returns the rising edge (start) and falling edge (end) of the periods where your condition was met. For example, if you were to use this value for conditions…

Site.Hour=6

You might get this response:

[ 
   { "time": "2026-10-14 06:00:00", "edge": "rising"},
   { "time": "2026-10-14 07:00:00", "edge": "falling"}
]

The function is designed to search a limited span of time. If you want to search an unlimited amount of time, you'll need to call this function multiple times with different base dates in the start parameter.

Note that setting a mintime greater than 1 will speed up calculations, but will also make them less accurate, as it may add a small amount of drift (up to 1/2 of the minimum time, so 10 seconds with a 'mintime' of 20) to your final results.