This is an old revision of the document!
/api/events/search
Usage
This function is used to get a list of events that meet specific criteria.
Most commonly, this is a date range, but you can also limit other factors such as the sources of data you want to search through.
Details
| Detail | Value |
|---|---|
| Group | Asset |
| From Server Version | 2024.0.0 |
| Permission | Guest |
| Methods | GET or POST |
Parameters
| Parameter | Notes | Meaning |
|---|---|---|
| from | UTC Date (YYYY-mm-dd HH:MM:SS) | Starting Date |
| to | UTC Date (YYYY-mm-dd HH:MM:SS) | Ending Date |
| search | String | Search Text |
| sources | String | List of source names (2025.0.2+) |
| format | String (xml) | Either 'xml' or 'json' |
Examples
Call
http://ardiserver.com/api/events/search?start=2025-01-01 10:00:00&end=2025-01-02 10:00:00&search=Batch
Searches for any events with 'Batch' in the name on the first day of 2025 after 10:00 UTC.
Success (XML)
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<events>
<event name="Batch 2003" start="2025-01-01 12:42:55" end="2025-01-01 13:22:16">
<prop name="product">Plain Sugar Cookies</prop>
</event>
</events>
Success (JSON)
[
{
"name": "Batch 2003",
"start": "2025-01-01 12:42:55",
"end": "2025-01-01 13:22:16",
"product": "Plain Sugar Cookie"
}
]