---
title: "Fetch congestion level for a device."
method: POST
path: "/congestion-insights/v0/query"
tags: ["Congestion Insights v1.0.0"]
---

# Fetch congestion level for a device.

`POST /congestion-insights/v0/query`

Fetch historical or predicted congestion level of a device for a given period.

## Headers

- `x-rapidapi-host` string, required

## Request body

- object
  - `device` object, required
    - `phoneNumber` string, nullable — Phone number of the subscription, if any. Optional.
    - `networkAccessIdentifier` string, nullable — Email address-like external identifier of the subscription registered at the operator. If both networkAccessIdentifier and phoneNumber are included, phoneNumber may be dropped and networkAccessIdentifier may be retained.
    - `ipv4Address` object — IPv4 address of the device. IP address is needed for some flow-oriented services, such as QoD.
      - `publicAddress` string, nullable — Public IPv4 address of the device. Either of the device or the NAT the device is behind.
      - `privateAddress` string, nullable — Private IPv4 address of the device, if it is behind a NAT.
      - `publicPort` integer, nullable — Public port used by the device. Port is necessary, as private address ranges overlap, and public port is used to extend the range for CGNAT.
    - `ipv6Address` string, nullable — IPv6 address of the device. IP address is needed for some flow-oriented services, such as QoD.
  - `start` string, date-time, nullable — Start of the period queried. If not set, 15 minutes before end. If neither start or end is set, then the upcoming 15 minutes are predicted.
  - `end` string, date-time, nullable — End of the period queried. If not set, 15 minutes after start.

## Response `200`

- object[]
  - `timeIntervalStart` string, date-time, required
  - `timeIntervalStop` string, date-time, required
  - `congestionLevel` 'Low' | 'Medium' | 'High', required
  - `confidenceLevel` integer, nullable

## Other responses

- `422`

---

[API](https://skmtc.dev/nokia/apis/network-as-code.md) · [All operations](https://skmtc.dev/nokia/apis/network-as-code/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nokia/network-as-code/revisions/fdd5f5a56b88/schema)