Mobile Device (UE) Reports

The following metric and dimension combinations are possible for Mobile Device (UE) reports.

Metrics

• downlink_bandwidth_usage (Bandwidth usage from the customer data network to the UE in Mbits/sec)
• uplink_bandwidth_usage (Bandwidth usage from the UE to the customer data network in Mbits/sec)
• ue_session_duration_seconds
• ue_session_downlink_bytes
• ue_session_downlink_packet
• ue_session_uplink_bytes
• ue_session_uplink_packets
• ue_connections
• ue_online_status

Dimensions

• device (Edge Location: PHI-1, PHI-2, CHI-1)
• enb_ip (Mobile Access Point IP)
• seid (Session ID)
• ue_ip

info

If the above reports are used with device, or enb_ip dimension, in most cases the response will be the data for a single UE within that dimension, not for that dimension as a whole. For instance, a ue_session_downlink_bytes report requesting MAX for a device (the device being an Edge Point) will return the downlink bytes of the top talking UE connected to that Edge Point for each time period (as specified by the step value) during the time window. The exception is where the COUNT aggregator is used, in which case the result will be the total count for all UEs in each time period.

Examples

UE Session Duration in seconds

curl -X 'POST' 'https://api.alefedge.com/reporting/v2/reporting-service/{coreId}' \
  -H 'Authorization: Bearer <JWT TOKEN>' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "start_date_time": "LAST HOUR",
    "end_date_time": "NOW",
    "step": "5m",
    "dimension_filters": [
        {
            "dimension_name": "device",
            "operator": "EXACT",
            "expressions": [
                "PHI-1"
            ]
        },
        {
            "dimension_name": "enb_ip",
            "operator": "EXACT",
            "expressions": [
                "string"
            ]
        }
    ],
    "metrics": {
      "name": "ue_session_duration_seconds",
      "aggregation_type": "COUNT"
    }
  }'

Response

{
  "account_id": "668dbec28474f8e6f9940a67",
  "mobile-core-id": "668dbec28474f8e6f9940a67",
  "metric": "ue_session_duration_seconds",
  "aggregation_type": "COUNT",
  "result": [
    {
      "time_stamp": "2024-08-13T20:43:41+00:00",
      "value": 882896477
    },
    {
      "time_stamp": "2024-08-13T20:48:41+00:00",
      "value": 883022530
    },
    ...
    {
      "time_stamp": "2024-08-13T21:38:41+00:00",
      "value": 884187059
    },
    {
      "time_stamp": "2024-08-13T21:43:41+00:00",
      "value": 884309355
    }
  ]
}

MAX UE downlink usage in bytes

curl -X 'POST' 'https://api.alefedge.com/reporting/v2/reporting-service/668dbec28474f8e6f9940a67' \
  -H 'Authorization: Bearer <JWT TOKEN>' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "start_date_time": "LAST HOUR",
    "end_date_time": "NOW",
    "step": "5m",
    "dimension_filters": [
        {
            "dimension_name": "device",
            "operator": "EXACT",
            "expressions": [
                "PHI-1"
            ]
        },
        {
            "dimension_name": "enb_ip",
            "operator": "EXACT",
            "expressions": [
                "string"
            ]
        }
    ],
    "metrics": {
      "name": "ue_session_downlink_bytes",
      "aggregation_type": "MAX"
    }
  }'

Response

{
  "account_id": "668dbec28474f8e6f9940a67",
  "mobile-core-id": "668dbec28474f8e6f9940a67",
  "metric": "ue_session_downlink_bytes",
  "aggregation_type": "MAX",
  "result": [
    {
      "time_stamp": "2024-08-13T21:08:35+00:00",
      "value": 3323021500
    },
    {
      "time_stamp": "2024-08-13T21:13:35+00:00",
      "value": 3323133556
    },
    ...
    {
      "time_stamp": "2024-08-13T22:03:35+00:00",
      "value": 3361319722
    },
    {
      "time_stamp": "2024-08-13T22:08:35+00:00",
      "value": 3361416874
    }
  ]
}

UE connections

curl -X 'POST' 'https://api.alefedge.com/reporting/v2/reporting-service/668dbec28474f8e6f9940a67' \
  -H 'Authorization: Bearer <JWT TOKEN>' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "start_date_time": "LAST HOUR",
    "end_date_time": "NOW",
    "step": "5m",
    "dimension_filters": [
        {
            "dimension_name": "device",
            "operator": "EXACT",
            "expressions": [
                "PHI-1"
            ]
        },
        {
            "dimension_name": "enb_ip",
            "operator": "EXACT",
            "expressions": [
                "string"
            ]
        }
    ],
    "metrics": {
      "name": "ue_connections",
      "aggregation_type": "COUNT"
    }
  }'

Response

{
  "account_id": "668dbec28474f8e6f9940a67",
  "mobile-core-id": "668dbec28474f8e6f9940a67",
  "metric": "ue_connections",
  "aggregation_type": "COUNT",
  "result": [
    {
      "time_stamp": "2024-08-13T21:10:52+00:00",
      "value": 14
    },
    {
      "time_stamp": "2024-08-13T21:15:52+00:00",
      "value": 14
    },
    ...
    {
      "time_stamp": "2024-08-13T22:05:52+00:00",
      "value": 14
    },
    {
      "time_stamp": "2024-08-13T22:10:52+00:00",
      "value": 14
    }
  ]
}

UE Online status

curl -X 'POST' 'https://api.alefedge.com/reporting/v2/reporting-service/668dbec28474f8e6f9940a67' \
  -H 'Authorization: Bearer <JWT TOKEN>' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "start_date_time": "LAST HOUR",
    "end_date_time": "NOW",
    "step": "5m",
    "dimension_filters": [
      {
        "dimension_name": "device",
        "operator": "EXACT",
        "expressions": [
          "PHI-1"
        ]
      }
    ],
    "metrics": {
      "name": "ue_online_status",
      "aggregation_type": "EXISTS"
    }
  }'

Result

{
  "account_id": "668dbec28474f8e6f9940a67",
  "mobile-core-id": "668dbec28474f8e6f9940a67",
  "metric": "ue_online_status",
  "aggregation_type": "EXISTS",
  "edgepoint": "PHI-1",
  "result": [
    {
      "time_stamp": "2024-08-13T21:13:07+00:00",
      "value": 1,
      "instances": {
        "ue_ip": "192.168.100.11"
      }
    },
    {
      "time_stamp": "2024-08-13T21:18:07+00:00",
      "value": 1,
      "instances": {
        "ue_ip": "192.168.100.11"
      }
    },
    ...    
    {
      "time_stamp": "2024-08-13T22:08:07+00:00",
      "value": 1,
      "instances": {
        "ue_ip": "192.168.100.65"
      }
    },
    {
      "time_stamp": "2024-08-13T22:13:07+00:00",
      "value": 1,
      "instances": {
        "ue_ip": "192.168.100.65"
      }
    }
  ]
}