# private cellular core metrics — NCM API

Beta. Throughput and client-count samples from a private cellular core, each record carrying a timestamp, bits uploaded and downloaded, and the number of connected clients. Read-only. The core runs on a router, so records link back to that device; for its live health state see private cellular core statuses.

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

### GET /api/v3/beta/private_cellular_core_metrics

List PCN Core Metrics

Return a list of private cellular core metric 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 and connected_clients 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[router] | query | integer | no | The router from which to return the results. |
| filter[routers] | query | string | no | The routers from which to return the results ie; 65348,34754. |

**Example request**

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

**Response 200** — successful operation

```json
{
  "data": [
    {
      "type": "private_cellular_core_metrics",
      "id": "fda46c69-0f14-4f0a-a868-70959431f522",
      "attributes": {
        "timestamp": 1682240400,
        "bits_uploaded": 28,
        "bits_downloaded": 55,
        "connected_clients": 3
      },
      "relationships": {
        "router": {
          "data": {
            "type": "routers",
            "id": "3479433"
          }
        }
      }
    },
    {
      "type": "private_cellular_core_metrics",
      "id": "c072ab29-a715-47da-975f-002f765d9ff0",
      "attributes": {
        "timestamp": 1682240401,
        "bits_uploaded": 20,
        "bits_downloaded": 100,
        "connected_clients": 11
      },
      "relationships": {
        "router": {
          "data": {
            "type": "routers",
            "id": "3479433"
          }
        }
      }
    }
  ],
  "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_core_metrics?page[after]=<after_cursor_key>&page[limit]=10",
    "prev": "https://api.cradlepointecm.com/api/v3/beta/private_cellular_core_metrics?page[before]=<before_cursor_key>&page[limit]=10"
  }
}
```

**Response 403** — auth failure

### GET /api/v3/beta/private_cellular_core_statuses

List PCN Core statuses

Return a list of private cellular core status 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 |  |
| 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[router] | query | integer | yes | The router from which to return the results. |

**Example request**

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

**Response 200** — successful operation

### 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