DataSession Resource

The SIM DataSession resource returns data session information for a SIM over a period of 30 days or less in an aggregated list.

A data session represents an individual data connectivity session between the SIM-connected device and a service that interfaces between the cellular network and the Internet. This will be a PDP context either via a PDN connection or a Packet Gateway.

You can think of a data session as a representation of your device's Internet connection, whenever such a connection exists.

Data sessions can be used to troubleshoot device issues and understand the network setup and teardown behavior of a device in the wild.

---

DataSession Properties

sid string

The unique string that we created to identify the DataSession resource.

---

sim_sid string

The SID of the Sim resource that the Data Session is for.

---

account_sid SID<AC>

The SID of the Account that created the DataSession resource.

Pattern:^AC[0-9a-fA-F]{32}$

Min length:34

Max length:34

---

radio_link string

The generation of wireless technology that the device was using.

---

operator_mcc string

The 'mobile country code' is the unique ID of the home country where the Data Session took place. See: MCC/MNC lookup.

---

operator_mnc string

The 'mobile network code' is the unique ID specific to the mobile operator network where the Data Session took place.

---

operator_country string

The three letter country code representing where the device's Data Session took place. This is determined by looking up the operator_mcc.

---

operator_name string

The friendly name of the mobile operator network that the SIM-connected device is attached to. This is determined by looking up the operator_mnc.

---

cell_id string

The unique ID of the cellular tower that the device was attached to at the moment when the Data Session was last updated.

---

cell_location_estimate object

An object that describes the estimated location in latitude and longitude where the device's Data Session took place. The location is derived from the cell_id when the Data Session was last updated. See Cell Location Estimate Object.

---

packets_uploaded integer

The number of packets uploaded by the device between the start time and when the Data Session was last updated.

Default:0

---

packets_downloaded integer

The number of packets downloaded by the device between the start time and when the Data Session was last updated.

Default:0

---

last_updated string<date-time>

The date that the resource was last updated, given as GMT in ISO 8601 format.

---

start string<date-time>

The date that the Data Session started, given as GMT in ISO 8601 format.

---

end string<date-time>

The date that the record ended, given as GMT in ISO 8601 format.

---

imei string

The 'international mobile equipment identity' is the unique ID of the device using the SIM to connect. An IMEI is a 15-digit string: 14 digits for the device identifier plus a check digit calculated using the Luhn formula.

---

Cell Location Estimate Object

The Cell location estimate object reports the approximate location of the cellular tower that the device was connected to when the Data Session was last updated. This is based on a lookup of public cellular tower data, and is not necessarily an accurate description of the cellular tower. It is not intended to describe the location of the SIM-connected device itself.

Property	Description	Empty Value
latInteger	Latitude. The spherical coordinate value of the estimated cellular tower location parallel to the Equator.	0
lon Integer	Longitude. The spherical coordinate value of the estimated cellular tower location from the geographical North Pole to the geographical South Pole.	0

Read multiple DataSession resources

List Data Usage records for a sim

GEThttps://programmable-wireless.api.korewireless.com/v1/Sims/{Sid}/DataSessions

Path parameters

Sid*string

The SID of the Sim resource to read the usage from.

Query parameters

Response

200400401403404415422500503

Data Usage List

Headers

Body

application/json

data_sessionsarray of DataSession (object)

metaobject

Request

cURLNodeJsJavaC#PhpPython

curl --location --globoff '{{baseUrl}}/v1/Sims/<string>/DataSessions?PageSize=<integer>&Page=<integer>&PageToken=<string>' \
--header 'Authorization: Bearer <YOUR BEARER TOKEN>'

Response

200400401403404415422500503

{
  "data_sessions": [
    {
      "sid": "text",
      "sim_sid": "text",
      "account_sid": "text",
      "radio_link": "text",
      "operator_mcc": "text",
      "operator_mnc": "text",
      "operator_country": "text",
      "operator_name": "text",
      "cell_id": "text",
      "cell_location_estimate": {
        "lat": 0,
        "lon": 0
      },
      "last_updated": "2024-11-23T14:44:37.461Z",
      "start": "2024-11-23T14:44:37.461Z",
      "end": "2024-11-23T14:44:37.461Z",
      "imei": "text"
    }
  ],
  "meta": {
    "first_page_url": "https://example.com",
    "key": "text",
    "next_page_url": "https://example.com",
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  }
}