Collection of Converted

REST APIs
Contents
1. Dashboard...................................................................................................2
1 Dashboard Summary..............................................................................3
2 Tunnel Performance Metrics...................................................................4
3 Site Information Map..............................................................................5
4 Insights Summary (NHS/NQES Scores)...................................................6
5 Time Series Forecast..............................................................................7
6 Tunnel MOS/CODEC Metrics....................................................................7
7 Interface TopN MOS................................................................................8
2. Sites..........................................................................................................9
3. Devices...................................................................................................22
1. Device List per Site.............................................................................22
2. Device List (No Site Filter)......................................................................24
3. Device List by Vendor Name...................................................................26
Device List by Device Name.......................................................................27
5. Device Top 25 Utilization........................................................................29
6. Device Performance...............................................................................29
7. Site Availability.......................................................................................32
4. Interfaces...............................................................................................32
1. Interface List per Site.............................................................................32
2. Interface Details per Interface................................................................34
3. Interface Performance History................................................................35
Interface Performance History – All Data....................................................36
5. Insights...................................................................................................37
1. Time Series Forecast..............................................................................37
2. Anomaly Detection.................................................................................38
3. Anomaly Summary by Metric.................................................................39
Total Anomaly Summary.............................................................................40
5. Anomaly Counts For Device....................................................................41
6. Fixed Wireless Access (FWA) Insights.....................................................42
 7. FWA Historical Bandwidth Usage by Carrier...........................................43
6. Tunnels.......................................................................................................45
1. Tunnel Details.........................................................................................45
2. Tunnel Detail by Tunnel Name................................................................46
3. Tunnel Performance History....................................................................47
Tunnel Codec..............................................................................................48
5. Tunnel MOS (Mean Opinion Score)..........................................................49
6. Tunnel Utilization....................................................................................50
7. Tunnel Score Trend..................................................................................51
7. FWA........................................................................................................52
1. Interfaces...................................................................................................52
1.1 Top Interfaces Data (In/Out & Uplink/Downlink)................................52
1.2 Interface Details................................................................................53
1.3 Wireless Interface Performance.........................................................54
2. Wireless Sites.........................................................................................55
2.1 Wireless Site Performance.................................................................55
2.2 Wireless Site Map..............................................................................56
2.3 Wireless Site List...............................................................................57
2.4 Site Reports.......................................................................................58
2.5 Device List Per Site............................................................................58
2.6 Site Active Services...........................................................................59
3. Wireless Devices.....................................................................................60
3.1. Wireless Devices List........................................................................60
3.2 Wireless Devices Utilization...............................................................61
3.3 Wireless Devices Daily Speed Test....................................................62
3.4 Wireless Device Performance............................................................63
Insights.......................................................................................................64
1. FWA Insights Devices..........................................................................64
2 FWA NQES Score History......................................................................64
3 FWA Anomaly Detection.......................................................................65
Top N Devices Daily Speed Test Insights..................................................66
 5. Top/Bottom MDN Metrics.....................................................................66
5. Dashboard..............................................................................................67
5.1. Dashboard Summary........................................................................67
8. Combined View.......................................................................................68
1. Devices......................................................................................................68
1.1 Combined Devices List......................................................................68
1.2 Combined Devices Utilization............................................................70
1.3 Device Performance Metrics..............................................................71
2. Combined Sites.......................................................................................72
2.1 Combined Site List............................................................................72
2.2 Combined Device List Per Site (Wireline)..........................................73
2.3 Combined Device List Per Site (Wireless)..........................................74
2.4 Combined Site Active Services per Site.............................................76
2.5 Combined Site Performance History..................................................77
2.6 Combined Site Performance Interface TopN All.................................77
3. Dashboard..............................................................................................78
3.1 Combined Dashboard........................................................................78
3.2 Combined SiteMap............................................................................80
1. Dashboard
1 Dashboard Summary
Endpoint: POST performance/v5/dashboard/summary

TMF Standard: TMF628

Description: Aggregates ticket, site, device, SIM, and service-type
summaries.

JSON Payload
Parameter Type Required Description
cleId string Yes Customer Location Entity ID
ban array Yes Billing Account Numbers

Headers
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Request Body:

{
"cleId": "CLE-45678",
"ban": ["BAN123456", "BAN6543”],
}

Example Response
{
"ticketSummary": {
"totalCount": 42,
"summaryByStatus": {
"critical": 5,
"high": 10
}
},
"siteSummary": {
"totalCount": 15,
"summaryByStatus": {
"UP": 12,
"DOWN": 3
}
},
 "deviceSummary": {
"totalCount": 200,
"summaryByStatus": {
"ACTIVE": 180,
"INACTIVE": 20
}
},
"simByCountSummary": {
"totalCount": 150,
"summaryByStatus": {
"ACTIVE": 120,
"INACTIVE": 30
}
},
"verizonFwaSiteSummary": {
"totalCount": 25,
"summaryByStatus": {
"UP": 20,
"DOWN": 5
}
},
"cradlepointDeviceSummary": {
"totalCount": 50,
"summaryByStatus": {
"ONLINE": 45,
"OFFLINE": 5
}
}
}

2 Tunnel Performance Metrics

Endpoint: POST performance/v5/dashboard/tunnels

TMF Standard: TMF628

Description: Retrieves top tunnel metrics (jitter, latency, utilization).

JSON Payload
Parameter Type Required Description
cleId string Yes Customer Location Entity ID
ban array Yes Billing Account Numbers
limit integer Optional Max number of records to return (default:
250)
offset integer Optional Records to skip for pagination (default: 0)

Headers
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication
Example Response
{
"totalCount": 12
"tunnels": [
{
"jitter": 2.1,
"latency": 45,
"utilization": 78.5,
"packetLoss": 0.5
},
]
}

3 Site Information Map

Endpoint: POST performance/v5/dashboard/interfaces

TMF Standard: TMF628

Description: Fetches bandwidth metrics for interfaces.

JSON Payload
Parameter Type Required Description
cleId string Yes Customer Location Entity ID
ban array Yes Billing Account Numbers
siteId string Yes Filter by site ID.
flowType string Optional Filter by flow type (e.g., wireless)

Headers
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response
{
"totalCount": 12,
"interfaces": [
{
"bandwidth_in": 1000,
"bandwidth_out": 500
}
]
}
4 Insights Summary (NHS/NQES Scores)
Endpoint: POST performance/v5/dashboard/insights

TMF Standard: TMF628

Description: Returns NHS (Network Health Score) and NQES (Network
Quality Experience Score).

JSON Payload
Parameter Type Required Description
cleId string Yes Customer Location Entity ID
ban array Yes Billing Account Numbers

Headers
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response
{
"totalcount": 12,
"nhsSummary": {
"score": 85,
"summaryByScore": {"EXCELLENT": 70, "GOOD": 15},
"scoreHistory": [
{"timestamp": 1724106003, "score": 82},
{"timestamp": 1724192403, "score": 84},
{"timestamp": 1724278803, "score": 85}
]
},
"nqesSummary": {
"score": 90,
"summaryByScore": {"EXCELLENT": 80, "GOOD": 10},
"scoreHistory": [
{"timestamp": 1724106003, "score": 82},
{"timestamp": 1724192403, "score": 84},
{"timestamp": 1724278803, "score": 85}
]
}
}
5 Time Series Forecast
Endpoint: POST performance/v5/dashboard/timeseries

TMF Standard: TMF628

Description: Provides time-series data for predictive analytics.

JSON Payload
Parameter Type Required Description
cleId string Yes Customer Location Entity ID
ban array Yes Billing Account Numbers

Headers
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response
{
"totalCount": 2,
"timeSeriesForecast": [
{
"interfaceName": "eth0",
"series": [
{
"name": "latency",
"data": [10, 12, 15]
}
}
]
}

6 Tunnel MOS/CODEC Metrics

Endpoint: POST performance/v5/dashboard/tunnels/qos

TMF Standard: TMF628

Description: Retrieves MOS (Mean Opinion Score) and CODEC data for
tunnels.

JSON Payload
 Parameter Type Required Description
cleId string Yes Customer Location Entity ID
ban array Yes Billing Account Numbers
startDate integer Yes ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)
endDate integer Yes ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)
Headers
Header Required Value/Type Description
JWT Yes string (secure) Bearer JWT Token for authentication
Token

Example Response
{
"totalCount": 1,
"tunnels": [
{
"tunnelMosScore": 2,
"codec": "G.711",
}
]
}

7 Interface TopN MOS

Endpoint: POST performance/v5/dashboard/interfaces/qos

TMF Standard: TMF628

Description: Retrieves MOS (Mean Opinion Score) for interfaces.

JSON Payload
Parameter Type Required Description
cleId string Yes Customer Location Entity ID
ban array Yes Billing Account Numbers
startDate integer Yes ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)
endDate integer Yes ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)
Headers
Header Required Value/Type Description
JWT Yes string (secure) Bearer JWT Token for authentication
Token

Example Response
{
"totalCount": 2,
"interfaces": [
{
"interfaceName": "eth0",
"interfaceMosScore": 2,
},
{
"interfaceName": "wlan1",
"interfaceMosScore": 3.8,
}
]
}

2. Sites
1 Site Performance – Interface TopN All
TMF Standard: TMF628

Endpoint: POST /performance/v5/site/interface/top

Description: Retrieves the top-performing or underperforming network

interfaces at the site level.

JSON Payload
Parameter Type Required Description
cleId string Yes Customer Logical Entity ID
ban array Yes Billing Account Numbers
limit integer Optional Number of results to return (default: 25)
offset integer Optional Number of records to skip for pagination
siteName string Optional Filter results to a specific site

Headers
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Request Body

{
"cleId": "4732445",
"ban": ["U0260318"],
"limit": 10,
 "offset": 0,
"siteName": "89596897C 00347-Z"
}

Example Response
{
"totalCount": 12,
"siteInterfaces": [
{
"bandwidth_in": 125.5,
"bandwidth_out": 132.1,
"euxScore": 78,
},
]
}

2 Site Information Map

TMF Standard: TMF639

Endpoint: POST /resource/v4/site/map

Description: This endpoint retrieves a geospatially enriched list of network

sites, including coordinates, identifiers, and optional metadata.

JSON Payload
Parameter Type Required Description
cleId string Yes Customer Logical Entity ID
ban array Yes Billing Account Numbers
networkType array Optional Filter by supported network types
health array Optional Filter by health status categories
applicationNa string Optional Application name filter
me

Headers
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response
{
"totalCount": 12,
"sites": [
{
"id": "SITE123",
"name": "Downtown Hub",
 "health": "good",
"deviceCount": 14,
"nodeCount": 7,
"networkType": ["4G LTE", "5G"],
"servicesEnabled": ["VoLTE", "Data"],
"applicationName": "AppX",
"address": {
"address": "123 Market St",
"state": "CA",
"longitude": -122.4194,
"latitude": 37.7749,
"provider": "Verizon",
"country": "USA"
},
"sdwanHealthScore": 89,
"networkHealthScoreCategory": "excellent",
"site_type": "Edge",
"ticketSummary": {
"critical": 1,
"high": 3,
"medium": 5,
"low": 2
}
},
]
}

3 Site Information Map – Search by siteName

TMF Standard: TMF639

Endpoint: POST /resource/v4/site/map

Description: This endpoint allows precise filtering of the site map data using
a partial or complete site name.

JSON Payload
Parameter Type Required Description
cleId string Yes Customer Logical Entity ID
ban array Yes Billing Account Numbers
siteName string Yes Full or partial name of the site to search
networkType array Optional Filter by supported network types
health array Optional Filter by health status categories
applicationNa string Optional Application name filter
me

Headers
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response
{
"totalCount": 12,
"sites": [
{
"id": "CENTRAL001",
"name": "Central Tower 1",
"health": "good",
"deviceCount": 12,
"nodeCount": 4,
"networkType": "5G",
"applicationName": "AppX",
"servicesEnabled": ["internet", "voice"],
"address": {
"address": "123 Tower St",
"state": "CA",
"longitude": 73.0479,
"latitude": 33.6844,
"provider": "Verizon",
"country": "USA"
},
"ticketSummary": {
"critical": 0,
"high": 2,
"medium": 1,
"low": 5
}
}
]
}

4 Site Information Map – SiteName Filter

TMF Standard: TMF639

Endpoint: POST /resource/v4/site/map

Description: This endpoint provides advanced filtering capability specifically

focused on siteName.

JSON Payload
Parameter Type Required Description
cleId string Yes Customer Logical Entity ID
ban array Yes Billing Account Numbers
siteName string Yes Name or partial name of site to filter
networkType array Optional Filter by supported network types
health array Optional Filter by health status categories
 limit integer Optional Max number of records to return (default: 25)
offset integer Optional Records to skip for pagination (default: 0)
applicationNa string Optional Application name filter
me

Headers
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response
{
"totalCount": 12,
"filteredSites": [
{
"id": "100753719C",
"name": "02849-S",
"health": "excellent",
"deviceCount": 8,
"nodeCount": 2,
"networkType": "4G LTE",
"applicationName": "AppX",
"servicesEnabled": ["internet", "voice"],
"address": {
"address": "456 Example Blvd",
"state": "TX",
"longitude": -70059,
"latitude": 40.7138,
"provider": "Verizon",
"country": "USA"
},
"sdwanHealthScore": 98,
"networkHealthScoreCategory": "excellent",
"ticketSummary": {
"critical": 0,
"high": 0,
"medium": 1,
"low": 3
}
}
]
}

5 Show Site Inventory

TMF Standard: TMF639

Endpoint: POST /resource/v4/site/{siteId}

Description: Retrieves a list of all network sites available to the tenant with
filtering and pagination.

JSON Payload
Parameter Type Required Sortable Description
cleId string Optional - Customer Logical Entity ID
ban array Optional - Billing Account Numbers
siteName array Optional Yes Full or partial name of the site to
search
siteType string Optional Yes Site type filter for NaaS sites
limit integer Optional - Number of records to return (default:
25)
offset integer Optional - Records to skip for pagination (default:
0)
applicationN string Optional Yes Application name filter
ame

Headers
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for
authentication

Example Response
{
"totalCount": 2,
"sites": [
{
"site_name": "North Core A",
"addressDetail": {
"address": "123 Main St",
"latitude": 40.7128,
"longitude": -70060,
"provider": "Verizon",
"state": "NY",
"country": "USA"
},
"location_code": "LOC001",
"dns_shortname": "12345abc",
"naas_site_type": "HA",
"device_count": "3",
"circuit_count": "2",
"applicationName": "AppX",
"ticketSummary": {
"critical": 1,
"high": 2,
 "medium": 3,
"low": 4
},
}
]
}

6 Site Inventory – Filter by SiteNames

TMF Standard: TMF639

Endpoint: POST /resource/v4/site/filter

Description: This endpoint allows users to fetch site inventory records by

supplying one or more specific siteName values.

JSON Payload
Parameter Type Required Description
cleId string Yes Customer Logical Entity ID
ban array Yes Billing Account Numbers
siteName array Yes List of site names to include (can be
comma-separated)
limit integer Optional Number of results to return (default:
25)
offset integer Optional Records to skip for pagination
applicationNa string Optional Application name filter
me

Headers
Header Required Value/Type Description
JWT Yes string (secure) Bearer JWT Token for authentication
Token

Example Response
{
"totalCount": 1,
"sites": [
{
"site_name": "Central-Hub",
"addressDetail": {
"address": "789 Innovation Way",
"latitude": 37.7749,
"longitude": -122.4194,
"provider": "Verizon",
 "state": "CA",
"country": "USA"
},
"location_code": "CENTRAL-HUB-001",
"ticketSummary": {
"critical": 0,
"high": 1,
"medium": 2,
"low": 4
},
"bandwidth_in": 320.75,
"bandwidth_out": 298.50,
"fwa_bandwidth_in": 150.25,
"fwa_bandwidth_out": 142.30,
"applicationName": "AppX",
}
]
}

7 Show Site Inventory – Per Site

TMF Standard: TMF639

Endpoint: POST /resource/v4/site/{siteId}

Description: This endpoint retrieves detailed inventory information for a

specific site, identified by its unique siteId.

JSON Payload
Parameter Type Required Description
cleId string Yes Customer Logical Entity ID
ban array Yes Billing Account Numbers
limit integer Optional Number of results to return (default: 25)
offset integer Optional Records to skip for pagination
applicationNam string Optional Application name filter
e

Headers
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response
{
"totalCount": 1,
"sites": [
 {
"site_name": "Main West Hub",
"address": "101 Tech Valley Blvd",
"location_code": "SITE001",
"service_id": "SRV-9001",
"ticketSummary": {
"critical": 1,
"high": 0,
"medium": 2,
"low": 3
},
"bandwidth_in": 512.45,
"bandwidth_out": 478.12,
"fwa_bandwidth_in": 240.30,
"fwa_bandwidth_out": 231.85,
"applicationName": "AppX",
}
]
}

8 Site Performance History

TMF Standard: TMF628

Endpoint: POST /performance/v5/site

Description: This endpoint provides historical performance metrics for a

specific site over a defined time range.

JSON Payload
Parameter Type Required Sortable Description
cleId string Optional - Customer Logical Entity ID
ban array Optional - Billing Account Numbers
siteName string Optional Yes Unique identifier of the site
startDate String Optional Yes ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)
endDate String Optional Yes ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)
interval string Optional - Time bucket size: hourly, daily, weekly
(default: daily)
limit integer Optional - Number of results to return (default: 25)
offset integer Optional - Records to skip for pagination (default:
0)

Headers
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication
Example Response
{
"sites": [
{
"site_name": "North_Core A",
"bandwidth_in": 520.50,
"timestamp": "xxxx",
"bandwidth_out": 498.00,
"fwa_bandwidth_in": 250.75,
"fwa_bandwidth_out": 240.60,
"packetLoss": 0.15,
"siteAvailability": 99.95,
"reachability": 98.60,
"sdwanHealthScore": 92,
"wirelessHealthScore": 92,

"euxScore": 78,
}
]
}

9 Site Active Services per Site

TMF Standard: TMF639

Endpoint: POST /resource/v4/site/services

Description: Returns a list of active services provisioned or running at a

given site.

JSON Payload
Parameter Type Require Sortabl Description
d e
cleId string Optional - Customer Logical Entity ID
ban array Optional - Billing Account Numbers
siteName string Optional Yes Site identifier to return active services
circuitType string Optional - Filter by Primary vs Backup circuits
accessType string Optional Yes Filter based on access network types
serviceType string Optional Yes Filter by specific service category
limit integer Optional - Number of results to return (default: 25)
offset integer Optional - Records to skip for pagination (default: 0)

Headers
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication
Example Response
{
"totalCount": 12,
"siteActiveServices": [
{
"circuit_id": "CIRCUIT-001",
"circuit_type": "Internet",
"speed": "1 Gbps",
"provider": "Verizon",
"accessType": "Fiber",
}
]
}

10 Site Map Non-Essential Details

TMF Standard: TMF639

Endpoint: POST /resource/v4/site/map/details

Description: Returns auxiliary or non-core metadata associated with sites

for use in enrichment layers or advanced mapping views.

JSON Payload
Parameter Type Required Description
cleId string Yes Customer Logical Entity ID
ban array Yes Billing Account Numbers
siteType array Optional Filter by site type (e.g., XS)
networkHealthSc array Optional Filter by health score category
ore
availability array Optional Filter by availability flags (e.g., Y)
applicationName string Optional Application name filter

Headers
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response
{
"totalCount": 12,
"siteMapDetails": [
{
"name": "Urban Edge 5G",
"nodeCount": 12,
"servicesEnabled": ["Internet", "VoIP"],
 "address": {
"provider": "Nokia"
},
"ticketSummary": {
"critical": 1,
"high": 2,
"medium": 3,
"low": 0
},
"site_type": "XS",
"sdwanHealthScore": 92,
"networkHealthScoreCategory": "EXCELLENT",
"siteAvailability": "Y",
"siteSla": "99.99%",
"applicationName": "AppX",
}
]
}

11 Site Performance – Tunnel TopN All

TMF Standard: TMF628

Endpoint: POST /performance/v5/site/tunnel/topn

Description: Retrieves the top N performing or underperforming tunnels

grouped by site.

JSON Payload
Parameter Type Required Description
cleId string Yes Customer Logical Entity ID
ban array Yes Billing Account Numbers
siteName string Yes Site name to filter tunnels by
limit integer Optional Max number of tunnel records to return (default: 10)
offset integer Optional Records to skip for pagination

Headers
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response
{
"totalCount": 12,
"tunnels": [
{
"latency": 85.4,
 "jitter": 2,
"packetLoss": 0.9,
"utilization": 68.5,
"euxScore": 78,
}
]
}

12 Site Performance
TMF Standard: TMF628

Endpoint: POST /performance/v5/site/performance

Description: Retrieves the performance of sites.

JSON Payload
Parameter Type Required Description
cleId string Yes Customer Logical Entity ID
ban array Yes Billing Account Numbers
limit integer Optional Max number of sites records to return (default: 25)
offset integer Optional Records to skip for pagination (default: 0)

Headers
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response
{
"totalCount": 25,
"sites": [
{
"site_name": "North Core A",
"performance": {
"bandwidth_in": 125.5,
"bandwidth_out": 130.0,
"fwa_bandwidth_in": 50.0,
"fwa_bandwidth_out": 45.5,
"sdwanHealthScore": 90,
"networkHealthScoreCategory": "excellent",
"reachability": "reachable",
"siteAvailability": "available",
"applicationName": "AppX",
"siteSla": "sla_met",
"site_type": "Core",
"wirelessHealthScore": 85,
 "wirelessHealthScoreCategory": "good"
}
}
]
}

3. Devices
1. Device List per Site
Endpoint: POST /resource/v4/device
Description: Retrieve devices filtered by site name.

JSON Payload
Parameter Type Required Sortable Description
cleId string Optional - Customer Location Entity ID
ban array Optional - Billing Account Numbers
siteName string Optional Yes Site identifier to filter devices
deviceName string Optional Yes Deviceidentifier to filter
hostname string Optional Yes Filter devices by hostname
limit integer Optional - Number of records per page (default:
25)
offset integer Optional - Number of records to skip (default: 0)
fwVersion string Optional - Filter devices by firmware version
swVersion string Optional - Filter devices by software version
vendor string Optional Yes Filter devices by vendor
model string Optional - Filter by hardware model name or
identifier
type string Optional Yes Filter by device type (e.g., Router,
Gateway)

Headers:

Header Required Value/Type Description

JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Request Body:

{
"cleId": "CLE-45678",
"ban": ["BAN123456", "BAN654321"],
"siteName": "88612919C 00001-2",
"limit": 10,
 "offset": 0,
"fwVersion": "7.1",
"swVersion": "3.2",
"vendor": "cradlepoint":,
"model": "IBR900",
"type": "FWA Router",
"flowType": "wireless",
"slaFilter": "YES",
"carrier_name": "Verizon Wireless",
"deviceNetworkType": "5G"
}

Example Response:
{
"totalCount": 12,
"devices": [
{
"deviceName": "wbansp1-00647z-32076791e016",
"vendorName": "CRADLEPOINT",
"siteName": "88612919C 00001-2",
"bandwidth_in": 2560,
"bandwidth_out": 2048,
"reachability": "UP",
"managementState": "ACTIVE",
"dnsHostName": "cradle01",
"dnsEntityName": "Entity-123",
"securityInstanceId": "sec-1456",
"securityTenantId": "tenant-789",
"management_ip": "192.168.1.45",
"fwVersion": "7.1",
"swVersion": "3.2",
"model": "IBR900",
"type": "FWA Router",
"carrier_name": "Verizon Wireless",
"deviceImei": "357862092811223",
"iccID": "89148000005843700045",
"mdn": "8005550100",
"deviceNetworkType": "5G",
"ticketSummary": {
"critical": 2,
"high": 1,
"medium": 3,
"low": 0
}
}
]
}
Notes:

 We can optionally document that many of these fields (like fwVersion,

ticketSummary, deviceImei, etc.) can be grouped under
resourceCharacteristic if strictly adhering to TMF639's object structure.
 Fields like ticketSummary or carrier_name may not be part of core
TMF639 but are highly relevant for telecom deployments and can be
documented as extensions.

2. Device List (No Site Filter)

Endpoint: POST /resource/v4/device
Description: Retrieve all devices across sites using free text search.

JSON Payload:
Parameter Type Required Description
cleId string Yes Customer Location Entity ID
ban array Yes Billing Account Numbers
searchType string Optional Keyword for device name, model, etc.
limit integer Optional Records per page
offset integer Optional Records to skip
fwVersion string Optional Filter devices by firmware version
swVersion string Optional Filter devices by software version
model string Optional Filter by hardware model name or identifier
type string Optional Filter by device type (e.g., Router, Gateway)
flowType string Optional Filter by network flow type (e.g., wireless,
wireline)
slaFilter string Optional Filter devices with SLA compliance (e.g., YES/NO)
carrier_nam string Optional Filter by carrier or network operator name
e
deviceNetw string Optional Filter by network type such as LTE, 5G, etc.
orkType

Headers:

Header Required Value/Type Description

JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 100,
"devices": [
 {
"deviceName": "wbansp1-00647z-32076791e016",
"vendorName": "CRADLEPOINT TECHNOLOGY",
"bandwidth_in": 1850,
"bandwidth_out": 1240,
"reachability": "UP",
"managementState": "ACTIVE",
"dnsHostName": "cradle01",
"dnsEntityName": "Entity-123",
"securityInstanceId": "sec-1456",
"securityTenantId": "tenant-789",
"management_ip": "10.10.5.25",
"fwVersion": "7.3.0",
"swVersion": "1.2",
"model": "IBR1700",
"type": "Router",
"carrier_name": "Verizon Wireless",
"deviceNetworkType": "LTE",
"sdwanHealthScore": "EXCELLENT",
"sdwanHealthScoreCategory": "GOOD",
"wirelessHealthScore": "GOOD",
"wirelessHealthScoreCategory": "MODERATE",
"deviceAvailability": 99.1,
"ticketSummary": {
"critical": 1,
"high": 0,
"medium": 2,
"low": 1
}
}
]
}

3. Device List by Vendor Name

Endpoint: POST /resource/v4/device
Description: Retrieve devices filtered by vendor name.

JSON Payload:
Parameter Type Required Description
cleId string Yes Customer Location Entity ID
ban array Yes Billing Account Numbers
vendorName string Yes Vendor or OEM name
limit integer Optional Records per page
offset integer Optional Records to skip
fwVersion string Optional Filter devices by firmware version
swVersion string Optional Filter devices by software version
model string Optional Filter by hardware model name or identifier
type string Optional Filter by device type (e.g., Router, Gateway)
flowType string Optional Filter by network flow type (e.g., wireless,
wireline)
slaFilter string Optional Filter devices with SLA compliance (e.g., YES/NO)
carrier_name string Optional Filter by carrier or network operator name
deviceNetwor string Optional Filter by network type such as LTE, 5G, etc.
kType

Headers:

Header Required Value/Type Description

JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 18,
"devices": [
{
"deviceName": "wbansp1-99999x-32076661e098",
"vendorName": "CRADLEPOINT TECHNOLOGY",
"dnsHostName": "cradle02",
"dnsEntityName": "Entity-456",
"bandwidth_in": 1100,
"bandwidth_out": 600,
"reachability": "UP",
"management_ip": "10.5.9.15",
"fwVersion": "7.5.2",
"swVersion": "2.1",
"model": "IBR600",
"type": "CPE",
"carrier_name": "AT&T",
"ticketSummary": {
"critical": 0,
"high": 1,
"medium": 0,
"low": 0
}
}
]
}
Device List by Device Name
Endpoint: POST /resource/v4/device
Description: Retrieve a specific device using device name.

JSON Payload:
Parameter Type Required Description
cleId string Yes Customer Location Entity ID
ban array Yes Billing Account Numbers
deviceNam string Yes Exact device name
e
limit integer Optional Records per page
offset integer Optional Records to skip
fwVersion string Optional Filter devices by firmware version
swVersion string Optional Filter devices by software version
model string Optional Filter by hardware model name or identifier
type string Optional Filter by device type (e.g., Router, Gateway)
flowType string Optional Filter by network flow type (e.g., wireless, wireline)
slaFilter string Optional Filter devices with SLA compliance (e.g., YES/NO)
carrier_na string Optional Filter by carrier or network operator name
me
deviceNetw string Optional Filter by network type such as LTE, 5G, etc.
orkType

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 1,
"devices": [
{
"deviceName": "wbansp1-00647z-32076791e016",
"vendorName": "CRADLEPOINT TECHNOLOGY",
"dnsHostName": "dev01",
"dnsEntityName": "Entity-789",
"management_ip": "172.16.2.21",
"fwVersion": "7.6.1",
"swVersion": "0",
"model": "IBR900",
"type": "Edge Router",
"carrier_name": "Verizon Wireless",
"bandwidth_in": 1024,
 "bandwidth_out": 640,
"reachability": "DOWN",
"managementState": "INACTIVE",
"deviceImei": "357862092811223",
"iccID": "89148000005843700045",
"mdn": "8005550100",
"deviceNetworkType": "5G",
"ticketSummary": {
"critical": 0,
"high": 2,
"medium": 1,
"low": 0
}
}
]
}

5. Device Top 25 Utilization

Endpoint: POST /resource/v4/device/utilization
Description: Fetch top N devices by utilization metrics.

JSON Payload:
Parameter Type Required Description
cleId string Yes Customer Location Entity ID
ban array Yes Billing Account Numbers
sortField string Optional One of cpuUtilization, memoryUtilization,
diskUtilization
isAsc boolean Optional Sort in ascending order if true; descending if
false
limit integer Optional Records per page (default: 25)
offset integer Optional Records to skip
model string Optional Filter by hardware model name or identifier
fwVersion string Optional Filter devices by firmware version
type string Optional Filter by device type (e.g., Router, Gateway)

Headers:

Header Required Value/Type Description

JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"devices": [
 {
"deviceName": "wbansp2-77777z-32070101e045",
"cpuUtilization": 82.4,
"memoryUtilization": 68.2,
"diskUtilization": 43
}
]
}

6. Device Performance
Endpoint: POST /performance/v4/device
Description: Fetch health and performance metrics over a time period.

JSON Payload:

Parameter Type Required Sortable Description

cleId string Optional - Customer Location Entity ID

ban array Optional - Billing Account Numbers

deviceNam string Optional Yes Exact device name

e

siteName string Optional Yes Site identifier to filter devices

ISO 8601 format (e.g. 2025-06-
startDate integer Yes - 04T00:00:00Z)
ISO 8601 format (e.g. 2025-06-
endDate integer Yes - 04T00:00:00Z)

interval string Optional - Time bucket size: hourly, daily, weekly

(default: daily)

limit integer Optional - Number of records to return (default: 25)

offset integer Optional - Records to skip for pagination (default: 0)

cpuUtilizati integer Optional Yes

on

memoryUtil integer Optional Yes

ization

diskUtilizati integer Optional Yes

on

sessionLoa integer Optional Yes

d
bandwidthI integer Optional Yes
n

bandwidth integer Optional Yes

Out

fwaBandidt integer Optional Yes

hIn

fwaBandwi integer Optional Yes

dthOut

packetLoss integer Optional Yes

availability integer Optional Yes

reachability integer Optional Yes

sdwanHealt integer Optional Yes

hScore

wireless integer Optional Yes

HealthScor
e

euxScore integer Optional Yes

Headers:

Header Required Value/Type Description

JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 12,
"devices": [
{
"deviceName": "wbansp2-012291-32313829e007",
“siteName”: “North Core A",
“Time”: [
{
“timestamp”” “xxxx”
"cpuUtilization": 82.4,
"memoryUtilization": 68.2,
"diskUtilization": 43
“sessionLoad”: 1234
"bandwidth_in": 520.50,
"bandwidth_out": 498.00,
"fwa_bandwidth_in": 250.75,
 "fwa_bandwidth_out": 240.60,
"pduPpacketLoss": 0.15,
"availability": 99.95,
"reachability": 98.60,
"sdwanHealthScore": 92,
"wirelessHealthScore": 92,
"euxScore": 78,
}
]
}
]
}
"deviceName": "wbansp2-012291-32313829e007",
"deviceAvailability": 97.8,
"sdwanHealthScore": "GOOD",
"wirelessHealthScore": "EXCELLENT"
}

7. Site Availability
Endpoint: POST /resource/v4/device/siteAvailability
Description: Returns device uptime, availability %, and reachability across
sites.

JSON Payload:

Parameter Type Required Description

cleId string Yes Customer Location Entity ID
ban array Yes Billing Account Numbers
siteName string Optional Site identifier to filter devices

Headers:

Header Required Value/Type Description

JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 85,
"percentage": 97.3,
"summaryByStatus": {
"UP": 76,
"DOWN": 9
}
}
4. Interfaces
1. Interface List per Site
Endpoint: POST /resource/v4/interface
Description: Fetch device interface details for diagnostics and analytics.

JSON Payload:
Parameter Type Required Description
cleId string Yes Customer Logical Entity ID
ban array Yes Billing Account Numbers
deviceName string Yes Parent device name to fetch interfaces for
limit integer Optional Max number of records to return (default: 25)
offset integer Optional Records to skip for pagination (default: 0)

Headers:

Header Required Value/Type Description

JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Request Body

{
"cleId": "478454",
"ban": ["X000305962"],
"deviceName": "wbansp2-011371-32313797e008",
"limit": 10,
"offset": 0
}

Example Response:
{
"totalCount": 2,
"interfaces": [
{
"name": "eth0",
"device_name": "wbansp2-011371-32313797e008",
"speed": "1000Mbps",
"ipv4": "192.168.1.100",
"mode": "Auto",
"bandwidth_in": 2048,
"bandwidth_out": 1024,
 "type": "Ethernet",
"carrier_name": "Verizon Wireless",
"mac": "00:1A:2B:3C:4D:5E",
"apn": "vzwinternet",
"uptime": "43784",
"connection_type": "LTE"
}
]
}

2. Interface Details per Interface

Endpoint: POST /resource/v4/interface/detail

Description: Retrieve network interface data for diagnostics and SLA.

JSON Payload:
Parameter Type Required Description
cleId string Yes Customer Logical Entity ID
ban array Yes Billing Account Numbers
deviceName string Yes Parent device name to fetch interfaces for
interfaceNam string Yes Name of the specific interface (e.g., vni-
e 0/1.0)
limit integer Optional Max number of records to return (default: 25)
offset integer Optional Records to skip for pagination (default: 0)

Headers:

Header Required Value/Type Description

JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 1,
"interfaces": [
{
"name": "vni-0/1.0",
"device_name": "wbasp2-04810s-32092641e023",
"speed": "1000Mbps",
"ipv4": "192.168.2.10",
"mode": "Static",
"bandwidth_in": 4096,
"bandwidth_out": 2048,
"type": "Ethernet",
"carrier_name": "AT&T",
 "mac": "00:1C:2D:3E:4F:60",
"apn": "iot.att.net",
"uptime": "86400",
"connection_type": "5G",
"sdwanHealthScore": 91
}
]
}

3. Interface Performance History

Endpoint: POST /resource/v4/interface/performance/history

Description: Fetch interface RF metrics for performance and SLA.

JSON Payload:
Parameter Type Required Description
cleId string Yes Customer Logical Entity ID
ban array Yes Billing Account Numbers
deviceName string Yes Parent device name to fetch interfaces for
interfaceNa string Yes Name of the specific interface (e.g., vni-
me 0/1.0)
startDate String Optional ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)
endDate String Optional ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)
bucket integer Optional Aggregation window in seconds (e.g., 86400)

Headers:

Header Required Value/Type Description

JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 1,
"performanceHistory": [
{
"name": "vni-0/0.0",
"carrier_name": "Verizon",
"device_name": "wbasp1-00259s-32163253e011",
"ipv4": "192.168.10.20",
"ipv6": "fe80::a00:27ff:fe4e:66a1",
"mac": "00:1B:44:11:3A:B7",
 "type": "5G Interface",
"bandwidth_in": 6144,
"bandwidth_out": 2048,
"fwa_rsrp": -85,
"fwa_rsrq": -12,
"fwa_sinr": 18,
"vz_rsrp": -90,
"vz_rsrq": -10,
"vz_sinr": 22,
"sdwanHealthScore": 87
}
]
}

Interface Performance History – All Data

Endpoint: POST /resource/v4/interface/performance/history/all

Description: Retrieve full historical RF and MOS data for diagnostics.

JSON Payload:
Parameter Type Required Description
cleId string Yes Customer Logical Entity ID
ban array Yes Billing Account Numbers
deviceName string Yes Parent device name to fetch interfaces for
interfaceNa string Yes Name of the specific interface (e.g., vni-
me 0/1.0)
startDate integer Optional Epoch timestamp
endDate integer Optional Epoch timestamp

Headers:

Header Required Value/Type Description

JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 1,
"performanceHistory": [
{
"name": "vni-0/0.0",
"carrier_name": "Verizon",
"device_name": "wbasp1-00259s-32163253e011",
"ipv4": "192.168.100.2",
"ipv6": "fe80::1a2b:3c4d:5e6f:7g8h",
 "mac": "00:1B:44:11:3A:B7",
"type": "LTE Interface",
"bandwidth_in": 8192,
"bandwidth_out": 4096,
"fwa_rsrp": -82,
"fwa_rsrq": -11,
"fwa_sinr": 20,
"vz_rsrp": -88,
"vz_rsrq": -10,
"vz_sinr": 23,
"interfaceMosScore": 2
}
]
}

5. Insights
1. Time Series Forecast
Endpoint: POST /performance/v5/insights/forecast
Description: Retrieve time series forecast data for specified BANs (Billing
Account Numbers)

JSON Payload:
Parameter Type Required Description
cleId string Yes Customer Location Entity ID
ban array Yes Billing Account Numbers
interfaceNam string Optional Filter by specific interface name
e
deviceName string Optional Filter by specific device name

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Request Body:

{
"cleId": "1835699",
"ban": ["U0263096", "X000230556"],
"interfaceName": "eth0",
 "deviceName": "device-001",
}

Example Response:
{
"forecasts": [
{
"interfaceName": "eth0",
"categories": ["2023-01-01", "2023-01-02", "2023-01-03"],
"series": [
{
"name": "Bandwidth In",
"data": [0.000004, 0.000005, 0.000005, 2025-04-02 00:00:00+00:00, 11BJM01ge-
4/0/5.1]
},
]
},
}

2. Anomaly Detection

Endpoint: POST performance/v5/insights/anomaly/detection

Description: Retrieve anomaly detection counts (daily and weekly) for
devices across specified BANs.

JSON Payload:
Parameter Type Required Description
cleId string Yes Customer Location Entity ID
ban array Yes Billing Account Numbers
deviceName string Optional Filter by specific interface name
minDailyCount integer Optional Filter by minimum daily anomaly count
minWeeklyCount integer Optional Filter by minimum weekly anomaly count

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 42,
 "anomalies": [
{
"deviceName": "wbansp1-00647z-32076791e016",
"dailyAnomalyCount": 7,
"weeklyAnomalyCount": 32
},
]
}

3. Anomaly Summary by Metric

Endpoint: POST performance/v5/insights/anomaly/summary
Description: Retrieve detailed anomaly history by metric for specific
devices within a date range.

JSON Payload:
Parameter Type Required Description
cleId string Yes Customer Location Entity ID
ban array Yes Billing Account Numbers
deviceName string Optional Specific device to filter by
startDate string Yes ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)
endDate string Yes ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)
bucket integer Optional Time aggregation window in seconds
(default: 86400 for daily)
metric string Optional Filter by specific metric name

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"timeRange": {
"start": "2024-12-01T00:00:00Z",
"end": "2024-12-08T00:00:00Z",
"bucket": "daily"
},
"metrics": [
"cpu_utilization",
"memory_usage",
"bandwidth_in"
],
 "anomalyDetails": [
{
"deviceName": "wbasp3-15940s-33548911e002",
"metricHistory": [
{
"metric": "cpu_utilization",
"anomalyData": [
{
"timestamp": "2024-12-01T12:00:00Z",
"value": 92.5,
"threshold": 85.0
},
]
},
]
}
]
}
}

Total Anomaly Summary

Endpoint: POST performance/v5/insights/anomaly/totals
Description: Retrieve a specific device using device name.

JSON Payload:
Parameter Type Required Description
cleId string Yes Customer Location Entity ID
ban array Yes Billing Account Numbers
timeRange string Optional "24h”, “7d”, “30d” (default: all time)
severityThreshol integer Yes Minimum severity level to include (1-5)
d

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"summary": {
"timeRange": "last 7 days",
"totalAnomalies": 1428,
"metrics": [
{
 "metricName": "cpu_utilization",
"count": 632,
"percentage": 43
},
],
"severityDistribution": {
"critical": 58,
"high": 231,
"medium": 673,
"low": 466
},
"trend": {
"changePercentage": 12.5,
"direction": "up"
}
}
}

5. Anomaly Counts For Device

Endpoint: POST performance/v5/insights/anomaly/device
Description: Retrieve daily and weekly anomaly counts for specific devices
within a BAN.

JSON Payload:
Parameter Type Required Description
cleId string Yes Customer Location Entity ID
ban array Yes Billing Account Numbers
deviceName string Optional Filter by specific device name
timeRange string Optional "24h”, (daily) or “7d”, (weekly) defaults to
both
minCount integer Optional Minimum anomaly count to include

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"timeRange": {
"daily": "last 24 hours",
"weekly": "last 7 days"
},
"devices": [
 {
"deviceName": "wbansp2-00891x-42076892f117",
"counts": {
"daily": 5,
"weekly": 35,
"trend": "down",
"changePercentage": 8.2
},
"topMetrics": [
{
"metric": "bandwidth_in",
"count": 22
},
{
"metric": "packet_loss",
"count": 8
}
]
}
],
"summary": {
"totalDevices": 15,
"devicesWithAnomalies": 8,
"totalDailyAnomalies": 42,
"totalWeeklyAnomalies": 287
}
}

6. Fixed Wireless Access (FWA) Insights

Endpoint: POST performance/v5/insights/fwa
Description: Retrieve FWA usage statistics and device counts by carrier.

JSON Payload:
Parameter Type Required Description
ecpdID string Yes Enterprise Customer Profile ID
wlsActNo string Yes Wireless Account Number
timeRange string Optional "24h”, “7d”, “30d” (default: current billing
cycle)
carrier string Optional Filter by specific carrier

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication
Example Response:
{
"usageMetrics": {
"timeRange": "last 7 days",
"totalBandwidth": "15.42 TB",
"carrierBreakdown": [
{
"carrier": "Verizon",
"bandwidth": "8.76 TB",
"percentage": 56.8
}
],
"averageDailyUsage": "2.20 TB"
},
"deviceMetrics": {
"totalDevices": 42,
"carrierDistribution": [
{
"carrier": "Verizon",
"deviceCount": 25,
"percentage": 59.5
},
],
"deviceHealth": {
"healthy": 38,
"degraded": 3,
"critical": 1
}
},
"lastUpdated": "2023-11-15T14:32:45Z"
}

7. FWA Historical Bandwidth Usage by Carrier

Endpoint: POST performance/v5/insights/fwa/usage-history
Description: Retrieve historical bandwidth usage trends by carrier for Fixed
Wireless Access.

JSON Payload:
Parameter Type Required Description
ecpdID string Yes Enterprise Customer Profile ID
wlsActNo string Yes Wireless Account Number
startDate string Yes ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)
endDate string Yes ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)
bucket integer Optional Time aggregation window in seconds
(default: 86400 for daily)
carrier string Optional Filter by specific carrier

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"timeRange": {
"start": "2024-12-08T00:00:00Z",
"end": "2024-12-15T00:00:00Z",
"resolution": "daily"
},
"carrierMetrics": [
{
"carrier": "Verizon",
"unit": "GB",
"timeSeries": [
{
"timestamp": "2024-12-08T00:00:00Z",
"bandwidth": 245.7
},
],
"stats": {
"peakUsage": 331,
"averageUsage": 293.8,
"totalUsage": 2056.6
}
},
],
"aggregateMetrics": {
"peakCombinedUsage": 490.3,
"averageDailyUsage": 436.1,
"totalPeriodUsage": 3052.7,
"usageChangePercentage": 12.4
}
}
}
6. Tunnels
1. Tunnel Details
Endpoint: POST /performance/v5/tunnel
Description: Retrieve a list of tunnel resources with general attributes.

JSON Payload:
Parameter Type Required Description
cleId string Yes Customer Logical Entity ID
ban array Yes Billing Account Numbers
tunnelName string Optional Unique tunnel identifier
siteName string Optional Filter by associated site
deviceName string Optional Filter by source or destination device
interfaceNam string Optional Filter by interface
e
status string Optional Tunnel status: UP or DOWN
type string Optional Tunnel type (e.g., IPSEC, GRE)
limit integer Optional Records per page
offset integer Optional Records to skip

Headers:
Header Required Value/Type Description
none - - -

Example Request Body:

{
"cleId": "4732445",
"ban": ["U0260318"],
"limit": 100,
"offset": 0,
"tunnelName": "Tunnel-12345",
"siteName": "Site-A",
"deviceName": "Router-456",
"interfaceName": "eth1",
"status": "UP",
"type": "IPSEC"
}

Example Response:
{
"totalCount": 2,
 "tunnels": [
{
"tunnelName": "Tunnel-12345",
"siteName": "Site-A",
"localIp": "10.1.1.1",
"remoteIp": "10.1.2.1",
"status": "UP",
"reachability": "UP",
"type": "IPSEC",
"vendor": "CISCO",
"healthScore": "GOOD"
},
]
}

2. Tunnel Detail by Tunnel Name

Endpoint: POST /performance/v5/tunnel
Description: Retrieve detailed configuration and metrics for a specific
tunnel.

JSON Payload:
Parameter Type Required Description
cleId string Yes Customer Logical Entity ID
ban array Yes Billing Account Numbers
tunnelName string Yes Unique tunnel identifier
siteName string Optional Filter by associated site
deviceName string Optional Filter by source or destination device
interfaceNam string Optional Filter by interface
e
status string Optional Tunnel status: UP or DOWN
type string Optional Tunnel type (e.g., IPSEC, GRE)
limit integer Optional Records per page
offset integer Optional Records to skip

Headers:
Header Required Value/Type Description
none - - -

Example Response:
{
"tunnelName": "Tunnel-12345",
"siteName": "Site-A",
"vendor": "CISCO",
 "localIp": "10.1.1.1",
"remoteIp": "10.1.2.1",
"protocol": "IPSEC",
"bandwidthAllocated": "100 Mbps",
"bandwidthUsed": "60 Mbps",
"status": "UP",
"reachability": "UP",
"lastUpdated": "2024-05-17T10:00:00Z"
}

3. Tunnel Performance History

Endpoint: POST /performance/v5/tunnel/history
Description: Retrieve time-series data for a tunnel including latency, jitter,
and throughput.

JSON Payload:

Parameter Type Required Description

cleId string Yes Customer Logical Entity ID
ban array Yes Billing Account Numbers
tunnelName string Yes Unique tunnel identifier
startDate String Optional ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)
endDate String Optional ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)
bucket integer Optional Aggregation window in seconds (e.g.,
86400)

Headers:
Header Required Value/Type Description
none - - -

Example Response:
{
"tunnelName": "Tunnel-12345",
"metrics": [
{
"timestamp": 1729891200,
"latencyMs": 15.3,
"jitterMs": 2.1,
"packetLossPercent": 0.2,
"bandwidthInMbps": 58.2,
"bandwidthOutMbps": 61.4
},
 {
"timestamp": 1729977600,
"latencyMs": 18.7,
"jitterMs": 3.3,
"packetLossPercent": 0.4,
"bandwidthInMbps": 62.1,
"bandwidthOutMbps": 69
}
]
}

Tunnel Codec
Endpoint: POST /performance/v5/tunnel/codec
Description: Fetch codec-related metrics used in a tunnel, including audio
quality and MOS.

JSON Payload:

Parameter Type Required Description

cleId string Yes Customer Logical Entity ID
ban array Yes Billing Account Numbers
tunnelName string Yes Unique tunnel identifier

Headers:
Header Required Value/Type Description
none - - -

Example Response:
{
"tunnelName": "Tunnel-12345",
"codec": "G.711",
"codecDescription": "High-quality audio (64 kbps)",
"mosScore": 3,
"sampleCount": 892,
"lastUpdated": "2024-05-17T09:20:00Z"
}

5. Tunnel MOS (Mean Opinion Score)

Endpoint: POST /performance/v5/tunnel/mos
Description: Retrieve MOS score trends for voice or media quality on a
tunnel.
JSON Payload:

Parameter Type Required Description

cleId string Yes Customer Logical Entity ID
ban array Yes Billing Account Numbers
tunnelName string Yes Unique tunnel identifier
startDate String Optional ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)
endDate String Optional ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)
bucket integer Optional Aggregation window in seconds (e.g.,
86400)

Headers:
Header Required Value/Type Description
none - - -

Example Response:
{
"tunnelName": "Tunnel-12345",
"mosScores": [
{
"timestamp": 1729827283,
"mosScore": 5
},
{
"timestamp": 1729913683,
"mosScore": 3
},
{
"timestamp": 1730000083,
"mosScore": 1
}
]
}

6. Tunnel Utilization
Endpoint: POST /performance/v5/tunnel/utilization
Description: Returns tunnel usage metrics like bandwidth in/out over time
or by snapshot.

JSON Payload:
 Parameter Type Required Description
cleId string Yes Customer Logical Entity ID
ban array Yes Billing Account Numbers
tunnelName string Optional Unique tunnel identifier
startDate String Optional ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)
endDate String Optional ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)

Headers:
Header Required Value/Type Description
none - - -

Example Response:
{
"tunnelName": "Tunnel-12345",
"averageBandwidthInMbps": 56.7,
"averageBandwidthOutMbps": 60.2,
"peakBandwidthInMbps": 78.3,
"peakBandwidthOutMbps": 81.6,
"last24hUtilization": [
{
"timestamp": 1729891200,
"in": 51.2,
"out": 60.1
},
{
"timestamp": 1729977600,
"in": 59.0,
"out": 62.7
}
]
}

7. Tunnel Score Trend

Endpoint: POST /performance/v5/tunnel/scoreTrend
Description: Retrieve score trends used for tunnel performance ranking or
health scoring.

JSON Payload:
Parameter Type Required Description
cleId string Yes Customer Logical Entity ID
ban array Yes Billing Account Numbers
tunnelName string Yes Unique tunnel identifier
startDate String Optional ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)
endDate String Optional ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)
bucket integer Optional Aggregation window in seconds (e.g.,
86400)

Headers:
Header Required Value/Type Description
none - - -

Example Response:
{
"tunnelName": "Tunnel-12345",
"scoreTrend": [
{
"timestamp": 1729827283,
"score": 8.5,
"status": "GOOD"
},
{
"timestamp": 1729913683,
"score": 7.9,
"status": "MODERATE"
},
{
"timestamp": 1730000083,
"score": 6.2,
"status": "POOR"
}
]
}
7. FWA

1. Interfaces
1.1 Top Interfaces Data (In/Out & Uplink/Downlink)
Endpoint: POST /inventory/v4/fwa/interfaces/performance
Description: Retrieves aggregated data in/out and uplink/downlink metrics
for interfaces.

JSON Payload:
Parameter Type Required Description
cleId String Yes Customer Location Entity ID.
ban Array Yes Billing Account Numbers.
ecpdID String Yes Enterprise Customer Profile IDs.
wlsActNo String Yes Wireless Account Numbers.
deviceId String Optional Filter by specific device.
interfaceNam String Optional Filter by interface name (e.g., eth0).
e

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Request Body:

{
"cleId": "4732445",
"ban": ["PR00120024", "PR00120324"],
"ecpdID": "7891802",
"wlsActNo": "542659067-1",
"deviceId": "c08627abd66e1c7",
"interfaceName": "eth0"
}

Example Response:

{
"totalCount": 15,
"interfaces": [
{
"deviceId": "cc08627abd66e1c7",
 "interfaceName": "eth0",
"dataIn": "1.2 Gbps",
"dataOut": "0.8 Gbps",
"upLink": "95%",
"downLink": "92%"
}
]
}

1.2 Interface Details

Endpoint: POST inventory/v4/fwa/interfaces/details
Description: Retrieves interface metadata.

JSON Payload:
Parameter Type Required Description
cleId String Yes Customer Location Entity ID
ban Array Yes Billing Account Numbers
deviceId String Yes Filter by specific device.
interfaceName String Optional Filter by interface name (e.g., eth0).
limit Integer No Pagination limit (default: 100).
offset Integer No Pagination offset (default: 0).

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 5,
"interfaces": [
{
"deviceId": "cc08627abd66e1c7",
"interfaceName": "eth0",
"provideName": "VLAN100",
"connectionState": "Active",
"connectionType": "Ethernet",
"upTime": "86400",
"serviceType": "Internet",
"mtu": 1500,
"provisionedSpeed": "1 Gbps",
"model": "XYZ-4000",
 "ipv4": "192.168.1.2",
"ipv6": "2001:db8::1",
"networkDeviceType": "5G Interface",
"wirelessHealthScore": 92
}
]
}

1.3 Wireless Interface Performance

Endpoint: POST performance/v5/fwa/interfaces/metrics
Description: Retrieves wireless performance metrics (RSRP, SINR,
throughput).

JSON Payload:
Parameter Type Required Description
cleId String Yes Customer Location Entity ID.
ban Array Yes Billing Account Numbers.
deviceId String Yes Target device ID.
startDate String Optional ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)
endDate String Optional ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)
bucket Integer Optional Aggregation window (default: 86400).
limit Integer Optional Pagination limit (default: 25).
offset Integer Optional Pagination offset (default: 0).

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 7,
"metrics": [
{
"timestamp": "2025-01-01T00:00:00Z",
"rsrp": -85,
"rsrq": -12,
"sinr": 15,
"throughputIn": "450 Mbps",
"throughputOut": "380 Mbps",
"dataIn": "1.2 GB",
 "dataOut": "0.8 GB",
"wirelessPerformance": "GOOD"
}
]
}

2. Wireless Sites
2.1 Wireless Site Performance
Endpoint: POST performance/v5/fwa/sites/performance
Description: Retrieves performance metrics for wireless sites.

JSON Payload:
Parameter Type Required Description
ecpdID String Yes Enterprise Customer Profile ID
wlsActNo String Yes Wireless Account Number
siteId String Optional Filter by specific site ID
startDate String Optional ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)
endDate String Optional ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)
limit Integer Optional Pagination limit (default: 25)
offset Integer Optional Pagination offset (default: 0)

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 15,
"sites": [
{
"siteId": "1f49da6774",
"dataIn": "2.5 TB",
"dataOut": "1.8 TB",
"wirelessHealthScore": 85,
"reachability": "Good"
}
]
}

2.2 Wireless Site Map

Endpoint: POST inventory/v4/fwa/sites/map
Description: Retrieves geographic site details for mapping.

JSON Payload:
Parameter Type Required Description
ecpdID String Yes Enterprise Customer Profile ID
wlsActNo String Yes Wireless Account Number
networkType Array No Filter by network type (e.g., ["5GS", "4GS"])
healthScore Array No Filter by health score (e.g., ["Good",
"Excellent"])

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 8,
"sites": [
{
"siteId": "b6b9978bf8",
"wirelessHealthScore": 92,
"address": {
"state": "CA",
"country": "US",
"longitude": -118.2437,
"latitude": 30522,
"provider": "Verizon"
},
"networkType": "5GS",
"deviceCount": 42
}
]
}

2.3 Wireless Site List

Endpoint: POST inventory/v4/fwa/sites/list
Description: Retrieves paginated list of wireless sites.
JSON Payload:
Parameter Type Required Description
ecpdID String Yes Enterprise Customer Profile ID
wlsActNo String Yes Wireless Account Number
sort String Optional Field to sort by (e.g., "numberOfDevices")
isAsc Boolean Optional "asc" or "desc" (default: "desc")
limit Integer Optional Pagination limit (default: 25)
offset Integer Optional Pagination offset (default: 0)

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 15,
"sites": [
{
"siteId": "25d875bd6b",
"siteAddress": "20 East Goethe Street",
"serviceType": "FWA",
"numberOfDevices": 38,
"wirelessHealthScore": 88,
"provider": "Verizon"
}
]
}

2.4 Site Reports

Endpoint: POST performance/v5/fwa/sites/reports
Description: Retrieves interface performance data for a specific site.

JSON Payload:
Parameter Type Required Description
ecpdID String Yes Enterprise Customer Profile ID
wlsActNo String Yes Wireless Account Number
siteId String Yes Target site ID
interfaceName String Optional Filter by interface name

Headers:
 Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 3,
"interfaces": [
{
"interfaceName": "eth0",
"dataIn": "150 Mbps",
"dataOut": "120 Mbps"
}
]
}

2.5 Device List Per Site

Endpoint: POST inventory/v4/fwa/sites/devices
Description: Retrieves devices associated with a specific site.

JSON Payload:
Parameter Type Required Description
ecpdID String Yes Enterprise Customer Profile ID
wlsActNo String Yes Wireless Account Number
siteId String Yes Target Site Id
sort String Optional Field to sort by (e.g., "numberOfDevices")
isAsc Boolean Optional true or false (default: false)
limit Integer Optional Pagination limit (default: 25)
offset Integer Optional Pagination offset (default: 0)

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 42,
"devices": [
{
"deviceId": "b892eb97fe05d41c",
"deviceImei": "356405430129776",
"vendorName": "Cisco",
 "wirelessHealthScore": 90,
"swVersion": "12.2"
}
]
}

2.6 Site Active Services

Endpoint: POST inventory/v4/fwa/sites/active-services
Description: Retrieves active service information for a specific wireless site.

JSON Payload:
Parameter Type Required Description
ecpdID String Yes Enterprise Customer Profile ID
wlsActNo String Yes Wireless Account Number
siteId String Yes Target site ID
interfaceName String Optional Filter by interface name
limit Integer Optional Pagination limit (default: 100)
offset Integer Optional Pagination offset (default: 0)

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 3,
"services": [
{
"mdn": "5551234567",
"accessType": "5G",
"speed": "1 Gbps",
"provider": "Verizon",
"serviceStatus": "Active"
},
{
"mdn": "5559876543",
"accessType": "LTE",
"speed": "500 Mbps",
"provider": "Verizon",
"serviceStatus": "Active"
}
]
}

3. Wireless Devices
3.1. Wireless Devices List
Endpoint: POST inventory/v4/fwa/devices/list
Description: Retrieves paginated list of wireless devices with key attributes.

JSON Payload:
Parameter Type Required Description
ecpdID String Yes Enterprise Customer Profile ID
wlsActNo String Yes Wireless Account Number
siteId String Optional Filter by site ID
deviceId String Optional Filter by specific device ID
networkType Array Optional Filter by network type (e.g., ["5GS","4GS"])
healthScore Array Optional Filter by health score range (e.g.,
["Good","Excellent"])
sort String Optional Field to sort by (e.g., "numberOfDevices")
isAsc Boolean Optional true or false (default: "desc")
limit Integer Optional Pagination limit (default: 100)
offset Integer Optional Pagination offset (default: 0)

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 215,
"devices": [
{
"deviceId": "8a3b2c63f3e1c0c7",
"deviceImei": "356405430129776",
"vendorName": "Cisco",
"deviceNetworkType": "5GS",
"wirelessHealthScore": 92,
"swVersion": "12.2",
"modelName": "XYZ-4000"
}
]
}
3.2 Wireless Devices Utilization
Endpoint: POST performance/v5/fwa/devices/utilization
Description: Retrieves resource utilization metrics for devices.

JSON Payload:
Parameter Type Required Description
ecpdID String Yes Enterprise Customer Profile ID
wlsActNo String Yes Wireless Account Number
deviceId Array Optional Filter by device IDs
metricType Array Optional Metrics to include (e.g., ["cpu","memory"])

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 42,
"utilization": [
{
"deviceId": "b892eb97fe05d41c",
"cpuUtilization": 65,
"memoryUtilization": 58,
"timestamp": "2025-01-01T12:00:00Z"
}
]
}

3.3 Wireless Devices Daily Speed Test

Endpoint: POST performance/v5/fwa/devices/speed-tests
Description: Retrieves historical speed test results.

JSON Payload:
Parameter Type Required Description
ecpdID String Yes Enterprise Customer Profile ID
wlsActNo String Yes Wireless Account Number
deviceName String Optional Filter by device name
startDate String Optional ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)
endDate String Optional ISO 8601 format (e.g. 2025-06-
 04T00:00:00Z)
bucket Integer Optional Aggregation window (default: 86400)

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 7,
"speedTests": [
{
"timestamp": "2025-01-01T00:00:00Z",
"weightedDL": "450 Mbps",
"weightedUL": "380 Mbps",
"busyHourDL": "420 Mbps",
"busyHourUL": "350 Mbps"
}
]
}

3.4 Wireless Device Performance

Endpoint: POST performance/v5/fwa/devices/performance
Description: Retrieves detailed performance metrics for devices.

JSON Payload:
Parameter Type Required Description
ecpdID String Yes Enterprise Customer Profile ID
wlsActNo String Yes Wireless Account Number
deviceId String Yes Target device ID
startDate String Optional ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)
endDate String Optional ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)
metrics String[] No Specific metrics to include

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 24,
"performance": [
{
"timestamp": "2025-01-01T12:00:00Z",
"rsrp": -85,
"rsrq": -12,
"sinr": 15,
"rssi": -60,
"throughputIn": "450 Mbps",
"throughputOut": "380 Mbps",
"antennaTemp": "45 °C",
"connectedDeviceCount": 8,
"memoryAvailable": "1.2 GB",
"memoryFreePerformance": "800 MB"
}
]
}

Insights
1. FWA Insights Devices
Endpoint: POST performance/v5/fwa/insights/devices
Description: Identifies devices with special conditions (high temp, high
usage, etc.)

JSON Payload:
Parameter Type Required Description
ecpdID String Yes Enterprise Customer Profile ID
wlsActNo String Yes Wireless Account Number
thresholds Object Optional Custom threshold values

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"highTemperatureDevices": 12,
"highUsageDevices": 8,
"locationViolationDevices": 3,
 "servicesExperienceDevices": 5
}

2 FWA NQES Score History

Endpoint: POST performance/v5/fwa/insights/health-score
Description: Retrieves historical wireless health score trends.

JSON Payload:
Parameter Type Required Description
ecpdID String Yes Enterprise Customer Profile ID
wlsActNo String Yes Wireless Account Number
timeRange String Optional ”7d”, “30d” (default: “30d”)

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 30,
"scores": [
{
"date": "2025-01-01",
"score": 88,
"trend": "up"
}
]
}

3 FWA Anomaly Detection

Endpoint: POST performance/v5/fwa/insights/anomalies
Description: Identifies devices with abnormal behavior patterns.

JSON Payload:
Parameter Type Required Description
ecpdID String Yes Enterprise Customer Profile ID
wlsActNo String Yes Wireless Account Number
severity Array No ["low","medium","high","critical"]
timeRange String No "24h", "7d" (default: "7d")
Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 15,
"anomalies": [
{
"deviceId": "b892eb97fe05d41c",
"deviceName": "7725849664",
"dailyAnomalyCount": 5,
"weeklyAnomalyCount": 32,
"severity": "high"
}
]
}

Top N Devices Daily Speed Test Insights

Endpoint: POST performance/v5/fwa/insights/speed-metrics
Description: Provides weighted speed test performance metrics.

JSON Payload:
Parameter Type Required Description
ecpdID String Yes Enterprise Customer Profile ID
wlsActNo String Yes Wireless Account Number

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"metrics": {
"weightedDL": "450 Mbps",
"weightedUL": "380 Mbps",
"busyHourDL": "420 Mbps",
"busyHourUL": "350 Mbps"
}
}
5. Top/Bottom MDN Metrics
Endpoint: POST performance/v5/fwa/insights/mdn-ranking
Description: Ranks top and bottom performing MDNs by metric.

JSON Payload:
Parameter Type Required Description
ecpdID String Yes Enterprise Customer Profile ID
wlsActNo String Yes Wireless Account Number
metricName String Yes "bh_dl_tp", "weighted_ul_tp", etc.
startDate String Optional ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)
endDate String Optional ISO 8601 format (e.g. 2025-06-
04T00:00:00Z)

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"top5": [
{
"mdn": "5551234567",
"metricValue": "520 Mbps"
}
],
"bottom5": [
{
"mdn": "5559876543",
"metricValue": "120 Mbps"
}
]
}

5. Dashboard
5.1. Dashboard Summary
Endpoint: POST performance/v5/fwa/dashboard/summary
Description: Provides high-level summary counts for dashboard views.
JSON Payload:
Parameter Type Required Description
ecpdID String Yes Enterprise Customer Profile ID
wlsActNo String Yes Wireless Account Number

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"siteSummary": {
"totalCount": 42,
"healthy": 38,
"degraded": 3,
"critical": 1
},
"deviceSummary": {
"totalCount": 215,
"healthy": 195,
"degraded": 15,
"critical": 5
},
"wirelessHealthScore": 88
}

8. Combined View

1. Devices
1.1 Combined Devices List
Endpoint: POST /inventory/v4/combined/devices/list
Description: Retrieves a combined list of devices, supporting sorting,
pagination, and advanced filtering options.

JSON Payload:
Parameter Type Required Description
cleId String Yes Customer Location Entity ID.
ban Array Yes Billing Account Numbers.
ecpdID String Yes Enterprise Customer Profile IDs.
wlsActNo String Yes Wireless Account Numbers.
sortField String Optional Field to sort by (e.g., low, critical,
deviceName)
isAsc Boolean Optional true for ascending sort, false for descending
limit Integer Optional Number of records to return
offset Integer Optional Number of records to skip
deviceName String Optional Filter by device name
siteId String Optional Filter by Site ID
flowType String Optional Filter by Flow Type (e.g., combined, wireless,
wireline)
networkHealt Array Optional Filter by Network Health Score values (e.g.,
hScore ["EXCELLENT"])
nqesWireless Array Optional Filter by Wireless Health Score (e.g.,
Score ["EXCELLENT"])
slaFilter Array Optional Filter by SLA presence (e.g., ["YES"])

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Request Body:

{
"cleId": "4732445",
"ban": ["PR00120024", "PR00120324"],
"ecpdID": "7891802",
"wlsActNo": "542659067-1",
"sortField": "low",
"isAsc": false,
"limit": 4,
"offset": 0,
"deviceName": "wbasp3-10109s-32108897e031",
"siteId": "459f0d15c8",
"flowType": "combined",
"networkHealthScore": ["EXCELLENT"],
"nqesWirelessScore": ["EXCELLENT"],
"slaFilter": ["YES"]
}

Example Response:

{
"totalCount": 2,
 "devices": [
{
"deviceName": "wbasp3-10109s-32108897e031",
"mdn": "3480238490",
"vendorName": "Cisco",
"model": "XR5000",
"deviceImei": "358736094738290",
"dnsHostName": "router1.domain.com",
"dnsEntityName": "corp",
"ticketSummary": {
"critical": 2,
"high": 5,
"medium": 3,
"low": 1
},
"managementState": "Managed",
"flowType": "combined",
"networkHealthScore": "EXCELLENT",
"wirelessHealthScore": "GOOD",
"reachability": "Reachable",
"deviceAvailability": "Available",
"deviceNetworkType": "5G",
"iccID": "8914800000555555555",
"deviceId": "32108897e031"
}
]
}

1.2 Combined Devices Utilization

Endpoint: POST /performance/v5/combined/devices/utilization
Description: Retrieves CPU, memory, and disk utilization metrics for a
combined list of devices.

JSON Payload:
Parameter Type Required Description
cleId String Yes Customer Location Entity ID
ban Array Yes Billing Account Numbers
ecpdID String Yes Enterprise Customer Profile ID
wlsActNo String Yes Wireless Account Number
limit Integer Optional Number of records to return (default: 25)
offset Integer Optional Number of records to skip (default: 0)

Headers:
 Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"devices": [
{
"memoryUtilization": "67%",
"diskUtilization": "75%",
"cpuUtilization": "42%"
},
}

1.3 Device Performance Metrics

Endpoint: POST /performance/v5/combined/devices/performance
Description: Retrieves performance metrics for a specific device over a
specified time range.

JSON Payload:
Parameter Type Required Description
cleId String Yes Customer Location Entity ID
ban Array Yes Billing Account Numbers
startDate Integer Optional Start of the time range (Epoch timestamp)
endDate Integer Optional End of the time range (Epoch timestamp)
bucket Integer Optional Time bucket size in seconds (e.g., 86400 for
daily)
deviceName String Optional Filter by device name

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 7,
"devices": [
{
"bandwidth_in": "950 Mbps",
"bandwidth_out": "870 Mbps",
"session_load": "62%",
 "fwaBandwidthIn": "810 Mbps",
"fwaBandwidthOut": "690 Mbps",
"deviceAvailability": "99.98%",
"reachability": "98.9%",
"networkHealthScore": "EXCELLENT",
"wirelessHealthScore": "GOOD",
"packetLoss": "0.3%"
}
]
}

2. Combined Sites
2.1 Combined Site List
Endpoint: POST /inventory/v4/combined/site/list
Description: Retrieves a list of sites with associated metadata, location
details, ticket summary, device count, health scores, and availability metrics.

JSON Payload:
Parameter Type Required Description
cleId String Yes Customer Location Entity ID
ban Array Yes Billing Account Numbers
ecpdID String Yes Enterprise Customer Profile ID
wlsActNo String Yes Wireless Account Number
flowType String Optional Filter by flow type (e.g., wireline, wireless)

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 2,
"sites": [
{
"site_name": "89605781C 05799-S",
"siteId": "d242cd363f",
"address": "123 Main St",
"addressDetail": {
"address": "123 Main St, Cityville",
"latitude": "40.7128",
 "longitude": "-70060",
"provider": "Verizon",
"state": "NY",
"country": "USA"
},
"dnsHostName": "host123.site.com",
"site_type": "Retail",
"service_id": "svc-928392",
"location_code": "LCX-021",
"flowType": "wireline",
"ticketSummary": {
"critical": 0,
"high": 1,
"medium": 2,
"low": 5
},
"wirelessHealthScore": "GOOD",
"networkHealthScore": "EXCELLENT",
"bandwidth_in": "850 Mbps",
"bandwidth_out": "780 Mbps",
"numberOfDevices": 12,
"siteAvailability": "99.97%",
"reachability": "98.5%",
"store": "Store A",
"siteSla": "YES"
}
]
}

2.2 Combined Device List Per Site (Wireline)

Endpoint: POST inventory/v4/combined/site/devices
Description: Returns a list of devices for a given site filtered by tenant and
flow type (wireline in this case).

JSON Payload:
Parameter Type Required Description
cleId String Yes Customer Location Entity ID
ban Array Yes Billing Account Numbers
ecpdID String Yes Enterprise Customer Profile ID
wlsActNo String Yes Wireless Account Number
siteId String Yes Unique Site Identifier
flowType String Optional Flow type (e.g., wireline, wireless)
limit Number Optional Max number of records to return (default:
100)
offset Number Optional Pagination offset (default: 0)
Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 2,
"devices": [
{
"deviceName": "Router-X1",
"mdn": "356405431149997",
"vendorName": "Cisco",
"dnsHostName": "host01.site.com",
"dnsEntityName": "entity01.site.com",
"ticketSummary": {
"critical": 1,
"high": 0,
"medium": 2,
"low": 3
},
"managementState": "Managed",
"flowType": "wireline",
"networkHealthScore": "EXCELLENT",
"wirelessHealthScore": "N/A",
"reachability": "99.9%",
"deviceAvailability": "99.95%",
"deviceId": "dev123456"
}
]
}

2.3 Combined Device List Per Site (Wireless)

Endpoint: POST /inventory/v4/combined/site/devices
Description: Retrieves paginated list of wireless sites.

JSON Payload:
Parameter Type Required Description
cleId String Yes Customer Location Entity ID
ban Array Yes Billing Account Numbers
ecpdID String Yes Enterprise Customer Profile ID
wlsActNo String Yes Wireless Account Number
siteId String Yes Unique Site Identifier
 flowType String Optional Flow type (e.g., wireline, wireless, combined)
limit Number Optional Max number of records to return (default: 25)
offset Number Optional Pagination offset (default: 0)

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 3,
"devices": [
{
"deviceName": "Device-A1",
"mdn": "356405431149997",
"vendorName": "Nokia",
"dnsHostName": "wireless-host.site.com",
"dnsEntityName": "wireless-entity.site.com",
"ticketSummary": {
"critical": 0,
"high": 1,
"medium": 0,
"low": 2
},
"managementState": "Unmanaged",
"flowType": "combined",
"networkHealthScore": "GOOD",
"wirelessHealthScore": "EXCELLENT",
"reachability": "98.5%",
"deviceAvailability": "99.0%",
"deviceId": "dev987654"
}
]
}

2.4 Combined Site Active Services per Site

Endpoint: POST /inventory/v4/combined/sites/active-services
Description: Retrieves active service information (circuits) for a specific site
under a tenant.

JSON Payload:
Parameter Type Required Description
 cleId String Yes Customer Location Entity ID
ban Array Yes Billing Account Numbers
ecpdID String Yes Enterprise Customer Profile ID
wlsActNo String Yes Wireless Account Number
siteId String Yes Unique Site Identifier
flowType String Optional Type of flow: wireline, wireless, or combined

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"siteActiveServices": [
{
"circuit_id": "ABC12345",
"circuit_type": "Private Line",
"speed": "1 Gbps",
"provider": "Verizon",
"access": "Dedicated"
},
{
"circuit_id": "XYZ67890",
"circuit_type": "Internet",
"speed": "500 Mbps",
"provider": "AT&T",
"access": "Shared"
}
]
}

2.5 Combined Site Performance History

Endpoint: POST /performance/v5/combined/sites/history
Description: Returns historical performance metrics for a specific site over
a specified time range.

JSON Payload:
Parameter Type Required Description
cleId String Yes Customer Location Entity ID
ban Array Yes Billing Account Numbers
ecpdID String Yes Enterprise Customer Profile ID
 wlsActNo String Yes Wireless Account Number
siteId String Yes Unique Site Identifier
flowType String Optional Type of flow: wireline, wireless, or combined
startDate Integer Yes Start timestamp in UNIX format (seconds)
endDate Integer Yes End timestamp in UNIX format (seconds)
bucket Integer Optional Interval bucket in seconds (e.g., 86400 for
daily)

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 42,
"sites": [
{
"bandwidth_in": 1024,
"bandwidth_out": 850,
"packetLoss": 0.5,
"siteAvailability": 99.8,
"reachability": 98.7,
"networkHealthScore": "GOOD"
},
}

2.6 Combined Site Performance Interface TopN All

Endpoint: POST /performance/v5/combined/sites/interface
Description: Retrieves a paginated list of top interfaces across all sites.

JSON Payload:
Parameter Type Required Description
cleId String Yes Customer Location Entity ID
ban Array Yes Billing Account Numbers
ecpdID String Yes Enterprise Customer Profile ID
wlsActNo String Yes Wireless Account Number
offset Integer Optional Pagination offset (default: 0)
limit Integer Optional Pagination limit (default: 25)

Headers:
 Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"totalCount": 21,
"interfaces": [
{
"bandwidth_in": 3500,
"bandwidth_out": 2900
},
]
}

3. Dashboard
3.1 Combined Dashboard
Endpoint: POST /inventory/v4/combined/dashboard/summary
Description: Fetches a comprehensive summary across multiple dashboard
components.

JSON Payload:
Parameter Type Required Description
cleId String Yes Customer Location Entity ID
ban Array Yes Billing Account Numbers
ecpdID String Yes Enterprise Customer Profile ID
wlsActNo String Yes Wireless Account Number

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
"ticketSummary": {
"totalCount": 125,
"summaryByStatus": {
"open": 75,
"closed": 50
}
},
"siteSummary": {
"totalCount": 200,
"summaryByStatus": {
"active": 180,
"inactive": 20
}
},
"deviceSummary": {
"totalCount": 500,
"summaryByStatus": {
"up": 460,
"down": 40
}
},
"simByCountSummary": {
"totalCount": 320,
"summaryByStatus": {
"active": 300,
"inactive": 20
}
},
"serviceTypeByCountSummary": {
"totalCount": 5,
"summaryByStatus": {
"internet": 3,
"voice": 2
}
},
"interfaceSummary": {
"totalCount": 150,
"summaryByStatus": {
"healthy": 140,
"degraded": 10
}
},
"verizonFwaSiteSummary": {
"totalCount": 40,
"summaryByStatus": {
"active": 35,
"inactive": 5
}
},
"siteAvailability": {
"totalCount": 200,
"percentage": 98.5,
"summaryByStatus": {
"available": 197,
 "unavailable": 3
}
},
"cradlepointDeviceSummary": {
"totalCount": 80,
"summaryByStatus": {
"online": 75,
"offline": 5
}
},
"deviceCategorySummary": {
"totalCount": 4,
"summaryByStatus": {
"router": 2,
"switch": 1,
"modem": 1
}
}
}

3.2 Combined SiteMap

Endpoint: /inventory/v4/combined/dashboard/sitemap
Description: Retrieves detailed map-level data about customer sites,
filtered by tenant and optional network/health filters.

JSON Payload:
Parameter Type Required Description
cleId String Yes Customer Location Entity ID
ban Array Yes Billing Account Numbers
ecpdID Array Yes Enterprise Customer Profile IDs
wlsActNo Array Yes Wireless Account Numbers
networkType Array No Types of networks (e.g., "4G LTE", "5G")
health Array No Health categories ("good", "average", etc.)
siteType Array No Optional filter (e.g., ["HA"])

Headers:
Header Required Value/Type Description
JWT Token Yes string (secure) Bearer JWT Token for authentication

Example Response:
{
{
 "id": "001",
"name": "New York Site A",
"health": "excellent",
"deviceCount": 25,
"nodeCount": 4,
"networkType": "5G",
"servicesEnabled": ["Internet", "VPN"],
"address": {
"address": "123 Main St",
"state": "NY",
"longitude": -7006,
"latitude": 40.7128,
"provider": "Verizon",
"country": "USA"
},
"networkHealthScore": 95,
"networkHealthScoreCategory": "Excellent",
"site_type": "HA",
"ticketSummary": {
"critical": 0,
"high": 1,
"medium": 2,
"low": 3
}
},
{
"id": "002",
"name": "Chicago Site B",
"health": "average",
"deviceCount": 15,
"nodeCount": 2,
"networkType": "4G LTE",
"servicesEnabled": ["Internet"],
"address": {
"address": "456 West St",
"state": "IL",
"longitude": -87.6298,
"latitude": 41.8781,
"provider": "Verizon",
"country": "USA"
},
"networkHealthScore": 70,
"networkHealthScoreCategory": "Average",
"site_type": "Standard",
"ticketSummary": {
"critical": 1,
"high": 0,
"medium": 0,
 "low": 5
}
}
]
}