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 List of Signals (GET /v1/metadata/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 |
AssetId | integer | No | The ID of an asset to get the signals metadata for. If not provided, Model is required. |
Model | string | No | The model of an asset to get the signals metadata for. If not provided, AssetId is required. |
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. |
SignalType | string | No | The desired type of the returning signals. You can choose between RealTime or Historic. If you don’t make the choice, both signals are returned. |