Own AWS? Customize your docs with AI search, analytics, and more.

POST

/metrics/userdata/{InstanceId}

http://connect.{region}.amazonaws.com/metrics/userdata/{InstanceId}

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

Access Token Required: API Key

Path Parameters

InstanceIdstringrequired

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 Params

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

Body Params

Filtersobjectrequired

A filter for the user data.

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.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://connect.{region}.amazonaws.com/metrics/userdata/{InstanceId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

/metrics/userdata/{InstanceId}

http://connect.{region}.amazonaws.com/metrics/userdata/{InstanceId}

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

Access Token Required: API Key

Path Parameters

InstanceIdstringrequired

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 Params

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

Body Params

Filtersobjectrequired

A filter for the user data.

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.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://connect.{region}.amazonaws.com/metrics/userdata/{InstanceId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

/metrics/userdata/{InstanceId}

http://connect.{region}.amazonaws.com/metrics/userdata/{InstanceId}

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

Access Token Required: API Key

Path Parameters

InstanceIdstringrequired

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 Params

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

Body Params

Filtersobjectrequired

A filter for the user data.

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.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://connect.{region}.amazonaws.com/metrics/userdata/{InstanceId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

/metrics/userdata/{InstanceId}

http://connect.{region}.amazonaws.com/metrics/userdata/{InstanceId}

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

Access Token Required: API Key

Path Parameters

InstanceIdstringrequired

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 Params

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

Body Params

Filtersobjectrequired

A filter for the user data.

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.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://connect.{region}.amazonaws.com/metrics/userdata/{InstanceId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}