# 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

## Authentication

This is a v3 endpoint (`/api/v3/` path). Send a Bearer token on every request:

```http
Authorization: Bearer <token>
```

Tokens are generated in the NCM UI under API Keys. The v2 and v3 auth schemes are NOT interchangeable: v2 API-key headers are rejected on v3 endpoints.

### 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, connected_clients, bearer_setup_successes, bearer_setup_failures, bearer_setup_requests, s1_setup_successes, s1_setup_failures, s1_setup_requests, attach_accepts, attach_rejects, attach_requests, control_plane_cpu, system_memory, auth_accepts, auth_rejects, auth_requests and auth_failures 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

**Response 403** — auth failure