Path parameters

  • job_idstring Required

    Identifier for the anomaly detection job.

Query parameters

  • descboolean

    If true, the results are sorted in descending order.

  • endstring | number

    Returns influencers with timestamps earlier than this time. The default value means it is unset and results are not limited to specific timestamps.

  • exclude_interimboolean

    If true, the output excludes interim results. By default, interim results are included.

  • influencer_scorenumber

    Returns influencers with anomaly scores greater than or equal to this value.

  • fromnumber

    Skips the specified number of influencers.

  • sizenumber

    Specifies the maximum number of influencers to obtain.

  • sortstring

    Specifies the sort field for the requested influencers. By default, the influencers are sorted by the influencer_score value.

  • startstring | number

    Returns influencers with timestamps after this time. The default value means it is unset and results are not limited to specific timestamps.

application/json

Body

  • pageobject
    Hide page attributes Show page attributes object
    • fromnumber

      Skips the specified number of items.

    • sizenumber

      Specifies the maximum number of items to obtain.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • countnumber Required
    • influencersarray[object] Required

      Array of influencer objects

      Hide influencers attributes Show influencers attributes object
      • bucket_spannumber

        Time unit for seconds

      • influencer_scorenumber Required

        A normalized score between 0-100, which is based on the probability of the influencer in this bucket aggregated across detectors. Unlike initial_influencer_score, this value is updated by a re-normalization process as new data is analyzed.

      • influencer_field_namestring Required

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • influencer_field_valuestring Required

        The entity that influenced, contributed to, or was to blame for the anomaly.

      • initial_influencer_scorenumber Required

        A normalized score between 0-100, which is based on the probability of the influencer aggregated across detectors. This is the initial value that was calculated at the time the bucket was processed.

      • is_interimboolean Required

        If true, this is an interim result. In other words, the results are calculated based on partial input data.

      • job_idstring Required
      • probabilitynumber Required

        The probability that the influencer has this behavior, in the range 0 to 1. This value can be held to a high precision of over 300 decimal places, so the influencer_score is provided as a human-readable and friendly interpretation of this value.

      • result_typestring Required

        Internal. This value is always set to influencer.

      • timestampnumber

        Time unit for milliseconds

      • foostring

        Additional influencer properties are added, depending on the fields being analyzed. For example, if it’s analyzing user_name as an influencer, a field user_name is added to the result document. This information enables you to filter the anomaly results more easily.

GET /_ml/anomaly_detectors/{job_id}/results/influencers
curl \
 --request GET 'http://api.example.com/_ml/anomaly_detectors/{job_id}/results/influencers' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"page":{"from":42.0,"size":42.0}}'