CustomerProfiles / Client / get_object_type_attribute_statistics

get_object_type_attribute_statistics

CustomerProfiles.Client.get_object_type_attribute_statistics(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.get_object_type_attribute_statistics(
    DomainName='string',
    ObjectTypeName='string',
    AttributeName='string'
)

Parameters:

• DomainName (string) –

  [REQUIRED]

  The unique name of the domain.

• ObjectTypeName (string) –

  [REQUIRED]

  The unique name of the domain object type.

• AttributeName (string) –

  [REQUIRED]

  The attribute name.

Return type:

dict

Returns:

Response Syntax

{
    'Statistics': {
        'Maximum': 123.0,
        'Minimum': 123.0,
        'Average': 123.0,
        'StandardDeviation': 123.0,
        'Percentiles': {
            'P5': 123.0,
            'P25': 123.0,
            'P50': 123.0,
            'P75': 123.0,
            'P95': 123.0
        }
    },
    'CalculatedAt': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • Statistics (dict) –

    The statistics.

    • Maximum (float) –

      The maximum value found in the attribute dataset.

    • Minimum (float) –

      The minimum value found in the attribute dataset.

    • Average (float) –

      The arithmetic mean of the attribute values.

    • StandardDeviation (float) –

      The standard deviation of the attribute values, measuring their spread around the mean.

    • Percentiles (dict) –

      Percentile distribution statistics for the attribute values.

      • P5 (float) –

        The 5th percentile value of the attribute.

      • P25 (float) –

        The 25th percentile value of the attribute.

      • P50 (float) –

        The 50th percentile (median) value of the attribute.

      • P75 (float) –

        The 75th percentile value of the attribute.

      • P95 (float) –

        The 95th percentile value of the attribute.

  • CalculatedAt (datetime) –

    Time when this statistics was calculated.

Exceptions

• CustomerProfiles.Client.exceptions.BadRequestException

• CustomerProfiles.Client.exceptions.ResourceNotFoundException

• CustomerProfiles.Client.exceptions.AccessDeniedException

• CustomerProfiles.Client.exceptions.ThrottlingException

• CustomerProfiles.Client.exceptions.InternalServerException