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', headers: {'X-API-Key': '<X-API-Key>'}};
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' \ --header 'X-API-Key: <X-API-Key>'Read only meta/ingest_report.json under the server’s 8 MiB cap.
This metadata endpoint has no caller-controlled file parameter; bulk
payloads 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.
Authorizations
Section titled “Authorizations ”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)
Responses
Section titled “ Responses ”Structured report or an explicit omission reason
Media type application/json
Example generated
exampleInvalid or missing API key
Media type application/json
ErrorResponse
Standard error response.
object
detail
required
Error message describing what went wrong
string
Example generated
{ "detail": "example"}The 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": {} } ]}