Retrieve the Settings for Anomaly Detection

GET /intelligence/{accountName}/anomaly/settings

Retrieves Anomaly Detection settings for an account ID. 

See also:
Activate Anomaly Detection
Reset Anomaly Detection Parameters

Request Components

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 contain a current ThingSpace authorization bearer token and a valid VZ-M2M session token, and must set the content-type to JSON.

Parameter Name Data Type Description
Authorization
required		 string HTTP Authorization bearer token.
VZ-M2M-Token
required		 string A valid session token returned by POST /session/login.
Content-Type
required		 string Must be application/json.

Response Parameters

Parameter Name Data Type Description
accountName
 string

Indicates if the account name used has Anomaly Detection.

  • Success - The account has Anomaly Detection
  • Failure - The account does not have 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.

  • true - Monitor for very abnormal values 
  • false - Do not monitor for very abnormal values
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 Response

Status 200

Example Success Response:

{
  "accountName": "Success",
  "sensitivityParameter": [
    {
      "abnormalMaxValue": 1.1,
      "enableAbnormal": true,
      "enableVeryAbnormal": true,
      "veryAbnormalMaxValue": 0.55
    }
  ],
  "status": "Active"
}

Failure Responses

Status 400

All error messages are returned in this format:

{
  "errorCode": "error code string",
  "errorMessage": "error message string"
}

Error codes and messages are listed on the Error Messages page, along with explanations and suggestions for corrective actions.

Try It Out!