# private cellular radio metrics — NCM API

Beta. Throughput samples for each radio in a private cellular network: timestamped bits uploaded and downloaded, per radio. Read-only, a single list call. Records reference the radio they came from; private cellular radio statuses carries live state rather than history.

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

### GET /api/v3/beta/private_cellular_radio_metrics

List PCN Radio Metrics

Return a list of private cellular AP information

> **Beta:** This endpoint is served on a `/beta/` path. Beta endpoints are still evolving and may change without the stability guarantees of GA endpoints.

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| page[after] | query | string | no |  |
| page[before] | query | string | no |  |
| page[size] | query | integer | no |  |
| interval | query | array of string (hour | day) | yes | The hourly or daily data to return the results. |
| fields | query | array of string | no | Provide bits_downloaded, bits_uploaded here to get it's value in the results. |
| filter[start_time] | query | string | no | The start time from which to return the results ie; 2023-07-14T10:16:19.000Z. |
| filter[end_time] | query | string | no | The end time from which to return the results ie; 2023-07-14T10:16:19.000Z. |
| filter[cell] | query | string | no | The cell from which to return the results. |

**Example request**

```bash
curl "https://api.cradlepointecm.com/api/v3/beta/private_cellular_radio_metrics" \
  -H "Authorization: Bearer <token>"
```

**Response 200** — successful operation

```json
{
  "data": [
    {
      "type": "private_cellular_radio_metrics",
      "id": "fda46c69-0f14-4f0a-a868-70959431f522",
      "attributes": {
        "timestamp": 1682240400,
        "bits_uploaded": 28,
        "bits_downloaded": 55
      },
      "relationships": {
        "private_cellular_radios": {
          "data": {
            "type": "private_cellular_radios",
            "id": "01GW0KJDK85T48767MCENJS4XC"
          }
        }
      }
    },
    {
      "type": "private_cellular_radio_metrics",
      "id": "e394d9a2-7a25-42bc-95f0-224505d4a803",
      "attributes": {
        "timestamp": 1682240401,
        "bits_uploaded": 20,
        "bits_downloaded": 100
      },
      "relationships": {
        "private_cellular_radios": {
          "data": {
            "type": "private_cellular_radios",
            "id": "01GW0KJDK85T48767MCENJS4XC"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "before": "<cursor_key_before>",
      "after": "<cursor_key_after>",
      "limit": 10
    },
    "start_time": "2023-04-22T00:00:00Z",
    "end_time": "2023-04-25T23:59:59Z",
    "interval": "daily"
  },
  "links": {
    "next": "https://api.cradlepointecm.com/api/v3/beta/private_cellular_radio_metrics?page[after]=<after_cursor_key>&page[limit]=10",
    "prev": "https://api.cradlepointecm.com/api/v3/beta/private_cellular_radio_metrics?page[before]=<before_cursor_key>&page[limit]=10"
  }
}
```
