--- updatedAt: 2026-05-27T10:25:03.000Z agentTools: projectIndex: https://docs.v7labs.com/llms.txt --- # Create a job to generate a report Starts a background job to generate an 'annotator' or 'item' report. Immediately returns job info, containing the file URL to get the report from. Note: - The 'annotator' report data is available from 2024-11-05 - The 'item' report data is available from 2025-08-01 # OpenAPI definition ```json { "components": { "schemas": { "Report.GroupBys": { "description": "Types of grouping.", "items": { "$ref": "#/components/schemas/Report.GroupBy" }, "title": "Report.GroupBys", "type": "array", "x-struct": "Elixir.GraphotateWeb.Schemas.Report.GroupBys", "x-validate": null }, "DatasetsV2.AdvancedFilters.SimpleFilter": { "description": "Simple filter specifies rule that subject has to fulfill. Each simple filter consist of `subject` and `matcher`. Subject is name of property you want to filter on. For example if you want to filter by item id you should specify {subject: 'item_id'}. Next you have to specify matcher which defines how you would like to filer. If you are interest in any of items within array of items id you should specify: {matcher: {name: 'any_of', values: [list of items ids]}}", "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.AdvancedFilters.AnnotationClassFilter" }, { "$ref": "#/components/schemas/DatasetsV2.AdvancedFilters.ArchivedFilter" }, { "$ref": "#/components/schemas/DatasetsV2.AdvancedFilters.AssigneeFilter" }, { "$ref": "#/components/schemas/DatasetsV2.AdvancedFilters.ClassPropertyFilter" }, { "$ref": "#/components/schemas/DatasetsV2.AdvancedFilters.ClassPropertyValueFilter" }, { "$ref": "#/components/schemas/DatasetsV2.AdvancedFilters.ItemPropertyFilter" }, { "$ref": "#/components/schemas/DatasetsV2.AdvancedFilters.ItemPropertyValueFilter" }, { "$ref": "#/components/schemas/DatasetsV2.AdvancedFilters.CreatedAtFilter" }, { "$ref": "#/components/schemas/DatasetsV2.AdvancedFilters.CurrentAssigneeFilter" }, { "$ref": "#/components/schemas/DatasetsV2.AdvancedFilters.FileTypeFilter" }, { "$ref": "#/components/schemas/DatasetsV2.AdvancedFilters.FolderPathFilter" }, { "$ref": "#/components/schemas/DatasetsV2.AdvancedFilters.IssueFilter" }, { "$ref": "#/components/schemas/DatasetsV2.AdvancedFilters.ItemIdFilter" }, { "$ref": "#/components/schemas/DatasetsV2.AdvancedFilters.ItemNameFilter" }, { "$ref": "#/components/schemas/DatasetsV2.AdvancedFilters.ProcessingStatusFilter" }, { "$ref": "#/components/schemas/DatasetsV2.AdvancedFilters.StatusFilter" }, { "$ref": "#/components/schemas/DatasetsV2.AdvancedFilters.TextPropertyValueFilter" }, { "$ref": "#/components/schemas/DatasetsV2.AdvancedFilters.UpdatedAtFilter" }, { "$ref": "#/components/schemas/DatasetsV2.AdvancedFilters.WorkflowStageFilter" }, { "$ref": "#/components/schemas/DatasetsV2.AdvancedFilters.WorkflowStatusFilter" }, { "$ref": "#/components/schemas/DatasetsV2.AdvancedFilters.WorkflowStageEnteredAtFilter" } ], "title": "DatasetsV2.AdvancedFilters.SimpleFilter", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.AdvancedFilters.SimpleFilter", "x-validate": null }, "DatasetsV2.AdvancedFilters.ArchivedFilter": { "additionalProperties": false, "description": "Filter items based on archived status. If you want to see only archived items, you can set matcher name: `equals` and value: `true`.", "properties": { "matcher": { "description": "Matches items based on whether the values from the subject are equal to the one specified in the filter", "properties": { "name": { "enum": [ "equals" ], "type": "string", "x-struct": null, "x-validate": null }, "value": { "type": "boolean", "x-struct": null, "x-validate": null } }, "required": [ "name", "value" ], "type": "object", "x-struct": null, "x-validate": null }, "subject": { "enum": [ "archived" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "subject", "matcher" ], "title": "DatasetsV2.AdvancedFilters.ArchivedFilter", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.AdvancedFilters.ArchivedFilter", "x-validate": null }, "DatasetsV2.AdvancedFilters.CreatedAtFilter": { "additionalProperties": false, "description": "Filter items based creation date. You can filter items that were created `before` or `after`. You can also filter using range specified as `before`, `after`. Please keep in mind that `after` is inclusive while `before` is exclusive", "properties": { "matcher": { "anyOf": [ { "properties": { "before": { "$ref": "#/components/schemas/Common.DateTime" }, "name": { "enum": [ "date_range" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "name", "before" ], "type": "object", "x-struct": null, "x-validate": null }, { "properties": { "after": { "$ref": "#/components/schemas/Common.DateTime" }, "name": { "enum": [ "date_range" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "name", "after" ], "type": "object", "x-struct": null, "x-validate": null } ], "description": "Matches items based on whether the values from the subject are in the range specified by before and/or after", "x-struct": null, "x-validate": null }, "subject": { "enum": [ "created_at" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "subject", "matcher" ], "title": "DatasetsV2.AdvancedFilters.CreatedAtFilter", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.AdvancedFilters.CreatedAtFilter", "x-validate": null }, "DatasetsV2.AdvancedFilters.UpdatedAtFilter": { "additionalProperties": false, "description": "Filter items based last update date. You can filter items that were updated `before` or `after`. You can also filter using range specified as `before`, `after`. Please keep in mind that `after` is inclusive while `before` is exclusive", "properties": { "matcher": { "anyOf": [ { "properties": { "before": { "$ref": "#/components/schemas/Common.DateTime" }, "name": { "enum": [ "date_range" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "name", "before" ], "type": "object", "x-struct": null, "x-validate": null }, { "properties": { "after": { "$ref": "#/components/schemas/Common.DateTime" }, "name": { "enum": [ "date_range" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "name", "after" ], "type": "object", "x-struct": null, "x-validate": null } ], "description": "Matches items based on whether the values from the subject are in the range specified by before and/or after", "x-struct": null, "x-validate": null }, "subject": { "enum": [ "updated_at" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "subject", "matcher" ], "title": "DatasetsV2.AdvancedFilters.UpdatedAtFilter", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.AdvancedFilters.UpdatedAtFilter", "x-validate": null }, "DatasetsV2.AdvancedFilters.WorkflowStageFilter": { "additionalProperties": false, "description": "Filter items based on workflow stage id. You can filter using `any_of`, `none_of`, `all_of` matchers with list of workflow stage ids For example if you would like to get `items` that are not in workflow stage: `['e23ff3f3-8f77-4e78-9e81-fdb25abfb781']` you can specify matcher name: `none_of` and values: [`e23ff3f3-8f77-4e78-9e81-fdb25abfb781`]", "properties": { "matcher": { "discriminator": { "propertyName": "name" }, "oneOf": [ { "description": "Matches items based on whether the values from the subject have any of the values specified in the filter", "properties": { "name": { "enum": [ "any_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "$ref": "#/components/schemas/Common.UUID" }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject have none of the values specified in the filter", "properties": { "name": { "enum": [ "none_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "$ref": "#/components/schemas/Common.UUID" }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject are all in the values specified in the filter", "properties": { "name": { "enum": [ "all_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "$ref": "#/components/schemas/Common.UUID" }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null } ], "x-struct": null, "x-validate": null }, "subject": { "enum": [ "workflow_stage" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "subject", "matcher" ], "title": "DatasetsV2.AdvancedFilters.WorkflowStageFilter", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.AdvancedFilters.WorkflowStageFilter", "x-validate": null }, "DatasetsV2.AdvancedFilters.StatusFilter": { "additionalProperties": false, "description": "Filter items based on status - this is temporary filter to support transitions on FE. Please do not use it.", "properties": { "matcher": { "discriminator": { "propertyName": "name" }, "oneOf": [ { "description": "Matches items based on whether the values from the subject have any of the values specified in the filter", "properties": { "name": { "enum": [ "any_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "enum": [ "annotate", "archived", "cancelled", "complete", "error", "new", "processing", "review", "upload_confirmed", "uploading" ], "type": "string", "x-struct": null, "x-validate": null }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject have none of the values specified in the filter", "properties": { "name": { "enum": [ "none_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "enum": [ "annotate", "archived", "cancelled", "complete", "error", "new", "processing", "review", "upload_confirmed", "uploading" ], "type": "string", "x-struct": null, "x-validate": null }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null } ], "x-struct": null, "x-validate": null }, "subject": { "enum": [ "status" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "subject", "matcher" ], "title": "DatasetsV2.AdvancedFilters.StatusFilter", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.AdvancedFilters.StatusFilter", "x-validate": null }, "DatasetsV2.AdvancedFilters.ProcessingStatusFilter": { "additionalProperties": false, "description": "Filter items based on processing status. Each item consists of one or more files that can be in states: `cancelled` | `error` | `uploading` | `upload_confirmed` | `processing` | `complete`. You can filter items that are in given state using matcher name: `any_of` values: `['cancelled', 'error']`", "properties": { "matcher": { "discriminator": { "propertyName": "name" }, "oneOf": [ { "description": "Matches items based on whether the values from the subject have any of the values specified in the filter", "properties": { "name": { "enum": [ "any_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "enum": [ "cancelled", "error", "uploading", "upload_confirmed", "processing", "complete" ], "type": "string", "x-struct": null, "x-validate": null }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject have none of the values specified in the filter", "properties": { "name": { "enum": [ "none_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "enum": [ "cancelled", "error", "uploading", "upload_confirmed", "processing", "complete" ], "type": "string", "x-struct": null, "x-validate": null }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null } ], "x-struct": null, "x-validate": null }, "subject": { "enum": [ "processing_status" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "subject", "matcher" ], "title": "DatasetsV2.AdvancedFilters.ProcessingStatusFilter", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.AdvancedFilters.ProcessingStatusFilter", "x-validate": null }, "JsonErrorResponse": { "properties": { "errors": { "items": { "properties": { "detail": { "example": "null value where string expected", "type": "string", "x-struct": null, "x-validate": null }, "source": { "properties": { "pointer": { "example": "/data/attributes/petName", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "pointer" ], "type": "object", "x-struct": null, "x-validate": null }, "title": { "example": "Invalid value", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "title", "source", "detail" ], "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "errors" ], "title": "JsonErrorResponse", "type": "object", "x-struct": "Elixir.OpenApiSpex.JsonErrorResponse", "x-validate": null }, "DatasetsV2.AdvancedFilters.AssigneeFilter": { "additionalProperties": false, "description": "Filter items based on assignee ids. You can filter using `any_of`, `none_of`, `all_of` matchers with list of assignee ids. We match assignees from all workflow stages besides current one.", "properties": { "matcher": { "discriminator": { "propertyName": "name" }, "oneOf": [ { "description": "Matches items based on whether the values from the subject have any of the values specified in the filter", "properties": { "name": { "enum": [ "any_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "$ref": "#/components/schemas/Common.IntegerId" }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject have none of the values specified in the filter", "properties": { "name": { "enum": [ "none_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "$ref": "#/components/schemas/Common.IntegerId" }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject are all in the values specified in the filter", "properties": { "name": { "enum": [ "all_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "$ref": "#/components/schemas/Common.IntegerId" }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null } ], "x-struct": null, "x-validate": null }, "subject": { "enum": [ "assignee" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "subject", "matcher" ], "title": "DatasetsV2.AdvancedFilters.AssigneeFilter", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.AdvancedFilters.AssigneeFilter", "x-validate": null }, "DatasetsV2.AdvancedFilters.WorkflowStatusFilter": { "additionalProperties": false, "description": "Filter items based on workflow status. If you want to get items that are in given workflow states you can specify matcher name: `any_of` values: `['new', 'annotate']`.", "properties": { "matcher": { "discriminator": { "propertyName": "name" }, "oneOf": [ { "description": "Matches items based on whether the values from the subject have any of the values specified in the filter", "properties": { "name": { "enum": [ "any_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "enum": [ "new", "annotate", "review", "complete" ], "type": "string", "x-struct": null, "x-validate": null }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject have none of the values specified in the filter", "properties": { "name": { "enum": [ "none_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "enum": [ "new", "annotate", "review", "complete" ], "type": "string", "x-struct": null, "x-validate": null }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null } ], "x-struct": null, "x-validate": null }, "subject": { "enum": [ "workflow_status" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "subject", "matcher" ], "title": "DatasetsV2.AdvancedFilters.WorkflowStatusFilter", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.AdvancedFilters.WorkflowStatusFilter", "x-validate": null }, "Common.APIError": { "additionalProperties": false, "properties": { "errors": { "properties": { "code": { "enum": [ "OUT_OF_ANNOTATION_CREDITS", "NOT_ARCHIVED", "ASSIGN_WORKFLOW_TEMPLATE_UNAVAILABLE", "WORKFLOW_UPDATE_FAILURE", "GATED_FEATURE_SSO_AND_SAML", "UPLOAD_DISABLED", "ITEM_REGISTRATION_LIMIT_EXCEEDED", "SSO_REQUIRED", "TOO_MANY_PENDING_EXPORTS", "STORAGE_VALIDATION_FAILED", "INVALID_ITEM_LAYOUT", "WORKFLOW_ALREADY_COMPLETE", "SUBSCRIPTION_INCOMPLETE_EXPIRED", "UNIQUE_CONSTRAINT_VIOLATION", "ITEM_IS_NOT_READY_FOR_ANNOTATIONS_IMPORT", "NO_EXTERNAL_STORAGE_SET_FOR_TEAM", "NO_DEFAULT_WORKFLOW", "PLATFORM_TFA_ENFORCEMENT_LOCKED", "STORAGE_LIMIT_REACHED", "FEATURE_FLAG_DISABLED", "MISSING_FILE_TYPE", "DUPLICATED_FILE_SLOT", "NO_AVAILABLE_WORK", "MODIFYING_COMPLETE_STAGE", "ENFORCING_SSO_BLOCKS_REGULAR_MEMBERSHIPS", "INVALID_SAML_REQUEST", "MISSING_PARAMETERS", "INCORRECT_CLASS_USAGE", "GROUND_TRUTH_NAME_DUPLICATE", "NOT_AUTHENTICATED", "TOO_MANY_ACTIVE_REPORT_JOBS", "NOT_CURRENT_STAGE", "INVALID_2FA_TOKEN", "DATASET_IN_WORKFLOW", "INCOMPATIBLE_STAGE_TYPE", "TARGET_IN_DIFFERENT_DATASET", "ASSIGN_ASSIGNMENT_INVALID", "INVALID_ANNOTATION_DATA", "OUT_OF_SEATS", "STAGE_MISSING_ASSIGNEE", "NO_ANNOTATIONS_ON_SOURCE_ITEM", "REVIEW_STATUS_NOT_SET", "NOT_FOUND", "SUBSCRIPTION_PAST_DUE", "EXTERNAL_STORAGE_LIMIT_REACHED", "UNPROCESSED_VIDEO_REGISTRATION_DISABLED", "GATED_FEATURE_TFA_ENFORCEMENT", "NO_ACTIVE_WORKFLOW", "USER_NOT_FOUND_FOR_ACTOR", "GROUND_TRUTH_VERSIONING_NOT_SUPPORTED", "CLASSES_USED_IN_WORKFLOW", "DUPLICATED_OBJECT_REJECTED", "SUBSCRIPTION_UNPAID", "MULTIBITRATE_STREAM_NOT_AVAILABLE", "TIMEOUT", "TARGET_STAGE_NOT_CURRENT", "BAD_REQUEST", "MULTIPLE_SLOTS_IN_AS_FRAMES_MODE", "INCLUDES_RASTER_LAYER", "OUT_OF_SUBSCRIBED_STORAGE", "REPORT_JOB_NOT_FINISHED", "ASSIGN_ATTRIBUTES_INVALID", "NOT_AUTHORIZED", "SUBSCRIPTION_CANCELLED", "DATASET_ERROR", "STORAGE_NOT_FOUND", "NO_WORKSPACES_AVAILABLE", "TARGET_REVIEW_STAGE_READONLY", "TOO_MANY_ATTEMPTS", "OUT_OF_SUBSCRIBED_ANNOTATION_CREDITS", "SSO_SIGNUP_REQUIRED", "TOO_MANY_PENDING_AI_REVIEW_BLUEPRINTS", "NOTHING_TO_EXPORT", "TARGET_STAGE_TYPE_INVALID", "PAYMENT_NOT_SETUP", "AWS_MARKETPLACE_FULFILLMENT_INCOMPLETE", "MISSING_SELECT_ALL_FILTER", "DUPLICATED_ITEM_FULL_PATH", "UPLOAD_VIDEO_READONLY_STORAGE_MISSING_FRAME_SPECS", "PATH_ALREADY_TAKEN", "TARGET_ALREADY_ANNOTATED", "FILTER_VALIDATION_ERROR", "OPERATION_ALREADY_IN_PROGRESS", "DATASET_NOT_FOUND", "INVALID_URL", "ALREADY_IN_WORKFLOW", "ASSIGN_NOT_ALL_ITEMS_ASSIGNABLE", "INCOMPATIBLE_DATASET_VERSION", "ALREADY_HAS_ANNOTATIONS", "BILLING_ADDRESS_INFO_MISSING", "INVALID_REQUEST", "GATED_FEATURE_EXTERNAL_MODEL_REGISTRATION" ], "type": "string", "x-struct": null, "x-validate": null }, "detail": { "nullable": true, "type": "object", "x-struct": null, "x-validate": null }, "message": { "example": "Error message", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "status": { "example": 422, "nullable": false, "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "message" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "errors" ], "title": "Common.APIError", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.Common.APIError", "x-validate": null }, "Common.DateTime": { "description": "DateTime in RFC3339 format", "example": "2020-01-20T14:00:00Z", "format": "date-time", "title": "Common.DateTime", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.Common.DateTime", "x-validate": null }, "DatasetsV2.AdvancedFilters.Conjunction": { "description": "Use to join filters together. It is possible to join simple or group filters with `and`, `or` operators", "enum": [ "and", "or" ], "title": "DatasetsV2.AdvancedFilters.Conjunction", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.AdvancedFilters.Conjunction", "x-validate": null }, "Report.JobRequestMetrics": { "description": "Job request metrics.", "items": { "$ref": "#/components/schemas/Report.JobRequestMetricsItem" }, "title": "Report.JobRequestMetrics", "type": "array", "x-struct": "Elixir.GraphotateWeb.Schemas.Report.JobRequestMetrics", "x-validate": null }, "Common.IntegerIds": { "default": [], "items": { "$ref": "#/components/schemas/Common.IntegerId" }, "nullable": true, "title": "Common.IntegerIds", "type": "array", "x-struct": "Elixir.GraphotateWeb.Schemas.Common.IntegerIds", "x-validate": null }, "DatasetsV2.AdvancedFilters.IssueFilter": { "additionalProperties": false, "description": "Filter items based on issue type. If you are interested in items that have comments, You can set matcher value to `comment`. You can specify matcher as `any_of` or `none_of`.", "properties": { "matcher": { "discriminator": { "propertyName": "name" }, "oneOf": [ { "description": "Matches items based on whether the values from the subject have any of the values specified in the filter", "properties": { "name": { "enum": [ "any_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "enum": [ "comment" ], "type": "string", "x-struct": null, "x-validate": null }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject have none of the values specified in the filter", "properties": { "name": { "enum": [ "none_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "enum": [ "comment" ], "type": "string", "x-struct": null, "x-validate": null }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null } ], "x-struct": null, "x-validate": null }, "subject": { "enum": [ "issue" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "subject", "matcher" ], "title": "DatasetsV2.AdvancedFilters.IssueFilter", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.AdvancedFilters.IssueFilter", "x-validate": null }, "DatasetsV2.AdvancedFilters.ClassPropertyValueFilter": { "additionalProperties": false, "description": "Filter items based on class property value id. You can filter using `any_of`, `none_of`, `all_of` matchers with list of class property value ids For example if you would like to get `items` that don't have class property value id: `['e23ff3f3-8f77-4e78-9e81-fdb25abfb781']` you can specify matcher name: `none_of` and values: `['e23ff3f3-8f77-4e78-9e81-fdb25abfb781']`", "properties": { "matcher": { "discriminator": { "propertyName": "name" }, "oneOf": [ { "description": "Matches items based on whether the values from the subject have any of the values specified in the filter", "properties": { "name": { "enum": [ "any_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "$ref": "#/components/schemas/Common.UUID" }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject have none of the values specified in the filter", "properties": { "name": { "enum": [ "none_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "$ref": "#/components/schemas/Common.UUID" }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject are all in the values specified in the filter", "properties": { "name": { "enum": [ "all_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "$ref": "#/components/schemas/Common.UUID" }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null } ], "x-struct": null, "x-validate": null }, "subject": { "enum": [ "class_property_value" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "subject", "matcher" ], "title": "DatasetsV2.AdvancedFilters.ClassPropertyValueFilter", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.AdvancedFilters.ClassPropertyValueFilter", "x-validate": null }, "Common.IntegerId": { "example": 123, "title": "Common.IntegerId", "type": "integer", "x-struct": "Elixir.GraphotateWeb.Schemas.Common.IntegerId", "x-validate": null }, "DatasetsV2.AdvancedFilters.FolderPathFilter": { "additionalProperties": false, "description": "Filter items based on folder path. Each item exists in folder. If you want to see items only from folder `/folder1` you can specify matcher name: `any_of` and values: [`/folder1`]. If you want to see items from folders that name starts with provided values, You can specify matcher name: `prefix` or `not_prefix`.", "properties": { "matcher": { "discriminator": { "propertyName": "name" }, "oneOf": [ { "description": "Matches items based on whether the values from the subject have any of the values specified in the filter", "properties": { "name": { "enum": [ "any_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "example": "/path1", "type": "string", "x-struct": null, "x-validate": null }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject have none of the values specified in the filter", "properties": { "name": { "enum": [ "none_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "example": "/path1", "type": "string", "x-struct": null, "x-validate": null }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject starts with the one specified in the filter", "properties": { "name": { "enum": [ "prefix" ], "type": "string", "x-struct": null, "x-validate": null }, "value": { "example": "/path1", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "name", "value" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject does not start with the one specified in the filter", "properties": { "name": { "enum": [ "not_prefix" ], "type": "string", "x-struct": null, "x-validate": null }, "value": { "example": "/path1", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "name", "value" ], "type": "object", "x-struct": null, "x-validate": null } ], "x-struct": null, "x-validate": null }, "subject": { "enum": [ "folder_path" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "subject", "matcher" ], "title": "DatasetsV2.AdvancedFilters.FolderPathFilter", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.AdvancedFilters.FolderPathFilter", "x-validate": null }, "Report.JobRequest": { "additionalProperties": false, "description": "Job request information.", "properties": { "dataset_ids": { "$ref": "#/components/schemas/Common.IntegerIds" }, "filter": { "$ref": "#/components/schemas/DatasetsV2.AdvancedFilters.OptionalFilter" }, "format": { "$ref": "#/components/schemas/Report.Format" }, "group_by": { "$ref": "#/components/schemas/Report.GroupBys" }, "metrics": { "$ref": "#/components/schemas/Report.JobRequestMetrics" }, "start": { "$ref": "#/components/schemas/Common.DateTime" }, "stop": { "$ref": "#/components/schemas/Common.DateTime" }, "type": { "$ref": "#/components/schemas/Report.Type" }, "user_ids": { "$ref": "#/components/schemas/Common.IntegerIds" } }, "required": [ "metrics", "start", "stop", "group_by" ], "title": "Report.JobRequest", "type": "object", "x-struct": null, "x-validate": null }, "DatasetsV2.AdvancedFilters.ClassPropertyFilter": { "additionalProperties": false, "description": "Filter items based on class property id. You can filter using `any_of`, `none_of`, `all_of` matchers with list of class property ids For example if you would like to get `items` that don't have class property id: `['e23ff3f3-8f77-4e78-9e81-fdb25abfb781']` you can specify matcher name: `none_of` and values: `['e23ff3f3-8f77-4e78-9e81-fdb25abfb781']`", "properties": { "matcher": { "discriminator": { "propertyName": "name" }, "oneOf": [ { "description": "Matches items based on whether the values from the subject have any of the values specified in the filter", "properties": { "name": { "enum": [ "any_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "$ref": "#/components/schemas/Common.UUID" }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject have none of the values specified in the filter", "properties": { "name": { "enum": [ "none_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "$ref": "#/components/schemas/Common.UUID" }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject are all in the values specified in the filter", "properties": { "name": { "enum": [ "all_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "$ref": "#/components/schemas/Common.UUID" }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null } ], "x-struct": null, "x-validate": null }, "subject": { "enum": [ "class_property" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "subject", "matcher" ], "title": "DatasetsV2.AdvancedFilters.ClassPropertyFilter", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.AdvancedFilters.ClassPropertyFilter", "x-validate": null }, "Report.JobResponse": { "additionalProperties": false, "description": "Job response information.", "properties": { "format": { "$ref": "#/components/schemas/Report.Format" }, "id": { "type": "string", "x-struct": null, "x-validate": null }, "inserted_at": { "$ref": "#/components/schemas/Common.DateTime" }, "owner_id": { "nullable": true, "type": "integer", "x-struct": null, "x-validate": null }, "status": { "enum": [ "pending", "running", "finished", "failed" ], "type": "string", "x-struct": null, "x-validate": null }, "team_id": { "$ref": "#/components/schemas/Common.TeamId" }, "type": { "enum": [ "annotator", "item" ], "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "$ref": "#/components/schemas/Common.DateTime" }, "url": { "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "id", "url", "format", "type", "status", "team_id", "inserted_at", "updated_at" ], "title": "Report.JobResponse", "type": "object", "x-struct": null, "x-validate": null }, "DatasetsV2.AdvancedFilters.ItemIdFilter": { "additionalProperties": false, "description": "Filter items based on item id. If you want to get items with specific ids. You can specify matcher name: `any_of` and values: `['e23ff3f3-8f77-4e78-9e81-fdb25abfb781', 'e23ff3f3-8f77-4e78-9e81-fdb25abfb782']`", "properties": { "matcher": { "discriminator": { "propertyName": "name" }, "oneOf": [ { "description": "Matches items based on whether the values from the subject have any of the values specified in the filter", "properties": { "name": { "enum": [ "any_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "$ref": "#/components/schemas/Common.UUID" }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject have none of the values specified in the filter", "properties": { "name": { "enum": [ "none_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "$ref": "#/components/schemas/Common.UUID" }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null } ], "x-struct": null, "x-validate": null }, "subject": { "enum": [ "id" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "subject", "matcher" ], "title": "DatasetsV2.AdvancedFilters.ItemIdFilter", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.AdvancedFilters.ItemIdFilter", "x-validate": null }, "DatasetsV2.AdvancedFilters.UnfilteredFilter": { "additionalProperties": false, "description": "Explicitly disable filtering", "properties": { "all": { "enum": [ true ], "type": "boolean", "x-struct": null, "x-validate": null } }, "required": [ "all" ], "title": "DatasetsV2.AdvancedFilters.UnfilteredFilter", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.AdvancedFilters.UnfilteredFilter", "x-validate": null }, "DatasetsV2.AdvancedFilters.ItemPropertyValueFilter": { "additionalProperties": false, "description": "Filter items based on item property value id. You can filter using `any_of`, `none_of`, `all_of` matchers with list of class property value ids For example if you would like to get `items` that don't have item property value id: `['e23ff3f3-8f77-4e78-9e81-fdb25abfb781']` you can specify matcher name: `none_of` and values: `['e23ff3f3-8f77-4e78-9e81-fdb25abfb781']`", "properties": { "matcher": { "discriminator": { "propertyName": "name" }, "oneOf": [ { "description": "Matches items based on whether the values from the subject have any of the values specified in the filter", "properties": { "name": { "enum": [ "any_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "$ref": "#/components/schemas/Common.UUID" }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject have none of the values specified in the filter", "properties": { "name": { "enum": [ "none_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "$ref": "#/components/schemas/Common.UUID" }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject are all in the values specified in the filter", "properties": { "name": { "enum": [ "all_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "$ref": "#/components/schemas/Common.UUID" }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null } ], "x-struct": null, "x-validate": null }, "subject": { "enum": [ "item_property_value" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "subject", "matcher" ], "title": "DatasetsV2.AdvancedFilters.ItemPropertyValueFilter", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.AdvancedFilters.ItemPropertyValueFilter", "x-validate": null }, "DatasetsV2.AdvancedFilters.ItemPropertyFilter": { "additionalProperties": false, "description": "Filter items based on item property id. You can filter using `any_of`, `none_of`, `all_of` matchers with list of item property ids For example if you would like to get `items` that don't have item property id: `['e23ff3f3-8f77-4e78-9e81-fdb25abfb781']` you can specify matcher name: `none_of` and values: `['e23ff3f3-8f77-4e78-9e81-fdb25abfb781']`", "properties": { "matcher": { "discriminator": { "propertyName": "name" }, "oneOf": [ { "description": "Matches items based on whether the values from the subject have any of the values specified in the filter", "properties": { "name": { "enum": [ "any_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "$ref": "#/components/schemas/Common.UUID" }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject have none of the values specified in the filter", "properties": { "name": { "enum": [ "none_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "$ref": "#/components/schemas/Common.UUID" }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject are all in the values specified in the filter", "properties": { "name": { "enum": [ "all_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "$ref": "#/components/schemas/Common.UUID" }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null } ], "x-struct": null, "x-validate": null }, "subject": { "enum": [ "item_property" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "subject", "matcher" ], "title": "DatasetsV2.AdvancedFilters.ItemPropertyFilter", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.AdvancedFilters.ItemPropertyFilter", "x-validate": null }, "DatasetsV2.AdvancedFilters.AnnotationClassFilter": { "additionalProperties": false, "description": "Filter items based on annotation class id. You can filter using `any_of`, `none_of`, `all_of` matchers with list of annotation class ids For example if you would like to get `items` that don't have annotation class id: `[ 1 ]` you can specify matcher name: `none_of` and values: `[ 1 ]`", "properties": { "matcher": { "discriminator": { "propertyName": "name" }, "oneOf": [ { "description": "Matches items based on whether the values from the subject have any of the values specified in the filter", "properties": { "name": { "enum": [ "any_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "$ref": "#/components/schemas/Common.IntegerId" }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject have none of the values specified in the filter", "properties": { "name": { "enum": [ "none_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "$ref": "#/components/schemas/Common.IntegerId" }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject are all in the values specified in the filter", "properties": { "name": { "enum": [ "all_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "$ref": "#/components/schemas/Common.IntegerId" }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null } ], "x-struct": null, "x-validate": null }, "subject": { "enum": [ "annotation_class" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "subject", "matcher" ], "title": "DatasetsV2.AdvancedFilters.AnnotationClassFilter", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.AdvancedFilters.AnnotationClassFilter", "x-validate": null }, "Report.Format": { "default": "json", "description": "Report format.", "enum": [ "csv", "json" ], "title": "Report.Format", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.Report.Format", "x-validate": null }, "Common.TeamId": { "example": 123, "title": "Common.TeamId", "type": "integer", "x-struct": "Elixir.GraphotateWeb.Schemas.Common.TeamId", "x-validate": null }, "DatasetsV2.AdvancedFilters.CurrentAssigneeFilter": { "additionalProperties": false, "description": "Filter items based on current assignee ids. You can filter using `any_of`, `none_of`, `all_of` matchers with list of current assignee ids. We match assignees from only current workflow stage.", "properties": { "matcher": { "discriminator": { "propertyName": "name" }, "oneOf": [ { "description": "Matches items based on whether the values from the subject have any of the values specified in the filter", "properties": { "name": { "enum": [ "any_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "$ref": "#/components/schemas/Common.IntegerId" }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject have none of the values specified in the filter", "properties": { "name": { "enum": [ "none_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "$ref": "#/components/schemas/Common.IntegerId" }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject are all in the values specified in the filter", "properties": { "name": { "enum": [ "all_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "$ref": "#/components/schemas/Common.IntegerId" }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null } ], "x-struct": null, "x-validate": null }, "subject": { "enum": [ "current_assignee" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "subject", "matcher" ], "title": "DatasetsV2.AdvancedFilters.CurrentAssigneeFilter", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.AdvancedFilters.CurrentAssigneeFilter", "x-validate": null }, "DatasetsV2.AdvancedFilters.ItemNameFilter": { "additionalProperties": false, "description": "Filter items based on name. If you want to get items with specific name you can specify matcher name: `any_of`, values: `['name1', 'name2']`. You can also search for part of names using `prefix` or `contains` matchers.", "properties": { "matcher": { "discriminator": { "propertyName": "name" }, "oneOf": [ { "description": "Matches items based on whether the values from the subject have any of the values specified in the filter", "properties": { "name": { "enum": [ "any_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "example": "item name", "type": "string", "x-struct": null, "x-validate": null }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject have none of the values specified in the filter", "properties": { "name": { "enum": [ "none_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "example": "item name", "type": "string", "x-struct": null, "x-validate": null }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject starts with the one specified in the filter", "properties": { "name": { "enum": [ "prefix" ], "type": "string", "x-struct": null, "x-validate": null }, "value": { "example": "item name", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "name", "value" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject does not start with the one specified in the filter", "properties": { "name": { "enum": [ "not_prefix" ], "type": "string", "x-struct": null, "x-validate": null }, "value": { "example": "item name", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "name", "value" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject contains the one specified in the filter", "properties": { "name": { "enum": [ "contains" ], "type": "string", "x-struct": null, "x-validate": null }, "value": { "example": "item name", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "name", "value" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject does not contain the one specified in the filter", "properties": { "name": { "enum": [ "not_contains" ], "type": "string", "x-struct": null, "x-validate": null }, "value": { "example": "item name", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "name", "value" ], "type": "object", "x-struct": null, "x-validate": null } ], "x-struct": null, "x-validate": null }, "subject": { "enum": [ "item_name" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "subject", "matcher" ], "title": "DatasetsV2.AdvancedFilters.ItemNameFilter", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.AdvancedFilters.ItemNameFilter", "x-validate": null }, "Report.JobRequestMetricsItem": { "description": "Job request metric type.", "enum": [ "active_time", "total_annotations", "total_items_annotated", "time_per_item", "time_per_annotation", "review_pass_rate", "annotation_counts", "rejected_in_review", "annotation_count_at_stage_exit", "time_in_stage_instance", "time_per_frame", "current_stage" ], "title": "Report.JobRequestMetricsItem", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.Report.JobRequestMetricsItem", "x-validate": null }, "Report.GroupBy": { "description": "Type of grouping.", "enum": [ "annotators", "datasets", "stages", "dataset_items", "stage_instances" ], "title": "Report.GroupBy", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.Report.GroupBy", "x-validate": null }, "DatasetsV2.AdvancedFilters.FileTypeFilter": { "additionalProperties": false, "description": "Filter items based on file types it contains. If you are interested in items that contains specific file types you can specify matcher name: `any_of` values: `['image', 'video']`.", "properties": { "matcher": { "discriminator": { "propertyName": "name" }, "oneOf": [ { "description": "Matches items based on whether the values from the subject have any of the values specified in the filter", "properties": { "name": { "enum": [ "any_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "enum": [ "image", "video", "pdf", "dicom" ], "type": "string", "x-struct": null, "x-validate": null }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Matches items based on whether the values from the subject have none of the values specified in the filter", "properties": { "name": { "enum": [ "none_of" ], "type": "string", "x-struct": null, "x-validate": null }, "values": { "items": { "enum": [ "image", "video", "pdf", "dicom" ], "type": "string", "x-struct": null, "x-validate": null }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "name", "values" ], "type": "object", "x-struct": null, "x-validate": null } ], "x-struct": null, "x-validate": null }, "subject": { "enum": [ "file_type" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "subject", "matcher" ], "title": "DatasetsV2.AdvancedFilters.FileTypeFilter", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.AdvancedFilters.FileTypeFilter", "x-validate": null }, "DatasetsV2.AdvancedFilters.TextPropertyValueFilter": { "additionalProperties": false, "description": "Filter items based on their text property values. You can filter using the `contains` matcher to search for text within a specific property. You must specify both the search value and the property_id to search within.", "properties": { "matcher": { "description": "Matches items based on whether the values from the subject contains the one specified in the filter", "properties": { "name": { "enum": [ "contains" ], "type": "string", "x-struct": null, "x-validate": null }, "value": { "properties": { "property_id": { "$ref": "#/components/schemas/Common.UUID" }, "value": { "description": "The string to search by", "maxLength": 1000, "minLength": 3, "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "property_id", "value" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "name", "value" ], "type": "object", "x-struct": null, "x-validate": null }, "subject": { "enum": [ "text_property_value" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "subject", "matcher" ], "title": "DatasetsV2.AdvancedFilters.TextPropertyValueFilter", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.AdvancedFilters.TextPropertyValueFilter", "x-validate": null }, "Report.Type": { "default": "annotator", "description": "Report type.", "enum": [ "annotator", "item" ], "title": "Report.Type", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.Report.Type", "x-validate": null }, "DatasetsV2.AdvancedFilters.OptionalFilter": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.AdvancedFilters.Filter" }, { "$ref": "#/components/schemas/DatasetsV2.AdvancedFilters.UnfilteredFilter" } ], "title": "DatasetsV2.AdvancedFilters.OptionalFilter", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.AdvancedFilters.OptionalFilter", "x-validate": null }, "Common.UUID": { "example": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "title": "Common.UUID", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.Common.UUID", "x-validate": null }, "DatasetsV2.AdvancedFilters.Filter": { "description": "Filter can be `simple` or `group`. If you want to filter by one `subject` eg. `item name`. You can specify `simple filter` for given `subject` and `matcher`. For more details please see details of `item name filter` or other simple filters. If you want to to filter item by more than one filter You need to use `group filter` which gives possibility to join `filters` using `and`, `or` operators.", "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.AdvancedFilters.GroupFilter" }, { "$ref": "#/components/schemas/DatasetsV2.AdvancedFilters.SimpleFilter" } ], "title": "DatasetsV2.AdvancedFilters.Filter", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.AdvancedFilters.Filter", "x-validate": null }, "DatasetsV2.AdvancedFilters.WorkflowStageEnteredAtFilter": { "additionalProperties": false, "description": "Filter items based on the entered date to a specific workflow stage provided in the `stage_id` field. You can filter items that were entered `before` or `after`. You can also filter using range specified as `before`, `after`. Please keep in mind that `after` is inclusive while `before` is exclusive", "properties": { "matcher": { "anyOf": [ { "properties": { "before": { "$ref": "#/components/schemas/Common.DateTime" }, "name": { "enum": [ "date_range" ], "type": "string", "x-struct": null, "x-validate": null }, "stage_id": { "$ref": "#/components/schemas/Common.UUID" } }, "required": [ "name", "stage_id", "before" ], "type": "object", "x-struct": null, "x-validate": null }, { "properties": { "after": { "$ref": "#/components/schemas/Common.DateTime" }, "name": { "enum": [ "date_range" ], "type": "string", "x-struct": null, "x-validate": null }, "stage_id": { "$ref": "#/components/schemas/Common.UUID" } }, "required": [ "name", "stage_id", "after" ], "type": "object", "x-struct": null, "x-validate": null } ], "description": "Matches items based on stage id and whether the values from the subject are in the range specified by before and/or after", "x-struct": null, "x-validate": null }, "subject": { "enum": [ "workflow_stage_entered_at" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "subject", "matcher" ], "title": "DatasetsV2.AdvancedFilters.WorkflowStageEnteredAtFilter", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.AdvancedFilters.WorkflowStageEnteredAtFilter", "x-validate": null }, "DatasetsV2.AdvancedFilters.GroupFilter": { "additionalProperties": false, "description": "Groups `simple` or `group filters` together with `or`, `and` operators. You have to specify at least one `filter`.", "properties": { "conjunction": { "$ref": "#/components/schemas/DatasetsV2.AdvancedFilters.Conjunction" }, "filters": { "description": "List of `simple` or `group` filters", "items": { "$ref": "#/components/schemas/DatasetsV2.AdvancedFilters.Filter" }, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "conjunction", "filters" ], "title": "DatasetsV2.AdvancedFilters.GroupFilter", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.AdvancedFilters.GroupFilter", "x-validate": null } }, "securitySchemes": { "ApiKeyAuth": { "description": "Prefix the value with 'ApiKey '.", "in": "header", "name": "Authorization", "type": "apiKey" }, "BearerAuth": { "scheme": "bearer", "type": "http" } } }, "info": { "title": "Darwin", "version": "1.0" }, "openapi": "3.0.0", "paths": { "/api/v3/teams/{team_slug}/reports/jobs": { "post": { "callbacks": {}, "description": "Starts a background job to generate an 'annotator' or 'item' report.\nImmediately returns job info, containing the file URL to get the report from.\n\n\nNote:\n- The 'annotator' report data is available from 2024-11-05\n- The 'item' report data is available from 2025-08-01\n", "operationId": "create-report-job", "parameters": [ { "description": "Team's sluggified name", "example": "my-team", "in": "path", "name": "team_slug", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Report.JobRequest" } } }, "description": "Report.JobRequest", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Report.JobResponse" } } }, "description": "Report.JobResponse" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common.APIError" } } }, "description": "Common.APIError" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common.APIError" } } }, "description": "Common.APIError" }, "422": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/JsonErrorResponse" }, { "$ref": "#/components/schemas/Common.APIError" } ], "x-struct": null, "x-validate": null } } }, "description": "Unprocessible Entity" } }, "summary": "Create a job to generate a report", "tags": [ "Reports" ] } } }, "security": [ { "BearerAuth": [] }, { "ApiKeyAuth": [] } ], "servers": [ { "url": "https://darwin.v7labs.com", "variables": {} } ] } ```