Get a Bucket

Description

Access a single bucket.

Definition

http://localhost:8080/engine/v2/results/<jobId>/buckets/<timestamp>
jobId:The unique identifier of the job.
timestamp:The timestamp in seconds from the Epoch of the bucket of interest.

Parameters

expand:Include anomaly records, see Include Anomaly Records in bucket.
includeInterim:Include interim results, see Include Interim Results.

Method

GET

Returns

A JSON formatted document containing the results for the bucket of interest. For example, a JSON response will take the form:

{
  "exists" : true,
  "type" : "bucket",
  "document" : {
    "timestamp" : "2014-01-08T08:00:00.000+0000",
    "bucketSpan" : 3600,
    "maxNormalizedProbability" : 100.0,
    "anomalyScore" : 100.0,
    "eventCount" : 439,
    "recordCount" : 1,
    "bucketInfluencers": [ {
      "probability": 4.2533E-203,
      "influencerFieldName": "bucketTime",
      "anomalyScore": 100.0
    } ]
  }
}

For a detailed description of the output see Bucket Resource.

Include Anomaly Records in bucket

Add the ?expand=true query parameter to nest the anomaly records inside the bucket under the records field.

http://localhost:8080/engine/v2/results/<jobId>/buckets/<timestamp>?expand=true

The default is not to include records.

Include Interim Results

Add the ?includeInterim=true query parameter to include interim results as well as final results.

http://localhost:8080/engine/v2/results/<jobId>/buckets/<timestamp>?includeInterim=true

The default is not to include interim results.

Errors

See the Error Codes documentation for the full list of errors that may be returned by the API.

NOTES

You can add the ?expand=true query string extension to embed the anomaly records so that you don’t have to make a subsequent request to the records endpoint.