Start Diagnostics Observation

Start Diagnostics Observation:
POST /devices/attributes/actions/observe/

Request Diagnostics observation information via live periodic interval streaming of RF parameters from a list of IOT devices.

Contents

Uses and Requirements

This API will return (POST) callbacks, including the device identity, the attribute names, corresponding attribute values and the date/timestamp of when the observation was made for the attributes listed in the callback.

An RF attribute of the device can be streamed via periodically reported data. The highest frequency of reporting is 15 seconds. There is no upper limit on this time interval; however, for devices that are configured to sleep, this interval should be set less than the active timer for the device. Also streaming can be requested for a certain total duration of time. For the API, there is no limit to the maximum duration of monitoring. Monitoring will stop when one of these two occurs (whichever occurs first):

  • The specified monitoring duration is met;
  • Or the monthly allowance is met.

Request Components

HTTP Request

POST https://thingspace.verizon.com/api/diagnostics/v1/devices/attributes/actions/observe

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 /api/m2m/v1/session/login.
Content-Type
required
string Must be application/json.

Request Body

Parameter Name Data Type Description
accountName string The name of the account for which you want start running Diagnostic Services. An account name is usually numeric, and must include any leading zeros.
devices
required
array of objects The devices on which you want to start running diagnostics.
devices.id
required
string A device identifier value
devices.kind
required
string Type of identifier
  • IMEI
  • ESN
  • MEID
attributes
required
array of objects Attributes are streaming RF parameters that you want to observe.
attributes.name
required
string examples:
  • RADIO_SIGNAL_STRENGTH
  • LINK_QUALITY
  • NETWORK_BEARER
  • CELL_ID
frequency
required
frequency data object Frequency for observing diagnostics
frequency.value
required
integer($int32) Mininum value is 15 seconds
frequency.unit
required
string
  • SECOND
  • MINUTE
  • HOUR
  • DAY
duration
required
duration data object Length of time for observing diagnostics
duration.value
required
integer($int32) Mininum value is 15 seconds
duration.unit
required
string
  • SECOND
  • MINUTE
  • HOUR
  • DAY

Example Request Body

{
  "accountName": "TestQAAccount",
  "devices": [
    {
      "id": "864508030026238",
      "kind": "IMEI"
    }
  ],
  "attributes": [
      {
    "name": "RADIO_SIGNAL_STRENGTH"
      },
      {
    "name": "LINK_QUALITY"
     },
     {
    "name":"NETWORK_BEARER"
     },
    {
    "name":"CELL_ID"
    }
  ],
  "frequency": {
    "value": 15,
    "unit": "SECOND"
  },
  "duration": {
    "value": 15,
    "unit": "SECOND"
  }
}

Success Responses

Status 200

Parameter Name Data Type Description
createdOn string($date-time) The date and time of when this request was created.
transactionID string The transaction ID of the diagnostics service that you are starting.
status string Status of the request.

Example Success Response

{
    "createdOn": "2019-09-10T20:32:39.490173358Z",
    "transactionID": "26bd4791-8b4f-49b5-b791-b52056902f30",
    "status": "OBSERVE_PENDING"
}

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 Codes page, along with explanations and suggestions for corrective actions.

Try It Out!