Read one dataset's bounded structured ingest report
GET
/v1/datasets/ingest-report
const url = 'https://example.com/v1/datasets/ingest-report?path=example';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://example.com/v1/datasets/ingest-report?path=example'Read only meta/ingest_report.json under the server’s 8 MiB cap.
This metadata endpoint has no caller-controlled file parameter. Generic
file previews remain body-free and bulk payloads continue to use direct
object-storage capabilities. ref lets an uploader pin the read to
the commit its own publication created, since the branch tip may already
carry a concurrent re-upload’s findings.
Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ” path
required
Dataset path (org/name)
string
Dataset path (org/name)
ref
Branch / tag / commit (default main)
string | null
Branch / tag / commit (default main)
Header Parameters
Section titled “Header Parameters ” x-api-key
string | null
Responses
Section titled “ Responses ”Structured report or an explicit omission reason
Media type application/json
Example generated
exampleThe canonical ingest report does not exist
Validation Error
Media type application/json
HTTPValidationError
object
detail
Array<object>
ValidationErrorobject
loc
required
Location
Array<string | integer>
msg
required
Message
string
type
required
Error Type
string
input
ctx
Context
object
Example generated
{ "detail": [ { "loc": [ "example" ], "msg": "example", "type": "example", "input": "example", "ctx": {} } ]}