Amazon Connect · JSON Structure

Get Metric Data Request Structure

GetMetricDataRequest schema from Amazon Connect Service API

Type: object Properties: 7 Required: 4
ChatContact CenterCustomer ServiceVoiceAIOmnichannel

GetMetricDataRequest is a JSON Structure definition published by Amazon Connect, describing 7 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

StartTime EndTime Filters Groupings HistoricalMetrics NextToken MaxResults

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-connect/refs/heads/main/json-structure/get-metric-data-request-structure.json",
  "name": "GetMetricDataRequest",
  "description": "GetMetricDataRequest schema from Amazon Connect Service API",
  "type": "object",
  "properties": {
    "StartTime": {
      "type": "datetime",
      "description": "The timestamp, in UNIX Epoch time format, at which to start the reporting interval.",
      "example": "2025-03-15T00:00:00Z"
    },
    "EndTime": {
      "type": "datetime",
      "description": "The timestamp, in UNIX Epoch time format, at which to end the reporting interval.",
      "example": "2025-03-15T23:59:59Z"
    },
    "Filters": {
      "type": "object",
      "description": "The queues, up to 100, or channels, to use to filter the metrics returned.",
      "properties": {
        "Queues": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "Channels": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "VOICE",
              "CHAT",
              "TASK"
            ]
          }
        }
      }
    },
    "Groupings": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "QUEUE",
          "CHANNEL",
          "ROUTING_PROFILE",
          "ROUTING_STEP_EXPRESSION"
        ]
      }
    },
    "HistoricalMetrics": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "Name": {
            "type": "string",
            "description": "The name of the metric.",
            "enum": [
              "CONTACTS_QUEUED",
              "CONTACTS_HANDLED",
              "CONTACTS_ABANDONED",
              "CONTACTS_CONSULTED",
              "CONTACTS_AGENT_HUNG_UP_FIRST",
              "CONTACTS_HANDLED_INCOMING",
              "CONTACTS_HANDLED_OUTBOUND",
              "CONTACTS_HOLD_ABANDONS",
              "CONTACTS_TRANSFERRED_IN",
              "CONTACTS_TRANSFERRED_OUT",
              "CONTACTS_TRANSFERRED_IN_FROM_QUEUE",
              "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE",
              "CONTACTS_MISSED",
              "CALLBACK_CONTACTS_HANDLED",
              "HANDLE_TIME",
              "AFTER_CONTACT_WORK_TIME",
              "QUEUED_TIME",
              "ABANDON_TIME",
              "QUEUE_ANSWER_TIME",
              "HOLD_TIME",
              "INTERACTION_TIME",
              "INTERACTION_AND_HOLD_TIME",
              "SERVICE_LEVEL"
            ]
          },
          "Unit": {
            "type": "string",
            "enum": [
              "SECONDS",
              "COUNT",
              "PERCENT"
            ]
          },
          "Statistic": {
            "type": "string",
            "enum": [
              "SUM",
              "MAX",
              "AVG"
            ]
          }
        }
      }
    },
    "NextToken": {
      "type": "string"
    },
    "MaxResults": {
      "type": "int32"
    }
  },
  "required": [
    "EndTime",
    "Filters",
    "HistoricalMetrics",
    "StartTime"
  ]
}