Skip to main content

events

POST /events.add

Description

Adds a single event

Parameters

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
allow_locked
optional
Allow adding events to published tasks or models
Default : false
boolean
model_event
optional
If set then the event is for a model. Otherwise for a task. Cannot be used with
task log events. If used in batch then all the events should be marked the same
Default : false
boolean

Responses

HTTP CodeSchema
200object

POST /events.add_batch

Description

Adds a batch of events in a single call (json-lines format, stream-friendly)

Parameters

TypeNameDescriptionSchema
Bodyrequests
required
Json encoded newline-terminated lines, each representing an event in the batch and uses the same parameters used for events.add< object > array

Responses

HTTP CodeSchema
200Response 200

Response 200

NameSchema
added
optional
integer
errors
optional
integer
errors_info
optional
object

POST /events.clear_scroll

Description

Clear an open Scroll ID

Parameters

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
scroll_id
required
Scroll ID as returned by previous events service callsstring

Responses

HTTP CodeSchema
200object

POST /events.clear_task_log

Description

Remove old logs from task

Parameters

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
allow_locked
optional
Allow deleting events even if the task is locked
Default : false
boolean
task
required
Task IDstring
threshold_sec
optional
The amount of seconds ago to retain the log records. The older log records will
be deleted. If not passed or 0 then all the log records for the task will be
deleted
integer

Responses

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
deleted
optional
The number of deleted log recordsinteger

POST /events.debug_images

Description

Get the debug image events for the requested amount of iterations per each task

Parameters

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
iters
optional
Max number of latest iterations for which to return debug imagesinteger
metrics
required
List of metrics and variants< events.task_metric_variants > array
model_events
optional
If set then the retrieving model events. Otherwise task events
Default : false
boolean
navigate_earlier
optional
If set then events are retreived from latest iterations to earliest ones.
Otherwise from earliest iterations to the latest. The default is True
boolean
refresh
optional
If set then scroll will be moved to the latest iterations. The default is Falseboolean
scroll_id
optional
Scroll ID of previous call (used for getting more results)string

Responses

HTTP CodeSchema
200events.debug_images_response

POST /events.delete_for_model

Description

Delete all model events. This cannot be undone!

Parameters

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
allow_locked
optional
Allow deleting events even if the model is locked
Default : false
boolean
model
required
Model IDstring

Responses

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
deleted
optional
Number of deleted eventsboolean

POST /events.delete_for_task

Description

Delete all task events. This cannot be undone!

Parameters

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
allow_locked
optional
Allow deleting events even if the task is locked
Default : false
boolean
task
required
Task IDstring

Responses

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
deleted
optional
Number of deleted eventsboolean

POST /events.download_task_log

Description

Get an attachment containing the task's log

Parameters

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
line_format
optional
Line string format. Used if the line type is 'text'
Default : "{asctime} {worker} {level} {msg}"
string
line_type
optional
Line format typeenum (json, text)
task
required
Task IDstring

Responses

HTTP CodeSchema
200string

POST /events.get_debug_image_sample

Description

Return the debug image per metric and variant for the provided iteration

Parameters

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
iteration
optional
The iteration to bring debug image from. If not specified then the latest
reported image is retrieved
integer
metric
required
Metric namestring
model_events
optional
If set then the retrieving model debug images. Otherwise task debug images
Default : false
boolean
navigate_current_metric
optional
If set then subsequent navigation with next_debug_image_sample is done on the
debug images for the passed metric only. Otherwise for all the metrics
Default : true
boolean
refresh
optional
If set then scroll state will be refreshed to reflect the latest changes in the
debug images
boolean
scroll_id
optional
Scroll ID from the previous call to get_debug_image_sample or emptystring
task
required
Task IDstring
variant
required
Metric variantstring

Responses

HTTP CodeSchema
200events.debug_image_sample_response

POST /events.get_multi_task_metrics

Description

Get unique metrics and variants from the events of the specified type. Only
events reported for the passed task or model ids are analyzed.

Parameters

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
event_type
optional
Event type. If not specified then metrics are collected from the reported
events of all types
events.event_type_enum
model_events
optional
If not set or set to Falsethen passed ids are task ids otherwise model ids
Default : false
boolean
tasks
required
task ids to get metrics from< string > array

Responses

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
metrics
optional
List of metrics and variants< events.metric_variants > array

POST /events.get_multi_task_plots

Description

Get 'plot' events for the given tasks

Parameters

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
iters
optional
Max number of latest iterations for which to return plotsinteger
last_iters_per_task_metric
optional
If set to 'true' and iters passed then last iterations for each task metrics
are retrieved. Otherwise last iterations for the whole task are retrieved
Default : true
boolean
metrics
optional
List of metrics and variants< events.metric_variants > array
model_events
optional
If set then the retrieving model events. Otherwise task events
Default : false
boolean
no_scroll
optional
If Truethen no scroll is created. Suitable for one time calls
Default : false
boolean
scroll_id
optional
Scroll ID of previous call (used for getting more results)string
tasks
required
List of task IDs< string > array

Responses

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
plots
optional
Plots mapping (keyed by task name)object
returned
optional
Number of results returnedinteger
scroll_id
optional
Scroll ID for getting more resultsstring
total
optional
Total number of results available for this query. In case there are more than
10000 results it is set to 10000
number

POST /events.get_plot_sample

Description

Return plots for the provided iteration

Parameters

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
iteration
optional
The iteration to bring plot from. If not specified then the latest reported
plot is retrieved
integer
metric
required
Metric namestring
model_events
optional
If set then the retrieving model plots. Otherwise task plots
Default : false
boolean
navigate_current_metric
optional
If set then subsequent navigation with next_plot_sample is done on the plots
for the passed metric only. Otherwise for all the metrics
Default : true
boolean
refresh
optional
If set then scroll state will be refreshed to reflect the latest changes in the
plots
boolean
scroll_id
optional
Scroll ID from the previous call to get_plot_sample or emptystring
task
required
Task IDstring

Responses

HTTP CodeSchema
200events.plot_sample_response

POST /events.get_scalar_metric_data

Description

get scalar metric data for task

Parameters

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
metric
optional
type of metricstring
model_events
optional
If set then the retrieving model events. Otherwise task events
Default : false
boolean
no_scroll
optional
If Truethen no scroll is created. Suitable for one time calls
Default : false
boolean
scroll_id
optional
Scroll ID of previous call (used for getting more results)string
task
optional
task IDstring

Responses

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
events
optional
task scalar metric events< object > array
returned
optional
amount of events returnedinteger
scroll_id
optional
Scroll ID for getting more resultsstring
total
optional
amount of events in taskinteger

POST /events.get_scalar_metrics_and_variants

Description

get task scalar metrics and variants

Parameters

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
model_events
optional
If set then the retrieving model events. Otherwise task events
Default : false
boolean
task
required
task IDstring

Responses

HTTP CodeSchema
200Response 200

Response 200

NameSchema
metrics
optional
object

POST /events.get_task_events

Description

Scroll through task events, sorted by timestamp

Parameters

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
batch_size
optional
Number of events to return each time (default 500)integer
event_type
optional
Return only events of this typestring
metrics
optional
List of metrics and variants< events.metric_variants > array
model_events
optional
If set then get retrieving model events. Otherwise task events
Default : false
boolean
order
optional
'asc' (default) or 'desc'.enum (asc, desc)
scroll_id
optional
Pass this value on next call to get next pagestring
task
required
Task IDstring

Responses

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
events
optional
Events list< object > array
returned
optional
Number of results returnedinteger
scroll_id
optional
Scroll ID for getting more resultsstring
total
optional
Total number of results available for this query. In case there are more than
10000 results it is set to 10000
number

POST /events.get_task_latest_scalar_values

Description

Get the tasks's latest scalar values

Parameters

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
task
required
Task IDstring

Responses

HTTP CodeSchema
200Response 200

Response 200

NameSchema
metrics
optional
< metrics > array

metrics

NameDescriptionSchema
name
optional
Metric namestring
variants
optional
< variants > array

variants

NameDescriptionSchema
last_100_value
optional
Average of 100 last reported valuesnumber
last_value
optional
Last reported valuenumber
name
optional
Variant namestring

POST /events.get_task_log

Description

Get 'log' events for this task

Parameters

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
batch_size
optional
The amount of log events to returninteger
from_timestamp
optional
Epoch time in UTC ms to use as the navigation start. Optional. If not provided,
reference timestamp is determined by the 'navigate_earlier' parameter (if true,
reference timestamp is the last timestamp and if false, reference timestamp is
the first timestamp)
number
navigate_earlier
optional
If set then log events are retreived from the latest to the earliest ones (in
timestamp descending order, unless order='asc'). Otherwise from the earliest to
the latest ones (in timestamp ascending order, unless order='desc'). The
default is True
boolean
order
optional
If set, changes the order in which log events are returned based on the value
of 'navigate_earlier'
enum (asc, desc)
task
required
Task IDstring

Responses

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
events
optional
Log items list< object > array
returned
optional
Number of log events returnedinteger
total
optional
Total number of log events available for this query. In case there are more
than 10000 events it is set to 10000
number

POST /events.get_task_metrics

Description

For each task, get a list of metrics for which the requested event type was
reported

Parameters

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
event_type
optional
Event typeevents.event_type_enum
model_events
optional
If set then get metrics from model events. Otherwise from task events
Default : false
boolean
tasks
required
Task IDs< string > array

Responses

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
metrics
optional
List of task with their metrics< object > array

POST /events.get_task_plots

Description

Get all 'plot' events for this task

Parameters

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
iters
optional
Max number of latest iterations for which to return plotsinteger
metrics
optional
List of metrics and variants< events.metric_variants > array
model_events
optional
If set then the retrieving model events. Otherwise task events
Default : false
boolean
no_scroll
optional
If Truethen no scroll is created. Suitable for one time calls
Default : false
boolean
scroll_id
optional
Scroll ID of previous call (used for getting more results)string
task
required
Task IDstring

Responses

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
plots
optional
Plots list< object > array
returned
optional
Number of results returnedinteger
scroll_id
optional
Scroll ID for getting more resultsstring
total
optional
Total number of results available for this query. In case there are more than
10000 results it is set to 10000
number

POST /events.get_task_single_value_metrics

Description

Get single value metrics for the passed tasks

Parameters

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
metrics
optional
List of metrics and variants< events.metric_variants > array
model_events
optional
If set then the retrieving model events. Otherwise task events
Default : false
boolean
tasks
required
List of task Task IDs< string > array

Responses

HTTP CodeSchema
200events.single_value_metrics_response

POST /events.get_vector_metrics_and_variants

Parameters

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
model_events
optional
If set then the retrieving model events. Otherwise task events
Default : false
boolean
task
required
Task IDstring

Responses

HTTP CodeSchema
200Response 200

Response 200

NameSchema
metrics
optional
< object > array

POST /events.multi_task_scalar_metrics_iter_histogram

Description

Used to compare scalar stats histogram of multiple tasks

Parameters

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
key
optional
Histogram x axis to use: iter - iteration number iso_time - event time as ISO
formatted string timestamp - event timestamp as milliseconds since epoch
events.scalar_key_enum
metrics
optional
List of metrics and variants< events.metric_variants > array
model_events
optional
If set then the retrieving model events. Otherwise task events
Default : false
boolean
samples
optional
The amount of histogram points to return. Optional, the default value is 6000integer
tasks
required
List of task Task IDs. Maximum amount of tasks is 100< string > array

Responses

HTTP CodeSchema
200object

POST /events.next_debug_image_sample

Description

Get the image for the next variant for the same iteration or for the next
iteration

Parameters

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
model_events
optional
If set then the retrieving model debug images. Otherwise task debug images
Default : false
boolean
navigate_earlier
optional
If set then get the either previous variant event from the current iteration or
(if does not exist) the last variant event from the previous iteration.
Otherwise next variant event from the current iteration or first variant event
from the next iteration
boolean
next_iteration
optional
If set then navigate to the next/previous iteration
Default : false
boolean
scroll_id
required
Scroll ID from the previous call to get_debug_image_samplestring
task
required
Task IDstring

Responses

HTTP CodeSchema
200events.debug_image_sample_response

POST /events.next_plot_sample

Description

Get the plot for the next metric for the same iteration or for the next
iteration

Parameters

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
model_events
optional
If set then the retrieving model plots. Otherwise task plots
Default : false
boolean
navigate_earlier
optional
If set then get the either previous metric events from the current iteration or
(if does not exist) the last metric events from the previous iteration.
Otherwise next metric events from the current iteration or first metric events
from the next iteration
boolean
next_iteration
optional
If set then navigate to the next/previous iteration
Default : false
boolean
scroll_id
required
Scroll ID from the previous call to get_plot_samplestring
task
required
Task IDstring

Responses

HTTP CodeSchema
200events.plot_sample_response

POST /events.plots

Description

Get plot events for the requested amount of iterations per each task

Parameters

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
iters
optional
Max number of latest iterations for which to return plotsinteger
metrics
required
List of metrics and variants< events.task_metric_variants > array
model_events
optional
If set then the retrieving model plots. Otherwise task plots
Default : false
boolean
navigate_earlier
optional
If set then events are retreived from latest iterations to earliest ones.
Otherwise from earliest iterations to the latest. The default is True
boolean
refresh
optional
If set then scroll will be moved to the latest iterations. The default is Falseboolean
scroll_id
optional
Scroll ID of previous call (used for getting more results)string

Responses

HTTP CodeSchema
200events.plots_response

POST /events.scalar_metrics_iter_histogram

Description

Get histogram data of all the vector metrics and variants in the task

Parameters

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
key
optional
Histogram x axis to use: iter - iteration number iso_time - event time as ISO
formatted string timestamp - event timestamp as milliseconds since epoch
events.scalar_key_enum
metrics
optional
List of metrics and variants< events.metric_variants > array
model_events
optional
If set then the retrieving model events. Otherwise task events
Default : false
boolean
samples
optional
The amount of histogram points to return (0 to return all the points).
Optional, the default value is 6000.
integer
task
required
Task IDstring

Responses

HTTP CodeSchema
200Response 200

Response 200

NameSchema
images
optional
< object > array

POST /events.scalar_metrics_iter_raw

Description

Get raw data for a specific metric variants in the task

Parameters

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
batch_size
optional
The number of data points to return for this call. Optional, the default value
is 10000. Maximum batch size is 200000
integer
count_total
optional
Count the total number of data points. If false, total number of data points is
not counted and null is returned
Default : false
boolean
key
optional
Array of x axis to return. Supported values: iter - iteration number timestamp
- event timestamp as milliseconds since epoch
events.scalar_key_enum
metric
required
Metric and variants for which to return data pointsevents.metric_variants
model_events
optional
If set then the retrieving model events. Otherwise task events
Default : false
boolean
scroll_id
optional
Optional Scroll ID. Use to get more data points following a previous callstring
task
required
Task IDstring

Responses

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
returned
optional
Number of data points returned in this call. If 0 results were returned, no
more results are avilable
integer
scroll_id
optional
Scroll ID. Use to get more data points when calling this endpoint againstring
total
optional
Total data points count. If count_total is false, null is returnedinteger
variants
optional
Raw data points for each variantobject

POST /events.vector_metrics_iter_histogram

Description

Get histogram data of all the scalar metrics and variants in the task

Parameters

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
metric
required
string
model_events
optional
If set then the retrieving model events. Otherwise task events
Default : false
boolean
task
required
Task IDstring
variant
required
string

Responses

HTTP CodeSchema
200Response 200

Response 200

NameSchema
images
optional
< object > array