Jump to

• Request
• Response
• Examples

Retrieve Historical Tracking Metrics

get

/ic/api/integration/v1/monitoring/history

This API fetches historical tracking metrics. These are the metrics collected since the environment was created.

Request

Query Parameters

• frequency: string

  Time frequency by which the metrics are to be grouped by. Valid values: hourly and daily.

  Example:

  Retrieves hourly metrics for past 24 hours.

  /history?frequency=hourly

  Retrieves daily metrics for past 30 days.

  /history?frequency=daily

• integrationInstance(required): string
  This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.
• q: string

  Filter parameter.

  • timewindow: 1h, 6h, 1d, 2d, 3d, RETENTIONPERIOD.
  • startdate: Custom time range start date/time in UTC format for filtering metrics. If the start date is not mentioned and end date is specified, then it considers 30 days before the end date as the start date.
  • enddate: Custom time range end date/time in UTC format for filtering metrics. If the end date is not mentioned and start date is specified, then it considers current date as the end date.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8

200 Response

Successful operation

Body ()

Root Schema : HistoryItemsRs

Type: object

Show Source

• records: array records
  List of History Items

{
    "type":"object",
    "properties":{
        "records":{
            "type":"array",
            "description":"List of History Items",
            "items":{
                "$ref":"#/components/schemas/HistoryItemRs"
            }
        }
    }
}

Nested Schema : records

Type: array

List of History Items

Show Source

• Array of: object HistoryItemRs

{
    "type":"array",
    "description":"List of History Items",
    "items":{
        "$ref":"#/components/schemas/HistoryItemRs"
    }
}

Nested Schema : HistoryItemRs

Type: object

Show Source

• aborted-messages: integer (int64)
  Aborted Messages
• audit-instances-count: integer (int64)
  Audit Instances Count
• debug-instances-count: integer (int64)
  Debug Instances Count
• end-time: string
  End Time
• failed-messages: integer (int64)
  Failed Messages
• inflight-messages: integer (int64)
  Inflight Messages
• production-instances-count: integer (int64)
  Production Instances Count
• start-time: string
  Start Time
• success-rate: number (double)
• successful-messages: integer (int64)
  Successful Messages
• total-instances-by-updated-time: integer (int64)
  Total Instances By UpdatedTime
• total-messages-created: integer (int64)
  Total Messages Created
• total-messages-processed: integer (int64)
  Total Messages Processed
• total-messages-received: integer (int64)
  Total Messages Received

{
    "type":"object",
    "properties":{
        "total-instances-by-updated-time":{
            "type":"integer",
            "description":"Total Instances By UpdatedTime",
            "format":"int64"
        },
        "audit-instances-count":{
            "type":"integer",
            "description":"Audit Instances Count",
            "format":"int64"
        },
        "production-instances-count":{
            "type":"integer",
            "description":"Production Instances Count",
            "format":"int64"
        },
        "debug-instances-count":{
            "type":"integer",
            "description":"Debug Instances Count",
            "format":"int64"
        },
        "start-time":{
            "type":"string",
            "description":"Start Time"
        },
        "end-time":{
            "type":"string",
            "description":"End Time"
        },
        "total-messages-created":{
            "type":"integer",
            "description":"Total Messages Created",
            "format":"int64"
        },
        "total-messages-received":{
            "type":"integer",
            "description":"Total Messages Received",
            "format":"int64"
        },
        "total-messages-processed":{
            "type":"integer",
            "description":"Total Messages Processed",
            "format":"int64"
        },
        "aborted-messages":{
            "type":"integer",
            "description":"Aborted Messages",
            "format":"int64"
        },
        "successful-messages":{
            "type":"integer",
            "description":"Successful Messages",
            "format":"int64"
        },
        "failed-messages":{
            "type":"integer",
            "description":"Failed Messages",
            "format":"int64"
        },
        "inflight-messages":{
            "type":"integer",
            "description":"Inflight Messages",
            "format":"int64"
        },
        "success-rate":{
            "type":"number",
            "format":"double"
        }
    }
}

400 Response

Malformed parameters

500 Response

Server error

Back to Top

Examples

The following example shows how to retrieve historical tracking metrics by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. For more information about endpoint URL structure, see Send Requests.

Example: Retrieve Historical Tracking Metrics

Request:

curl -X GET -H 'Authorization: Bearer access_token' -H "Content-Type:application/json" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/history?frequency=hourly?integrationInstance=service-instance

Back to Top