REST API for Oracle Internet of Things Cloud Service

Monitoring REST Endpoints

Monitoring

Retrieve status and metrics for an Oracle IoT Cloud Service Instance

Retrieve Availability Status: Method: get
Path: /iot/api/v2/monitoring/availability
Retrieve Availability Status of IoT Service: Method: get
Path: /iot/api/v2/monitoring/metrics/availability
Retrieve Device Count: Method: get
Path: /iot/api/v2/monitoring/metrics/registeredDeviceCount
Retrieve Dispatched Message Count: Method: get
Path: /iot/api/v2/monitoring/metrics/dispatchedMessageCount
Retrieve Dispatched Message Count for an app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dispatchedMessageCount
Retrieve Dispatched Message Count for an integrationID and app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/integrations/{integrationID}/monitoring/metrics/dispatchedMessageCount/
Retrieve Lost Message Count: Method: get
Path: /iot/api/v2/monitoring/metrics/dispatchFailedMessageCount/dropCount
Retrieve Lost Message Count due to a Not Found error: Method: get
Path: /iot/api/v2/monitoring/metrics/dispatchFailedMessageCount/notFoundCount
Retrieve Lost Message Count due to authorization failure: Method: get
Path: /iot/api/v2/monitoring/metrics/dispatchFailedMessageCount/authorizationFailureCount
Retrieve Lost Message Count due to bad request: Method: get
Path: /iot/api/v2/monitoring/metrics/dispatchFailedMessageCount/badRequestCount
Retrieve Lost Message Count due to connection reset: Method: get
Path: /iot/api/v2/monitoring/metrics/dispatchFailedMessageCount/connectionResetCount
Retrieve Lost Message Count due to other errors: Method: get
Path: /iot/api/v2/monitoring/metrics/dispatchFailedMessageCount/otherErrorCount
Retrieve Lost Message Count due to read timeout: Method: get
Path: /iot/api/v2/monitoring/metrics/dispatchFailedMessageCount/readTimeoutCount
Retrieve Lost Message Count for an app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dispatchFailedMessageCount/dropCount
Retrieve Lost Message Count for an app_id due to authorization failure: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dispatchFailedMessageCount/authorizationFailureCount
Retrieve Lost Message Count for an app_id due to bad request: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dispatchFailedMessageCount/badRequestCount
Retrieve Lost Message Count for an app_id due to connection reset: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dispatchFailedMessageCount/connectionResetCount
Retrieve Lost Message Count for an app_id due to not found error: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dispatchFailedMessageCount/notFoundCount
Retrieve Lost Message Count for an app_id due to other errors: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dispatchFailedMessageCount/otherErrorCount
Retrieve Lost Message Count for an app_id due to read timeout: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dispatchFailedMessageCount/readTimeoutCount
Retrieve Lost Message Count for an integrationID and app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/integrations/{integrationID}/monitoring/metrics/dispatchFailedMessageCount/dropCount/
Retrieve Lost Message Count for an integrationID and app_id due to authorization failure: Method: get
Path: /iot/api/v2/apps/{app_id}/integrations/{integrationID}/monitoring/metrics/dispatchFailedMessageCount/authorizationFailureCount/
Retrieve Lost Message Count for an integrationID and app_id due to bad gateway: Method: get
Path: /iot/api/v2/apps/{app_id}/integrations/{integrationID}/monitoring/metrics/dispatchFailedMessageCount/badGatewayCount/
Retrieve Lost Message Count for an integrationID and app_id due to connection reset: Method: get
Path: /iot/api/v2/apps/{app_id}/integrations/{integrationID}/monitoring/metrics/dispatchFailedMessageCount/connectionResetCount/
Retrieve Lost Message Count for an integrationID and app_id due to not found error: Method: get
Path: /iot/api/v2/apps/{app_id}/integrations/{integrationID}/monitoring/metrics/dispatchFailedMessageCount/notFoundCount/
Retrieve Lost Message Count for an integrationID and app_id due to other errors: Method: get
Path: /iot/api/v2/apps/{app_id}/integrations/{integrationID}/monitoring/metrics/dispatchFailedMessageCount/otherErrorCount/
Retrieve Lost Message Count for an integrationID and app_id due to read timeout: Method: get
Path: /iot/api/v2/apps/{app_id}/integrations/{integrationID}/monitoring/metrics/dispatchFailedMessageCount/readTimeoutCount/
Retrieve Message Count due to bad gateway: Method: get
Path: /iot/api/v2/monitoring/metrics/dispatchFailedMessageCount/badGatewayCount
Retrieve Message Count due to server error: Method: get
Path: /iot/api/v2/monitoring/metrics/dispatchFailedMessageCount/serverErrorCount
Retrieve Message Count due to Service unavailability: Method: get
Path: /iot/api/v2/monitoring/metrics/dispatchFailedMessageCount/serviceUnavailableCount
Retrieve Message Count for an app_id due to server error: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dispatchFailedMessageCount/serverErrorCount
Retrieve Message Dispatch Latency: Method: get
Path: /iot/api/v2/monitoring/metrics/messageDispatchingLatency
Retrieve Message Dispatch Latency for an app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/messageDispatchingLatency
Retrieve Message Dispatch Latency for an integrationId and app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/integrations/{integrationID}/monitoring/metrics/messageDispatchingLatency/
Retrieve Message Processing Latency: Method: get
Path: /iot/api/v2/monitoring/metrics/messageProcessingLatency
Retrieve Message Processing Latency for an app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/messageProcessingLatency
Retrieve Metric Data: Method: get
Path: /iot/api/v2/monitoring/metrics/{metricName}
Retrieve Number of Authentication Failures due to Bad Tokens: Method: get
Path: /iot/api/v2/monitoring/metrics/authenticationFailureCount/badTokenCount
Retrieve Number of Authentication Failures due to Session Expiry: Method: get
Path: /iot/api/v2/monitoring/metrics/authenticationFailureCount/expiredSessionCount
Retrieve Number of Devices that Failed Authentication: Method: get
Path: /iot/api/v2/monitoring/metrics/authenticationFailureCount/deviceCount
Retrieve Number of Online Devices: Method: get
Path: /iot/api/v2/monitoring/metrics/onlineDeviceCount
Retrieve Processed Message Count: Method: get
Path: /iot/api/v2/monitoring/metrics/processedMessageCount
Retrieve Processed Message Count for an app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/processedMessageCount
Retrieve Retried/Lost Message Count: Method: get
Path: /iot/api/v2/monitoring/metrics/dispatchFailedMessageCount
Retrieve Retried/Lost Message Count for an app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dispatchFailedMessageCount
Retrieve Retried/Lost Message Count for an app_id due to bad gateway: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dispatchFailedMessageCount/badGatewayCount
Retrieve Retried/Lost Message Count for an app_id due to service unavailability: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dispatchFailedMessageCount/serviceUnavailableCount
Retrieve Retried/Lost Message Count for an integrationID and app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/integrations/{integrationID}/monitoring/metrics/dispatchFailedMessageCount/
Retrieve retried/Lost Message Count for an integrationID and app_id due to server error: Method: get
Path: /iot/api/v2/apps/{app_id}/integrations/{integrationID}/monitoring/metrics/dispatchFailedMessageCount/serverErrorCount/
Retrieve Retried/Lost Message Count for an integrationID and app_id due to service unavailibility: Method: get
Path: /iot/api/v2/apps/{app_id}/integrations/{integrationID}/monitoring/metrics/dispatchFailedMessageCount/serviceUnavailableCount/
Retrieve Total Number of Alert Messages: Method: get
Path: /iot/api/v2/monitoring/metrics/alertCount
Retrieve Total Number of Alert Messages for an app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/alertCount
Retrieve Total Number of Authentication Failures: Method: get
Path: /iot/api/v2/monitoring/metrics/authenticationFailureCount
Retrieve Total Number of Inbound Messages: Method: get
Path: /iot/api/v2/monitoring/metrics/messageVolume/inbound
Retrieve Total Number of Inbound Messages for an app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/messageVolume/inbound
Retrieve Total Number of Messages: Method: get
Path: /iot/api/v2/monitoring/metrics/messageVolume
Retrieve Total Number of Messages for an app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/messageVolume
Retrieve Total Number of Outbound Messages: Method: get
Path: /iot/api/v2/monitoring/metrics/messageVolume/outbound
Retrieve Total Number of Outbound Messages for an app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/messageVolume/outbound
Retrieve Total Size of all the Inbound Messages: Method: get
Path: /iot/api/v2/monitoring/metrics/dataVolume/messages/inbound
Retrieve Total Size of all the Inbound Messages for an app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dataVolume/messages/inbound
Retrieve Total Size of all the Messages: Method: get
Path: /iot/api/v2/monitoring/metrics/dataVolume/messages
Retrieve Total Size of all the Messages for an app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dataVolume/messages
Retrieve Total Size of all the Outbound Messages: Method: get
Path: /iot/api/v2/monitoring/metrics/dataVolume/messages/outbound
Retrieve total size of all the Outbound Messages for an app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dataVolume/messages/outbound