reports
POST /reports.archive
Description
Archive report
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| comment optional | The client message | string |
| task required | The ID of the report task to archive | string |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Description | Schema |
|---|---|---|
| archived optional | Number of reports archived (0 or 1) | integer |
POST /reports.create
Description
Create a new report
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| comment optional | Free text comment | string |
| name required | Report name. Unique within the company. | string |
| project optional | Project ID of the project to which this report is assigned Must exist[ab] | string |
| report optional | Report template | string |
| report_assets optional | List of the external report assets | < string > array |
| tags optional | User-defined tags list | < string > array |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Description | Schema |
|---|---|---|
| id optional | ID of the report | string |
| project_id optional | ID of the project that the report belongs to | string |
POST /reports.delete
Description
Delete report
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| force optional | If not set then published or unarchived reports cannot be deleted Default : false | boolean |
| task required | The ID of the report task to delete | string |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Description | Schema |
|---|---|---|
| deleted optional | Number of deleted reports (0 or 1) | integer |
POST /reports.get_all_ex
Description
Get all the company's and public report tasks
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| all optional | Multi-field pattern condition (all fields match pattern) | reports.multi_field_pattern_data |
| any optional | Multi-field pattern condition (any field matches pattern) | reports.multi_field_pattern_data |
| allow_public optional | Allow public reports to be returned in the results Default : true | boolean |
| filters optional | < string, filters > map | |
| id optional | List of IDs to filter by | < string > array |
| include_subprojects optional | If set to 'true' and project field is set then reports from the subprojects are searched too Default : false | boolean |
| name optional | Get only reports whose name matches this pattern (python regular expression syntax) | string |
| only_fields optional | List of report field names (nesting is supported using '.'). If provided, this list defines the query's projection (only these fields will be returned for each result entry) | < string > array |
| order_by optional | List of field names to order by. When search_text is used, '@text_score' can be used as a field representing the text score of returned documents. Use '-' prefix to specify descending order. Optional, recommended when using page | < string > array |
| page optional | Page number, returns a specific page out of the resulting list of reports Minimum value : 0 | integer |
| page_size optional | Page size, specifies the number of results returned in each page (last page may contain fewer results) Minimum value : 1 | integer |
| project optional | List of project IDs | < string > array |
| refresh_scroll optional | If set then all the data received with this scroll will be requeried | boolean |
| scroll_id optional | Scroll ID returned from the previos calls to get_all | string |
| search_text optional | Free text search query | string |
| size optional | The number of tasks to retrieve Minimum value : 1 | integer |
| status optional | List of report status. | < reports.report_status_enum > array |
| status_changed optional | List of status changed constraint strings (utcformat, epoch) with an optional prefix modifier (>, >=, <, <=) | < string > array |
| system_tags optional | List of report system tags. Use '-' prefix to exclude system tags | < string > array |
| tags optional | List of report user-defined tags. Use '-' prefix to exclude tags | < string > array |
| user optional | List of user IDs used to filter results by the reports's creating user | < string > array |
filters
| Name | Description | Schema |
|---|---|---|
| all optional | All the terms in 'all' condition are combined with 'and' operation | all |
| any optional | All the terms in 'any' condition are combined with 'or' operation | any |
| op optional | The operation between 'any' and 'all' parts of the filter if both are provided Default : "and" | enum (and, or) |
all
| Name | Schema |
|---|---|
| exclude optional | < string > array |
| include optional | < string > array |
any
| Name | Schema |
|---|---|
| exclude optional | < string > array |
| include optional | < string > array |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Description | Schema |
|---|---|---|
| scroll_id optional | Scroll ID that can be used with the next calls to get_all to retrieve more data | string |
| tasks optional | List of report tasks | < reports.report > array |
POST /reports.get_tags
Description
Get all the user tags used for the company reports
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | object |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Description | Schema |
|---|---|---|
| tags optional | The list of unique tag values | < string > array |
POST /reports.get_task_data
Description
Get the tasks data according the passed search criteria + requested events
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| all optional | Multi-field pattern condition (all fields match pattern) | reports.multi_field_pattern_data |
| any optional | Multi-field pattern condition (any field matches pattern) | reports.multi_field_pattern_data |
| allow_public optional | Allow public tasks to be returned in the results Default : true | boolean |
| debug_images optional | debug_images | |
| id optional | List of IDs to filter by | < string > array |
| include_subprojects optional | If set to 'true' and project field is set then tasks from the subprojects are searched too Default : false | boolean |
| input.view.entries.dataset optional | List of input dataset IDs | < string > array |
| input.view.entries.version optional | List of input dataset version IDs | < string > array |
| model_events optional | If set then the retrieving model events. Otherwise task events Default : false | boolean |
| name optional | Get only tasks whose name matches this pattern (python regular expression syntax) | string |
| only_fields optional | List of task field names (nesting is supported using '.', e.g. execution.model_labels). If provided, this list defines the query's projection (only these fields will be returned for each result entry) | < string > array |
| order_by optional | List of field names to order by. When search_text is used, '@text_score' can be used as a field representing the text score of returned documents. Use '-' prefix to specify descending order. Optional, recommended when using page | < string > array |
| parent optional | Parent ID | string |
| plots optional | plots | |
| project optional | List of project IDs | < string > array |
| scalar_metrics_iter_histogram optional | scalar_metrics_iter_histogram | |
| search_hidden optional | If set to 'true' then hidden tasks are included in the search results Default : false | boolean |
| search_text optional | Free text search query | string |
| single_value_metrics optional | If passed then task single value metrics are returned | object |
| size optional | The number of tasks to retrieve Minimum value : 1 | integer |
| status optional | List of task status. | < reports.task_status_enum > array |
| status_changed optional | List of status changed constraint strings (utcformat, epoch) with an optional prefix modifier (>, >=, <, <=) | < string > array |
| system_tags optional | List of task system tags. Use '-' prefix to exclude system tags | < string > array |
| tags optional | List of task user-defined tags. Use '-' prefix to exclude tags | < string > array |
| type optional | List of task types. One or more of: 'import', 'annotation', 'training' or 'testing' (case insensitive) | < string > array |
| user optional | List of user IDs used to filter results by the task's creating user | < string > array |
debug_images
| Name | Description | Schema |
|---|---|---|
| iters optional | Max number of latest iterations for which to return debug images | integer |
| metrics optional | List of metrics and variants | < reports.metric_variants > array |
plots
| Name | Description | Schema |
|---|---|---|
| iters optional | Max number of latest iterations for which to return plots | integer |
| 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 | < reports.metric_variants > array |
scalar_metrics_iter_histogram
| Name | Description | Schema |
|---|---|---|
| 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 | reports.scalar_key_enum |
| metrics optional | List of metrics and variants | < reports.metric_variants > array |
| samples optional | The amount of histogram points to return (0 to return all the points). Optional, the default value is 6000. | integer |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Description | Schema |
|---|---|---|
| debug_images optional | Debug image events grouped by tasks and iterations | < reports.debug_images_response_task_metrics > array |
| plots optional | Plots mapped by metric, variant, task and iteration | object |
| scalar_metrics_iter_histogram optional | object | |
| single_value_metrics optional | Single value metrics grouped by task | < reports.single_value_task_metrics > array |
| tasks optional | List of tasks | < reports.task > array |
POST /reports.move
Description
Move reports to a project
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| project optional | Target project ID. If not provided, project_name must be provided. Use null for the root project | string |
| project_name optional | Target project name. If provided and a project with this name does not exist, a new project will be created. If not provided, project must be provided. | string |
| task required | ID of the report to move | string |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Description | Schema |
|---|---|---|
| project_id optional | The ID of the target project | string |
POST /reports.publish
Description
Publish report
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| comment optional | The client message | string |
| task required | The ID of the report task to publish | string |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Description | Schema |
|---|---|---|
| fields optional | Updated fields names and values | object |
| updated optional | Number of reports updated (0 or 1) | integer |
POST /reports.unarchive
Description
Unarchive report
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| comment optional | The client message | string |
| task required | The ID of the report task to unarchive | string |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Description | Schema |
|---|---|---|
| unarchived optional | Number of reports unarchived (0 or 1) | integer |
POST /reports.update
Description
Create a new report
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | request required | request body | request |
request
| Name | Description | Schema |
|---|---|---|
| comment optional | Free text comment | string |
| name optional | Report name. Unique within the company. | string |
| report optional | Report template | string |
| report_assets optional | List of the external report assets | < string > array |
| tags optional | User-defined tags list | < string > array |
| task required | The ID of the report task to update | string |
Responses
| HTTP Code | Schema |
|---|---|
| 200 | Response 200 |
Response 200
| Name | Description | Schema |
|---|---|---|
| fields optional | Updated fields names and values | object |
| updated optional | Number of reports updated (0 or 1) | integer |