# pcn visibility endpoints — NCM API

Beta. SIM reporting for Private Cellular Networks: SIM metrics, SIM group metrics, SIM connectivity metrics and SIM events. Four read-only list endpoints, no writes. Core metrics, core statuses and radio metrics have their own references; pcn management covers configuration.

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_sim_group_metrics

List PCN Sim Group Metrics

Return a list of private cellular sim group 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[network] | query | string | no | The network from which to return the results. |

**Example request**

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

**Response 200** — successful operation

**Response 403** — auth failure

### GET /api/v3/beta/private_cellular_sim_metrics

List PCN Sim Metrics

Return a list of private cellular sim 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 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[imsi_id] | query | string | no | The sim id from which to return the results. |

**Example request**

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

**Response 200** — successful operation

**Response 403** — auth failure

### GET /api/v3/beta/private_cellular_sim_connectivity_metrics

List PCN Sim Connectivity Metrics

Return a list of private cellular sim connectivity 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. |
| 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[imsi_id] | query | string | no | The sim id from which to return the results. |

**Example request**

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

**Response 200** — successful operation

**Response 403** — auth failure

### GET /api/v3/beta/private_cellular_sim_events

List PCN Sim Events

Return a list of private cellular sim event 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[imsi_id] | query | string | no | The sim id from which to return the results. |

**Example request**

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

**Response 200** — successful operation

**Response 403** — auth failure