Jump to

• Request
• Response

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

Supported Media Types

• application/json; charset=utf-8

Query Parameters

• frequency(optional): 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

• q(optional): 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.

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8

200 Response

Successful operation

Body ()

Root Schema : HistoryItemsRs

Type: object

Show Source

• id(optional): string
• links(optional): array links
• listSize(optional): integer(int32)
• records(optional): array records

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "id":{
            "type":"string"
        },
        "records":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/HistoryItemRs"
            }
        },
        "listSize":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SuiteLink"
    }
}

Nested Schema : records

Type: array

Show Source

• Array of: object HistoryItemRs

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/HistoryItemRs"
    }
}

Nested Schema : SuiteLink

Type: object

Show Source

• href(optional): string
• mediaType(optional): string
• rel(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

Nested Schema : HistoryItemRs

Type: object

Show Source

• endTime(optional): string
• failedMessages(optional): integer(int64)
• inflightMessages(optional): integer(int64)
• startTime(optional): string
• successfulMessages(optional): integer(int64)
• successRate(optional): number(double)
• totalMessagesCreated(optional): integer(int64)
• totalMessagesProcessed(optional): integer(int64)
• totalMessagesReceived(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "startTime":{
            "type":"string"
        },
        "endTime":{
            "type":"string"
        },
        "totalMessagesCreated":{
            "type":"integer",
            "format":"int64"
        },
        "totalMessagesReceived":{
            "type":"integer",
            "format":"int64"
        },
        "totalMessagesProcessed":{
            "type":"integer",
            "format":"int64"
        },
        "successfulMessages":{
            "type":"integer",
            "format":"int64"
        },
        "failedMessages":{
            "type":"integer",
            "format":"int64"
        },
        "inflightMessages":{
            "type":"integer",
            "format":"int64"
        },
        "successRate":{
            "type":"number",
            "format":"double"
        }
    }
}

400 Response

Malformed parameters

500 Response

Server error

Back to Top