Requirements
An active Farsight® admin account
Authorized API Key
Limitations
For details on usage limits (like requests per hour/month), please refer to the dedicated limitations article
Get A Paginated List of Signals (GET/v1/historical/signals)
The following parameters are used to filter, sort, and paginate the list of signals returned in the response. All parameters are optional unless otherwise noted.
Input Parameter | Type | Required | Definition |
Signal | string | Yes | The signals you want returned. You can add multiple signals. |
AssetId | integer | Yes | The ID of an asset to get the signals for. You can add multiple assets. |
Limit | integer | No | The number of items you want the API to return. It can range from 1 to 50 (Free) or 1 to 500 (Pro). The default value is set to 25. |
Offset | integer | No | The index of the first item to return. Must be 0 or greater. It is set to 0 by default. |
From | string | Yes | The start date to get availability, can be in UNIX seconds or a UTC Timestamp (ISO 8601). |
To | string | Yes | The end date to get availability, can be in UNIX seconds or a UTC Timestamp (ISO 8601). |
sort | string | No | Fields used in the results sorting. Composed by the name of the field followed by :asc or :desc. Example: timestamp:desc, default: timestamp:asc. |
Get A Paginated List of Statuses (GET/v1/historical/statuses)
The following parameters are used to filter, sort, and paginate the list of statuses returned in the response. All parameters are optional unless otherwise noted.
Input Parameter | Type | Required | Definition |
Limit | integer | No | The number of items you want the API to return. It can range from 1 to 50 (Free) or 1 to 500 (Pro). The default value is set to 25. |
Offset | integer | No | The index of the first item to return. Must be 0 or greater. It is set to 0 by default. |
AssetId | integer | Yes | The ID of an asset you want statuses returned for. You can add multiple assets. |
EventType | string | No | The event for the statuses you want. You can choose from Information, Maintenance, Warning, and Fault. |
StatusCode | string | No | The code for the statuses you want returned. You can add one or multiple StatusCode. |
From | string | Yes | The start date of the interval. It can be in UNIX seconds or a UTC Timestamp (ISO 8601). |
To | string | Yes | The end date of the interval. It can be in UNIX seconds or a UTC Timestamp (ISO 8601). |
MinDuration | string | No | The minimum duration of the returned statuses in ISO 8601 standard format. (example: 'PT1H30M' for 1h and 30m). |
MaxDuration | string | No | The maximum duration of the returned statuses in ISO 8601 standard format. (example: 'PT1H30M' for 1h and 30m). |
sort | string | No | Fields used in the results sorting. Composed by the name of the field followed by :asc or :desc. Example: timestamp:desc, default: timestamp:asc. |