Amazon Connect · Example Payload

Amazon Connect Getmetricdata Example

ChatContact CenterCustomer ServiceVoiceAIOmnichannel

Amazon Connect Getmetricdata Example is an example object payload from Amazon Connect, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

{
  "operationId": "getMetricData",
  "method": "POST",
  "path": "/metrics/historical/{InstanceId}",
  "summary": "Amazon Connect Get Historical Metric Data",
  "requestExamples": [
    {
      "contentType": "application/json",
      "name": "GetMetricDataRequestExample",
      "example": {
        "StartTime": "2025-03-15T00:00:00Z",
        "EndTime": "2025-03-15T23:59:59Z",
        "Filters": {
          "Queues": [
            "a1b2c3d4-5678-90ab-cdef-55555EXAMPLE"
          ],
          "Channels": [
            "VOICE"
          ]
        },
        "HistoricalMetrics": [
          {
            "Name": "CONTACTS_QUEUED",
            "Unit": "COUNT",
            "Statistic": "SUM"
          },
          {
            "Name": "HANDLE_TIME",
            "Unit": "SECONDS",
            "Statistic": "AVG"
          }
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "GetMetricData200Example",
      "example": {
        "MetricResults": [
          {
            "Dimensions": {
              "Queue": {
                "Id": "a1b2c3d4-5678-90ab-cdef-55555EXAMPLE",
                "Arn": "arn:aws:connect:us-east-1:123456789012:instance/a1b2c3d4/queue/a1b2c3d4-5678-90ab-cdef-55555EXAMPLE"
              }
            },
            "Collections": [
              {
                "Metric": {
                  "Name": "CONTACTS_QUEUED",
                  "Unit": "COUNT",
                  "Statistic": "SUM"
                },
                "Value": 125.0
              }
            ]
          }
        ]
      }
    }
  ]
}