Get Model Data

GET
/api/v1/extraction-schema/get-all-data

Retrieve all processed data for a model in a simplified, flattened JSON format. Perfect for bulk data export, analytics, and integration with external systems.

Use Cases

Bulk Data Export

Export all processed documents from a model for analysis, reporting, or migration to other systems.

System Integration

Integrate extracted data with CRM, ERP, or analytics platforms using a clean, simplified data structure.

Key Features

Simplified Structure

Nested tables appear as direct properties, making the data easy to consume without complex parsing.

File-based Organization

Data is organized by filename, making it clear which information came from which document.

Smart Arrays

Single items are returned as objects, multiple items as arrays, reducing unnecessary nesting.

Normalized Names

Column and table names are automatically normalized to lowercase with underscores, making them API-friendly and consistent.

Column Name Normalization

To ensure API consistency and developer-friendly field names, all column and table names are automatically normalized in the response.

Normalization Rules
How column names are transformed for the API response

Transformation Process:

  1. 1. Convert to lowercase
  2. 2. Replace spaces with underscores
  3. 3. Replace forward slashes with underscores
  4. 4. Remove other special characters (keep only letters, numbers, underscores)
  5. 5. Replace multiple underscores with single underscores
  6. 6. Remove leading/trailing underscores

Examples:

"Invoice Number""invoice_number"
"Total Amount ($)""total_amount"
"Client's Email""clients_email"
"Line Items""line_items"
"Date/Time""date_time"
Duplicate Name Detection
The API automatically detects and prevents naming conflicts

If multiple columns normalize to the same name, the API will return a 400 error with details about the conflicting columns.

Example Conflict:

Columns: "Client Name" and "Client-Name"
Both normalize to: "client_name"
Solution: Rename one column in your model to avoid the conflict

Request Parameters

Query Parameters
required
extractionSchemaIdstring

The unique identifier of the model to retrieve data for.

Headers
required
Authorizationstring

Bearer token for authentication.

Response Format

The endpoint returns a simplified JSON structure organized by filename, with nested tables as direct properties and smart array handling.

Multiple Rows Example
When a primary table has multiple rows, they are returned as an array
multiple-rows-response.json
Single Row Example
When a primary table has only one row, it's returned as a direct object
single-row-response.json
Empty Response
When no data is found for the model
empty-response.json

Usage Examples

usage-examples.js

Data Processing Examples

Export to CSV
Convert the simplified JSON data to CSV format for analysis
csv-export.js
Aggregate Statistics
Calculate summary statistics across all processed documents
aggregate-stats.js

Error Responses

Common Error Responses
error-responses.json