Module Values_1.GetContactMetricsResponseSource

Retrieves contact metric data for a specified contact. Use cases Following are common use cases for position in queue and estimated wait time: Customer-Facing Wait Time Announcements - Display or announce the estimated wait time and position in queue to customers before or during their queue experience. Callback Offerings - Offer customers a callback option when the estimated wait time or position in queue exceeds a defined threshold. Queue Routing Decisions - Route incoming contacts to less congested queues by comparing estimated wait time and position in queue across multiple queues. Self-Service Deflection - Redirect customers to self-service options like chatbots or FAQs when estimated wait time is high or position in queue is unfavorable. Important things to know Metrics are only available while the contact is actively in queue. For more information, see the Position in queue metric in the Amazon Connect Administrator Guide. Endpoints: See Amazon Connect endpoints and quotas.

Sourcetype nonrec t = {
  1. metricResults : Values_0.ContactMetricResults.t option;
    (*

    A list of metric results containing the calculated values for each requested metric. Each result includes the metric name and its corresponding value. For example, POSITION_IN_QUEUE returns a numeric value representing the contact's position in queue, and ESTIMATED_WAIT_TIME returns the predicted wait time in seconds.

    *)
  2. id : Values_0.ContactId.t option;
    (*

    The unique identifier of the contact for which metrics were retrieved. This matches the ContactId provided in the request.

    *)
  3. arn : Values_0.ARN.t option;
    (*

    The ARN of the contact for which metrics were retrieved.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of Values_0.AccessDeniedException.t
  2. | `InternalServiceException of Values_0.InternalServiceException.t
  3. | `InvalidParameterException of Values_0.InvalidParameterException.t
  4. | `InvalidRequestException of Values_0.InvalidRequestException.t
  5. | `ResourceNotFoundException of Values_0.ResourceNotFoundException.t
  6. | `ThrottlingException of Values_0.ThrottlingException.t
  7. | `Unknown_operation_error of string * string option
]
Sourceval make : ?metricResults:??? -> ?id:??? -> ?arn:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of Values_0.AccessDeniedException.t | `InternalServiceException of Values_0.InternalServiceException.t | `InvalidParameterException of Values_0.InvalidParameterException.t | `InvalidRequestException of Values_0.InvalidRequestException.t | `ResourceNotFoundException of Values_0.ResourceNotFoundException.t | `ThrottlingException of Values_0.ThrottlingException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of Values_0.AccessDeniedException.t | `InternalServiceException of Values_0.InternalServiceException.t | `InvalidParameterException of Values_0.InvalidParameterException.t | `InvalidRequestException of Values_0.InvalidRequestException.t | `ResourceNotFoundException of Values_0.ResourceNotFoundException.t | `ThrottlingException of Values_0.ThrottlingException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `List of [> `Structure of (string * [> `Enum of string | `Structure of (string * [> `Double of float ]) list ]) list ] list | `String of Values_0.ContactId.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t