Engine API Reference

The Prelert Behavioral Analytics Engine API ® is a RESTful interface to create analytic jobs, upload data to those jobs, and persist the results in a queryable data store.

The Engine API is modeled around the concept of jobs where each job encapsulates the analytics task, the configuration for that task and the results of the analytics. Jobs have a configuration that once created cannot be modified with the exception of some properties that can be updated via the Update Job Configuration endpoint. Each job has a unique identifier that must be used in all job related actions including uploading data and querying results.