Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetObjectTypeAttributeStatistics

The GetObjectTypeAttributeValues API delivers statistical insights about attributes within a specific object type, but is exclusively available for domains with data store enabled. This API performs daily calculations to provide statistical information about your attribute values, helping you understand patterns and trends in your data. The statistical calculations are performed once per day, providing a consistent snapshot of your attribute data characteristics.

Note

You'll receive null values in two scenarios:

During the first period after enabling data vault (unless a calculation cycle occurs, which happens once daily).

For attributes that don't contain numeric values.

Request Syntax


POST /domains/DomainName/object-types/ObjectTypeName/attributes/AttributeName/statistics HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AttributeName

The attribute name.

Length Constraints: Minimum length of 1. Maximum length of 1000.

Required: Yes

DomainName

The unique name of the domain.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

ObjectTypeName

The unique name of the domain object type.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z_][a-zA-Z_0-9-]*$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CalculatedAt": number,
   "Statistics": { 
      "Average": number,
      "Maximum": number,
      "Minimum": number,
      "Percentiles": { 
         "P25": number,
         "P5": number,
         "P50": number,
         "P75": number,
         "P95": number
      },
      "StandardDeviation": number
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CalculatedAt

Time when this statistics was calculated.

Type: Timestamp

Statistics

The statistics.

Type: GetObjectTypeAttributeStatisticsStats object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

InternalServerException

An internal service error occurred.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 404

ThrottlingException

You exceeded the maximum number of requests.

HTTP Status Code: 429