Sign in

v1

latestOpenAPI 3.1.02026-07-24239123562.1 KB
Connectors

Get a Connector's reported files

:warning: This is a new API which is still subject to change.

Use this endpoint to get metadata about the files reported by a Connector, including those that have not yet been uploaded or that have failed.

get/v1/data-acquisition/connectors/{id}/files

Path parameters

idstring required

The Connector's id.

Query parameters

fileIdsstring[]

A list of file ids to filter by.

excludeFileIdsstring[]

A list of file ids to exclude from the response.

uniqueExternalIdsstring[]

A list of unique external ids to filter by. Used by Connectors to deduplicate external files.

excludeUniqueExternalIdsstring[]

A list of unique external ids to exclude from the response. Used by Connectors to deduplicate external files.

statusesstring[]

A list of file statuses to filter by.

maxErrorsnumber

The maximum number of errors to filter by. Used by Connectors to limit file upload retries.

createdBeforestring date-time

The maximum creation date to filter by.

createdAfterstring date-time

The minimum creation date to filter by.

updatedBeforestring date-time

The maximum update date to filter by.

updatedAfterstring date-time

The minimum update date to filter by.

orderBy'filepath' | 'status' | 'errorCount' | 'updatedAt' | 'createdAt'

The field to order by.

orderDirection'ASC' | 'DESC'

The order direction.

takenumber

The number of files to take. Default is 50.

skipnumber

The number of files to skip.

Response

Successful response with a list of files reported by a Connector

totalnumber required