Sign in
Queue

Export annotations

Export annotations from the queue in XML, CSV, JSON or XLSX format.

Output format is negotiated by Accept header or format parameter. Supported formats are: csv, xml, xlsx and json.

Calling GET will give you results for all the annotations with any of the selected status.

get/api/v1/queues/{id}/export

Path parameters

idinteger required

Queue ID

Query parameters

format'csv' | 'xml' | 'json' | 'xlsx'

Output format.

columnsstring

Columns to include in CSV/XLSX output (comma-separated schema_ids and meta-columns).

prepend_columnsstring

Columns to prepend at the beginning of CSV/XLSX output.

append_columnsstring

Columns to append at the end of CSV/XLSX output.

delimiterstring

One-character string used to separate fields in CSV.

quote_charstring

One-character string used to quote fields containing special characters in CSV.

quoting'quote_minimal' | 'quote_none' | 'quote_all' | 'quote_non_numeric'

Controls when quotes should be generated in CSV.

escape_charstring

One-character string used by the writer to escape the delimiter in CSV.

idinteger[]

Object ID(s) filter

statusstring

Annotation status filter.

modifierinteger

User id filter.

arrived_at_beforestring date-time

ISO 8601 timestamp filter.

arrived_at_afterstring date-time

ISO 8601 timestamp filter.

exported_at_beforestring date-time

ISO 8601 timestamp filter.

exported_at_afterstring date-time

ISO 8601 timestamp filter.

export_failed_at_beforestring date-time

ISO 8601 timestamp filter.

export_failed_at_afterstring date-time

ISO 8601 timestamp filter.

page_sizeinteger

Number of results per page

cursorstring

A value used for cursor-based pagination. Obtain this value from the next or previous URLs in a paginated response. Do not construct cursor values manually.

searchstring

Search filter (limited to 10,000 results).

Response

OK

object required

Changes

No recorded changes to this endpoint across all 1 revision of this API.