Get Object Type Attribute Statistics

customerprofiles_get_object_type_attribute_statistics

R Documentation

The GetObjectTypeAttributeValues API delivers statistical insights about attributes within a specific object type, but is exclusively available for domains with data store enabled¶

Description¶

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.

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.

Usage¶

customerprofiles_get_object_type_attribute_statistics(DomainName,
  ObjectTypeName, AttributeName)

Arguments¶

DomainName

[required] The unique name of the domain.

ObjectTypeName

[required] The unique name of the domain object type.

AttributeName

[required] The attribute name.

Value¶

A list with the following syntax:

list(
  Statistics = list(
    Maximum = 123.0,
    Minimum = 123.0,
    Average = 123.0,
    StandardDeviation = 123.0,
    Percentiles = list(
      P5 = 123.0,
      P25 = 123.0,
      P50 = 123.0,
      P75 = 123.0,
      P95 = 123.0
    )
  ),
  CalculatedAt = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax¶

svc$get_object_type_attribute_statistics(
  DomainName = "string",
  ObjectTypeName = "string",
  AttributeName = "string"
)