Limited access

This feature is only available to root and super_admin_domain profiles. Ask your administrator for proper user role profiling.

Analytic tasks

An analytic task is a JSON document that describes an analysis over your stored data. The platform turns that document into the query it runs against the data store, so the task is a declaration of what to compute rather than code you write. Some of its fields are mandatory.

Where analytics actually happens

Analytics in OpenGate spans more than this API, and the working documentation lives elsewhere:

To Go to
Write and run analysis interactively, in Jupyter Lab Analytics and Datalab
Read and write platform data from Python The opengate-data library, in OpenGate Libraries
Run a notebook unattended, once or on a schedule Notebook scheduler
Query stored data directly over REST What you can query
Configure the platform’s AI settings The Analytics section of the web console

If you are looking for how to analyse your data, the Datalab how-to and the notebook scheduler are the practical route. This page covers only the analytic task API object.

Specification not currently published

The API specification for analytic tasks is not shipped with the documentation at the moment, so the endpoint reference is unavailable here. Ask your platform contact for the endpoint details in the meantime.