Data Generation API Access

This page covers the Data Generation API endpoint used to read generated rows.

This is separate from API Mocking.

What This API Is For

Use this API when you want to programmatically fetch generated data from a parsed schema/table output.

Use API Mocking docs when you want to simulate custom application endpoints and scenario-based responses.

Prerequisites

• You have generated data for a schema and table.
• You created an API token in Settings API.
• You are authenticated with Authorization: Bearer YOUR_API_TOKEN.

Create an API Token

1. Go to Settings API.
2. Enter a token name.
3. Create a new token.
4. Copy and store the token safely.

Endpoint Format

GET /api/{schemaId}/{table}

Example:

GET https://your-domain/api/019c.../users

Query Parameters

rows

• Purpose: total rows to return in this request stream.
• Default: 100
• Note: value is capped by your plan rows_per_table limit.

columns

• Purpose: comma-separated subset of fields.
• Example: columns=id,email,created_at
• If omitted, all fields are returned.

page and limit

• Purpose: pagination controls.
• page default: 1
• limit default: 100
• Internal offset is computed as (page - 1) * limit.

offset (UI-level)

The API modal includes an offset control for convenience, but server-side pagination behavior is page/limit based. Treat page and limit as canonical.

Example Request

curl -X GET 'https://your-domain/api/SCHEMA_ID/users?rows=100&columns=id,email&limit=50&page=1' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Accept: application/json'

Response Shape

{
    "meta": {
        "total": 1200,
        "rows_requested": 100,
        "limit": 50,
        "offset": 0,
        "page": 1
    },
    "data": [
        {
            "id": 1,
            "email": "[email protected]"
        }
    ]
}

Usage Limits and Metering

• Each successful request increments api_requests_used.
• If usage exceeds your plan api_requests_limit, API returns 429.
• The modal shows current usage and percentage used.

Common Status Codes

• 200 Success
• 401 Unauthenticated token
• 404 Schema or table file not found
• 429 Plan API request limit exceeded
• 500 Internal server error

Practical Usage Patterns

Data QA

Pull a filtered column set (id,status,created_at) to validate distribution and quality quickly.

Fixture Sync

Fetch a fixed page/limit window and seed integration tests with predictable snapshots.

Lightweight Dashboards

Query generated rows for internal demo dashboards without exporting full files.

Troubleshooting

401 Unauthenticated

• Ensure token exists and is copied correctly.
• Ensure Authorization header starts with Bearer .

404 Schema or table not found

• Confirm schema ID matches generated output.
• Confirm table name matches exactly.
• Regenerate data if files are missing.

429 Limit exceeded

• Check usage in the API modal.
• Reduce request frequency or upgrade plan.

Empty data array

• Increase rows.
• Verify columns names exist.
• Check requested page is in range.