API referenceValidation
Get a data group’s typed dataset
GET
/extractions/{id}/datasetReturns one data group’s extracted values as a typed table: one row per document, section and record, one column per schema field. Reads current validation values, so documents appear as soon as they are extracted, with edits applied. Values are typed by the data group’s active schema; values that do not read as their type are null and counted per column. ?format=xlsx|csv returns a spreadsheet with real number and date cells, or a CSV.
Authorization
bearerAuth AuthorizationBearer <token>
An API key created in Settings → API Keys.
In: header
Path Parameters
id*string
Format
uuidQuery Parameters
dataGroupId*string
The data group to read. Must belong to the project’s model.
Format
uuidformat?string
json (default) | xlsx | csv
Value in
- "json"
- "xlsx"
- "csv"
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/extractions/497f6eca-6276-4993-bfeb-53cbbbba6f08/dataset?dataGroupId=497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "data": { "dataGroupId": "8488a14d-7eb2-49b5-ad00-46d2c399fd09", "dataGroupName": "string", "schemaSource": "builder", "columns": [ { "key": "string", "label": "string", "origin": "schema", "type": "string", "order": 0, "inSchema": true, "distinctCount": 0, "unreadableCount": 0 } ], "rows": [ { "rowId": "string", "associationId": "86c2871c-672a-47a4-b9a4-9a75fd0329c2", "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052", "documentName": "string", "isPublic": true, "section": "string", "sectionOrder": 0, "recordPosition": 0, "validationStatus": "NOT_STARTED", "values": {}, "raw": { "property1": "string", "property2": "string" }, "unreadable": [ "string" ] } ], "sections": [ "string" ] }, "meta": { "requestId": "string", "timestamp": "string" }}