Skip to main content

IAI Get an Identity Outlier's Contibuting Features

This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object Requires authorization scope of 'iai:outliers-management:read'

Path Parameters
  • outlierId string required

    The outlier id

    Example: 2c918085842e69ae018432d22ccb212f
Query Parameters
  • limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
  • offset int32

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

  • count boolean

    If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

    Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

    See V3 API Standard Collection Parameters for more information.

    Example: true
  • include-translation-messages string

    Whether or not to include translation messages object in returned response

  • sorters comma-separated

    Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: importance

Responses

Succeeded. Returns list of objects. Each object contains a feature and metadata about that feature

Response Headers
  • X-Total-Count integer

    The total result count.

  • accept-language string

    The locale to use for translations for displayName and description text


Schema array
  • name string

    The name of the feature

  • valueType string

    Possible values: [INTEGER, FLOAT]

    The data type of the value field

  • value object

    The feature value

    oneOf

  • number float

    Possible values: <= 1

  • importance float

    Possible values: >= -1 and <= 1

    The importance of the feature. This can also be a negative value

  • displayName string

    The (translated if header is passed) displayName for the feature

  • description string

    The (translated if header is passed) description for the feature

  • translationMessages object
  • displayName
  • key string

    The key of the translation message

  • values string[]

    The values corresponding to the translation messages

  • description
  • key string

    The key of the translation message

  • values string[]

    The values corresponding to the translation messages

Loading...