Activate Anomaly Detection

Activate Anomaly Detection

POST /intelligence/anomaly/settings

Activates Anomaly Detection for an account ID and sets the initial thresholds for detection triggers.

See also:
Retrieve the settings for Anomaly Detection
Reset Anomaly Detection Parameters

Request Components

HTTP Request

POST https://thingspace.verizon.com/api/m2m/v1/intelligence/anomaly/settings

Resource Path and Query Parameters

 

None.

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.

Request Body

The request body identifies the account that Anomaly Detection willl be activated for and sets initial maximums for abnormal and very abnormal and if abnormal, very abnormal or both will be monitored.

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.
requestType
required
string The type of request being made. anomaly is the request to activate Anomaly Detection
sensitivityParameter object The initial values and monitoring state for abnormal and very abnormal.


sensitivityParameter.abnormalMaxValue
required if being monitored

string The maximum value of the threshold in the units being measured.
sensitivityParameter.enableAbnormal
required
boolean

If abnomal values are being monitored.

  • true - Monitor for abnormal values 
  • false - Do not monitor for abnormal values
sensitivityParameter.enableVeryAbnormal
required
boolean

If very abnomal values are being monitored.

  • true - Monitor for very abnormal values 
  • false - Do not monitor for very abnormal values
sensitivityParameter.veryAbnormalMaxValue
required if being monitored
string The maximum value of the threshold in the units being measured.

Example Request

{
  "accountName": "0000123456-00001",
  "requestType": "anomaly",
  "sensitivityParameter": [
    {
      "abnormalMaxValue": 1.1,
      "enableAbnormal": true,
      "enableVeryAbnormal": true,
      "veryAbnormalMaxValue": 0.55
    }
  ]
}

Success Response

Status 200

Example Success Response:

{
  "status": "Success"
}

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!