Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14171791756.1 KB

Gets the real-time active user data from the specified Amazon Connect instance.

post/metrics/userdata/{InstanceId}

Path parameters

InstanceIdstring required

The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.

Query parameters

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

Request body

NextTokenstring

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

MaxResultsinteger

The maximum number of results to return per page.

Response

Success

NextTokenstring

If there are additional results, this is the token for the next set of results.

ApproximateTotalCountinteger

The total count of the result, regardless of the current page size.