Insight

`Insight`

Insight class.

`create_organization_insight_monitored_media_server`

Add a media server to be monitored for this organization.

API documentation: createOrganizationInsightMonitoredMediaServer

Parameters:

organization_id (str) –

Organization ID.
name (str) –

The name of the VoIP provider.
address (str) –

The IP address (IPv4 only) or hostname of the media server to monitor.
best_effort_monitoring_enabled (bool | None, default: None ) –

Indicates that if the media server doesn't respond to ICMP pings, the nearest hop will be used in its stead.

Returns:

OrganizationInsightMonitoredMediaServerResponse –

Successful operation.

Example API response

{
  "id": "1284392014819",
  "name": "Sample VoIP Provider",
  "address": "123.123.123.1",
  "bestEffortMonitoringEnabled": true
}

`delete_organization_insight_monitored_media_server`

Delete a monitored media server from this organization.

API documentation: deleteOrganizationInsightMonitoredMediaServer

Parameters:

organization_id (str) –

Organization ID.
monitored_media_server_id (str) –

Monitored media server ID.

Returns:

None –

Successful operation.

`get_network_insight_application_health_by_time`

Get application health by time.

API documentation: getNetworkInsightApplicationHealthByTime

Parameters:

network_id (str) –

Network ID.
application_id (str) –

Application ID.
t0 (str | None, default: None ) –

The beginning of the timespan for the data. The maximum lookback period is 7 days from today.
t1 (str | None, default: None ) –

The end of the timespan for the data. t1 can be a maximum of 7 days after t0.
timespan (float | None, default: None ) –

The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. The default is 2 hours.
resolution (int | None, default: None ) –

The time resolution in seconds for returned data. The valid resolutions are: 60, 300, 3600, 86400. The default is 300.

Returns:

PaginatedResponse[GetNetworkInsightApplicationHealthByTimeResponseItem] –

Successful operation.

Note

Returns a lazy PaginatedResponse that can be iterated or collected with .collect(). Page metadata is available on .meta and .meta_pages.

Example API response

[
  {
    "startTs": "2018-02-11T00:00:00Z",
    "endTs": "2018-05-12T00:00:00Z",
    "wanGoodput": 20000000,
    "lanGoodput": 100000000,
    "wanLatencyMs": 10.1,
    "lanLatencyMs": 3.2,
    "wanLossPercent": 0.2,
    "lanLossPercent": 0.0,
    "responseDuration": 210,
    "sent": 1000,
    "recv": 5000,
    "numClients": 2
  }
]

`get_organization_insight_applications`

List all Insight tracked applications.

API documentation: getOrganizationInsightApplications

Parameters:

organization_id (str) –

Organization ID.

Returns:

PaginatedResponse[GetOrganizationInsightApplicationsResponseItem] –

Successful operation.

Note

Returns a lazy PaginatedResponse that can be iterated or collected with .collect(). Page metadata is available on .meta and .meta_pages.

Example API response

[
  {
    "applicationId": "19.12",
    "name": "Meraki HTTPS",
    "thresholds": {
      "type": "smart",
      "byNetwork": [
        {
          "networkId": "N_12345678",
          "goodput": 50000,
          "responseDuration": 1000
        }
      ]
    }
  }
]

`get_organization_insight_monitored_media_server`

Return a monitored media server for this organization.

API documentation: getOrganizationInsightMonitoredMediaServer

Parameters:

organization_id (str) –

Organization ID.
monitored_media_server_id (str) –

Monitored media server ID.

Returns:

OrganizationInsightMonitoredMediaServerResponse –

Successful operation.

Example API response

{
  "id": "1284392014819",
  "name": "Sample VoIP Provider",
  "address": "123.123.123.1",
  "bestEffortMonitoringEnabled": true
}

`get_organization_insight_monitored_media_servers`

List the monitored media servers for this organization.

API documentation: getOrganizationInsightMonitoredMediaServers

Parameters:

organization_id (str) –

Organization ID.

Returns:

PaginatedResponse[OrganizationInsightMonitoredMediaServerResponse] –

Successful operation.

Note

Returns a lazy PaginatedResponse that can be iterated or collected with .collect(). Page metadata is available on .meta and .meta_pages.

Example API response

[
  {
    "id": "1284392014819",
    "name": "Sample VoIP Provider",
    "address": "123.123.123.1",
    "bestEffortMonitoringEnabled": true
  }
]

`update_organization_insight_monitored_media_server`

Update a monitored media server for this organization.

API documentation: updateOrganizationInsightMonitoredMediaServer

Parameters:

organization_id (str) –

Organization ID.
monitored_media_server_id (str) –

Monitored media server ID.
name (str | None, default: None ) –

The name of the VoIP provider.
address (str | None, default: None ) –

The IP address (IPv4 only) or hostname of the media server to monitor.
best_effort_monitoring_enabled (bool | None, default: None ) –

Indicates that if the media server doesn't respond to ICMP pings, the nearest hop will be used in its stead.

Returns:

OrganizationInsightMonitoredMediaServerResponse –

Successful operation.

Example API response

{
  "id": "1284392014819",
  "name": "Sample VoIP Provider",
  "address": "123.123.123.1",
  "bestEffortMonitoringEnabled": true
}