List document paths
GET/pipelines/:pipeline_id/paths
Returns the paths of the documents in a pipeline that match the path pattern, with the number of documents at each path, ordered by the bytes of the path. The list counts the current document versions, or the versions that were current at the time given in as_of, and omits paths without such a version. The response does not use the list envelope: first sets the page size, from 1 to 1,000 with a default of 100, and next holds the last path of a full page, which the request for the next page passes in after.
Permissions. Read on the pipeline. The list counts only the versions whose classification the classification allow-list of the key covers.
Document paths describes the path list and the path patterns.
Request
Responses
- 200
- 400
- 401
- 404
The body holds data, the paths of the page with the number of documents at each path, and next, the value of after for the next page, or null on the last page.
The as_of value lies outside the range of valid timestamps (Invalid version), or path is not a valid path pattern or another query parameter has an invalid value. The second case has a plain-text body (Failed to deserialize query string: <reason>).
The authentication headers are missing or invalid, or the API key is inactive or expired. Errors lists the messages.
No pipeline with this identifier exists, or the key lacks read permission on the pipeline (Pipeline with id <id> not found).