API Reference

Pipelines

Documents

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Pipeline Document Status Counts

Deprecated

DocumentGetStatusCountsResponse Pipelines.Documents.GetStatusCounts(DocumentGetStatusCountsParamsparameters, CancellationTokencancellationToken = default)

GET/api/v1/pipelines/{pipeline_id}/documents/status-counts

Count the documents in a pipeline, grouped by ingestion status.

Counts reflect each document’s last recorded status rather than a freshly computed one, so a document that changed status in the last few moments may still be counted under its previous one. Use GET /pipelines/{pipeline_id}/documents/{document_id}/status when a single document’s status has to be up to the moment.

ParametersExpand Collapse

DocumentGetStatusCountsParams parameters

required string pipelineID

string? dataSourceID

string? fileID

Boolean onlyDirectUpload

string? projectID

ReturnsExpand Collapse

class DocumentGetStatusCountsResponse:

Counts of the documents in a pipeline, grouped by ingestion status.

required IReadOnlyDictionary<string, Long> Counts

Number of documents per ingestion status; every status is present.

required string PipelineID

ID of the pipeline the documents belong to.

formatuuid

required Long TotalCount

Total number of documents counted.

string? DataSourceID

Data source the counts were restricted to.

formatuuid

string? FileID

File the counts were restricted to.

formatuuid

Boolean OnlyDirectUpload

Whether only directly uploaded documents were counted.

Get Pipeline Document Status Counts

C#

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

DocumentGetStatusCountsParams parameters = new()
{
    PipelineID = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
};

var response = await client.Pipelines.Documents.GetStatusCounts(parameters);

Console.WriteLine(response);

200 example

{
  "counts": {
    "foo": 0
  },
  "pipeline_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "total_count": 0,
  "data_source_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "file_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "only_direct_upload": true
}

Returns Examples

200 example

{
  "counts": {
    "foo": 0
  },
  "pipeline_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "total_count": 0,
  "data_source_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "file_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "only_direct_upload": true
}