Premium APIsThingSpace IntelligenceAnomaly DetectionAPI Reference
Retrieve the Settings for Anomaly Detection
GET /intelligence/{accountName}/anomaly/settings
Retrieves Anomaly Detection settings for an account ID.
HTTP Request
GET https://thingspace.verizon.com/api/m2m/v1/intelligence/{accountName}/anomaly/settings
Resource Path and Query Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| accountName required | string | The name of a billing account. An account name is usually numeric, and must include any leading zeros. |
Header Parameters
The request header must set the content-type to JSON, contain a current ThingSpace authorization token and a current VZ-M2M session token. For more details on how to get these tokens, visit Getting Started.
| Parameter Name | Data Type | Description |
|---|---|---|
| Authorization required | string | HTTP Authorization bearer token: Authorization: Bearer {token} |
| VZ-M2M-Token required | string | A valid session token: VZ-M2M-Token: {M2Mtoken} |
| Content-Type required | string | Must be application/json: Content-Type: application/json |
Response Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| accountName | string | Indicates if the account name used has Anomaly Detection.
|
| sensitivityParameter | object | The initial values and monitoring state for abnormal and very abnormal. |
| sensitivityParameter.abnormalMaxValue | string | The maximum value of the threshold in the units being measured. |
| sensitivityParameter.enableAbnormal | boolean | If abnomal values are being monitored. true - Monitor for abnormal values false - Do not monitor for abnormal values |
| sensitivityParameter.enableVeryAbnormal | boolean | If very abnomal values are being monitored.
|
| sensitivityParameter.veryAbnormalMaxValue | string | The maximum value of the threshold in the units being measured. |
| status | string | Indicates if Anomaly Detection is active on the account Active - Anomaly Detection is active Disabled- Anomaly Detection is not active |
Success Responses
Status 200
Example Success Response:
{
"accountName": "Success",
"sensitivityParameter": [
{
"abnormalMaxValue": 1.1,
"enableAbnormal": true,
"enableVeryAbnormal": true,
"veryAbnormalMaxValue": 0.55
}
],
"status": "Active"
}Failure Responses
All error messages are returned in this format:
{
"errorCode": "error code string",
"errorMessage": "error message string"
}