Retrieve Device Connection History

Retrieve Device Connection History:
POST /devices/connections/actions/listHistory

Returns a list of network connection events for a device during a specified time period.

Contents

See also:
Retrieve Device Provisioning History
Retrieve Device Usage History

Uses and Requirements

Each response includes a maximum of 500 records. To obtain more records, you can call the API multiple times, adjusting the earliest parameter each time to start where the previous request finished.

Request Components

HTTP Request

POST https://thingspace.verizon.com/api/m2m/v1/devices/connections/actions/listHistory

Query Parameters

None.

Header Parameters

The request header must contain the current session token.

Parameter Name Data Type Description
VZ-M2M-Token
required
string A valid session token returned by POST /session/login.

Request Body

The request body identifies the device and reporting period that you want included in the report.

Parameter Name Data Type Description
deviceId
required
deviceId object The device for which you want connection history, specified by its device identifier.
kind,
id

required for deviceId
string The type and value of the device identifier.
  • ESN - decimal, 11 digits
  • ICCID - decimal, up to 20 digits
  • IMEI - decimal, up to 15 digits
  • MDN - decimal, 10 digits
  • MEID - hexadecimal, 14 hex digits
  • MSISDN - decimal, 11 digits
earliest
required
string The earliest date and time for which you want connection events.
latest
required
string The last date and time for which you want connection events.

Example Request Body

{
  "deviceId": {
    "id": "89141390780800784259",
    "kind": "iccid"
  },
  "earliest": "2015-09-16T00:00:01Z",
  "latest": "2010-09-18T00:00:01Z"
}

Success Responses

Status 200 or 202

Parameter Name Data Type Description
connectionHistory array of connectionEvent objects Device connection events, sorted by the occurredAt timestamp, oldest first.
connectionEventAttributes
array of key-value pairs The attributes that describe the connection event. Note that a single connectionEvent can have many connectionEventAttributes.
extendedAttributes
null Currently not used.
occuredAt
dateTime string The date and time when the connection event occured.
hasMoreData boolean False for a status 200 response.
True for a status 202 response, indicating that there is more data to be retrieved. Send another request, adjusting the earliest value in the request based on the occuredAt value for the last device in the current response.

Example Success Response

{
  "connectionHistory": [
    {
      "connectionEventAttributes": [
        {
          "key": "BytesUsed",
          "value": "0"
        },
        {
          "key": "Event",
          "value": "Start"
        },
        {
          "key": "Msisdn",
          "value": "15086303371"
        },
        {
          "key": "Username",
          "value": "15086303371@vzw3g.com"
        },
        {
          "key": "Account3Gpp2BeginSession",
          "value": "1"
        },
        {
          "key": "Account3Gpp2CorrelationId",
          "value": "k1qSXcfL"
        },
        {
          "key": "Account3Gpp2OriginatingNumberSdbs",
          "value": "0"
        },
        {
          "key": "Account3Gpp2ReleaseIndicator",
          "value": "0"
        },
        {
          "key": "Account3Gpp2TerminatingNumberSdbs",
          "value": "0"
        },
        {
          "key": "InputBytes",
          "value": "0"
        },
        {
          "key": "OutputBytes",
          "value": "0"
        },
        {
          "key": "AccountSessionId",
          "value": "431DF703"
        },
        {
          "key": "AccountSessionTime",
          "value": "0"
        },
        {
          "key": "AccountTerminateCause",
          "value": "0"
        },
        {
          "key": "CallingStationId",
          "value": "15096303371"
        },
        {
          "key": "FramedIpAddress",
          "value": "100.127.22.52"
        },
        {
          "key": "Account3Gpp2ActiveTime",
          "value": "0"
        },
        {
          "key": "Account3Gpp2BadPppFrameCount",
          "value": "0"
        },
        {
          "key": "Account3Gpp2FchFrameSize",
          "value": "0"
        },
        {
          "key": "Account3Gpp2ForwardFchMuxOption",
          "value": "0"
        },
        {
          "key": "Account3Gpp2ForwardFchRc",
          "value": "0"
        },
        {
          "key": "Account3Gpp2ForwardTrafficType",
          "value": "0"
        },
        {
          "key": "Account3Gpp2InboundMobileIpSigBytes",
          "value": "0"
        },
        {
          "key": "Account3Gpp2IpTechnology",
          "value": "0"
        },
        {
          "key": "Account3Gpp2OriginatingSdbByteCount",
          "value": "0"
        },
        {
          "key": "Account3Gpp2OutboundMobileIpSigBytes",
          "value": "0"
        },
        {
          "key": "Account3Gpp2ReverseFchMuxOption",
          "value": "0"
        },
        {
          "key": "Account3Gpp2ReverseFchRc",
          "value": "0"
        },
        {
          "key": "Account3Gpp2ReverseTrafficType",
          "value": "0"
        },
        {
          "key": "Account3Gpp2ServiceOption",
          "value": "595"
        },
        {
          "key": "Account3Gpp2SessionContinue",
          "value": "0"
        },
        {
          "key": "Account3Gpp2TerminatingSdbByteCount",
          "value": "0"
        },
        {
          "key": "AccountInputPackets",
          "value": "0"
        },
        {
          "key": "AccountOutputPackets",
          "value": "0"
        },
        {
          "key": "AccountStatusType",
          "value": "Start"
        },
        {
          "key": "NasIpAddress",
          "value": "175505666"
        },
        {
          "key": "NasPort",
          "value": "558393"
        },
        {
          "key": "Account3Gpp2CompulsoryTunnelIndicator",
          "value": "0"
        },
        {
          "key": "Account3Gpp2HomeAgentIpAddress",
          "value": "66.174.20.198"
        }
      ],
      "extendedAttributes": null,
      "occurredAt": "2015-12-17T14:12:36-05:00"
    },
    {
      "connectionEventAttributes": [
        {
          "key": "BytesUsed",
          "value": "419863234"
        },
        {
          "key": "Event",
          "value": "Stop"
        },
        {
          "key": "Msisdn",
          "value": "15086303371"
        },
        {
          "key": "Username",
          "value": "15086303371@vzw3g.com"
        },
        {
          "key": "Account3Gpp2BeginSession",
          "value": "0"
        },
        {
          "key": "Account3Gpp2CorrelationId",
          "value": "k1qSXcfL"
        },
        {
          "key": "Account3Gpp2OriginatingNumberSdbs",
          "value": "0"
        },
        {
          "key": "Account3Gpp2ReleaseIndicator",
          "value": "0"
        },
        {
          "key": "Account3Gpp2TerminatingNumberSdbs",
          "value": "0"
        },
        {
          "key": "InputBytes",
          "value": "12848174"
        },
        {
          "key": "OutputBytes",
          "value": "407015060"
        },
        {
          "key": "AccountSessionId",
          "value": "431DF703"
        },
        {
          "key": "AccountSessionTime",
          "value": "126444"
        },
        {
          "key": "AccountTerminateCause",
          "value": "User_Request"
        },
        {
          "key": "CallingStationId",
          "value": "15096303371"
        },
        {
          "key": "FramedIpAddress",
          "value": "100.127.22.52"
        },
        {
          "key": "Account3Gpp2ActiveTime",
          "value": "0"
        },
        {
          "key": "Account3Gpp2BadPppFrameCount",
          "value": "0"
        },
        {
          "key": "Account3Gpp2FchFrameSize",
          "value": "0"
        },
        {
          "key": "Account3Gpp2ForwardFchMuxOption",
          "value": "0"
        },
        {
          "key": "Account3Gpp2ForwardFchRc",
          "value": "0"
        },
        {
          "key": "Account3Gpp2ForwardTrafficType",
          "value": "0"
        },
        {
          "key": "Account3Gpp2InboundMobileIpSigBytes",
          "value": "0"
        },
        {
          "key": "Account3Gpp2IpTechnology",
          "value": "0"
        },
        {
          "key": "Account3Gpp2OriginatingSdbByteCount",
          "value": "0"
        },
        {
          "key": "Account3Gpp2OutboundMobileIpSigBytes",
          "value": "0"
        },
        {
          "key": "Account3Gpp2ReverseFchMuxOption",
          "value": "0"
        },
        {
          "key": "Account3Gpp2ReverseFchRc",
          "value": "0"
        },
        {
          "key": "Account3Gpp2ReverseTrafficType",
          "value": "0"
        },
        {
          "key": "Account3Gpp2ServiceOption",
          "value": "595"
        },
        {
          "key": "Account3Gpp2SessionContinue",
          "value": "0"
        },
        {
          "key": "Account3Gpp2TerminatingSdbByteCount",
          "value": "0"
        },
        {
          "key": "AccountInputPackets",
          "value": "185805"
        },
        {
          "key": "AccountOutputPackets",
          "value": "295077"
        },
        {
          "key": "AccountStatusType",
          "value": "Stop"
        },
        {
          "key": "NasIpAddress",
          "value": "175505666"
        },
        {
          "key": "NasPort",
          "value": "558393"
        },
        {
          "key": "Account3Gpp2CompulsoryTunnelIndicator",
          "value": "0"
        },
        {
          "key": "Account3Gpp2HomeAgentIpAddress",
          "value": "66.174.20.198"
        }
      ],
      "extendedAttributes": null,
      "occurredAt": "2015-12-19T01:20:00-05:00"
    }
  ],
  "hasMoreData": false
}

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!