Metrics

APIs related to querying tenant metrics.

Get Stream Metrics

Retrieves metrics related to streams ingress and egress rates for a given namespace.

Request

GET api/v1/tenants/{tenantId}/namespaces/{namespaceId}/metrics/streams/{metricId}

Parameters

string tenantId
Tenant identifier

string namespaceId
Namespace identifier

string metricId
Either EgressEvents for events egressed over time, or IngressEvents for incoming events over time

DateTime start
Start date of the metric results to return

DateTime end
End date of the metric results to return

Response

Example response body

200 Response

[
  {
    "Timestamp": "2020-05-15T14:38:55.989531-07:00",
    "Value": 0.0
  },
  {
    "Timestamp": "2020-05-15T14:38:55.9925501-07:00",
    "Value": 0.0
  }
]

Get OMF Connection Metrics

Retrieves metrics related to OMF ingress rates for a given namespace.

Request

GET api/v1/tenants/{tenantId}/namespaces/{namespaceId}/metrics/topics/{metricId}

Parameters

string tenantId
Tenant identifier

string namespaceId
Namespace identifier

string metricId
Either MessagesReceived for received messages over time, or MessagesRejected for rejected messages over time

DateTime start
Start date of the metric results to return

DateTime end
End date of the metric results to return

Response

Example response body

200 Response

[
  {
    "Timestamp": "2020-05-15T14:38:55.989531-07:00",
    "Value": 0.0
  },
  {
    "Timestamp": "2020-05-15T14:38:55.9925501-07:00",
    "Value": 0.0
  }
]

Authorization

Allowed for these roles:

• Tenant Member
• Tenant Administrator

ErrorResponse

Object used to represent error information.

Properties

{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string"
}