# net device health — NCM API

A cellular health category and score for each device, summarising signal quality into something you can alert on. Read-only, a single list call. Note this is a v2 endpoint despite being the cellular-health surface; net device metrics carries the underlying signal and usage values.

Base URL: https://www.cradlepointecm.com/api/v2

### GET /net_device_health/

Get information about net_device_health

Use the GET method on this endpoint to retrieve net_device_health records. Use the available filtering fields to narrow or broaden your search.

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| X-ECM-API-ID | header | string | yes | <strong>ECM API app Id</strong> |
| X-ECM-API-KEY | header | string | yes | <strong>ECM API app key</strong> |
| X-CP-API-ID | header | string | yes | <strong>Cradlepoint API app Id</strong> |
| X-CP-API-KEY | header | string | yes | <strong>Cradlepoint API access key</strong> |
| net_device | query | integer | no | ID of a net device |
| id__gt | query | integer | no | Filter results to items with ID greater than specified value (cursor pagination) |
| id__gte | query | integer | no | Filter results to items with ID greater than or equal to specified value |
| id__lt | query | integer | no | Filter results to items with ID less than specified value |
| id__lte | query | integer | no | Filter results to items with ID less than or equal to specified value |
| limit | query | integer | no | Restricts the number of records returned in a recordset to this value. Max value is 500. |
| offset | query | integer | no | Specifies where (an index) in a recordset to begin returning records. |

**Example request**

```bash
curl "https://www.cradlepointecm.com/api/v2/net_device_health/" \
  -H "X-CP-API-ID: <cp-api-id>" \
  -H "X-CP-API-KEY: <cp-api-key>" \
  -H "X-ECM-API-ID: <ecm-api-id>" \
  -H "X-ECM-API-KEY: <ecm-api-key>"
```

**Response 200** — Example response.

```json
{
  "data": [
    {
      "cellular_health_category": "excellent",
      "cellular_health_score": 82,
      "id": "28298558",
      "net_device": "https://www.cradlepointecm.com/api/v2/net_devices/<net device id>/",
      "resource_url": "https://www.cradlepointecm.com/api/v2/net_device_health/28298558/"
    }
  ],
  "meta": {
    "limit": 20,
    "previous": null,
    "offset": 0,
    "next": null
  }
}
```