The OData v4 feed (Power BI/Excel) and the Embed SDK are available. The REST query API (
/api/v1/query,/api/v1/tables) is in early access and not yet open for external use.
This section documents how to integrate external systems with your ingestia.io datalake: key-based authentication, the data feeds (OData/Power BI/Excel), the dashboard embed SDK, the error format, pagination, limits, and the status of each surface.
Section map#
| Page | What it covers | Status |
|---|---|---|
| Authentication | API keys, scope, roles, revocation | Available |
| Query API (REST) | /api/v1/query and /api/v1/tables | Early access |
| OData v4 · Power BI · Excel | Native feed for Power BI/Excel | Available |
| Embed SDK | Dashboard inside your own system (signed token) | Available |
| Errors, limits, and rate limit | HTTP codes, pagination, idempotency, webhooks | Available |
Statuses — what each one means#
- Available — works, is documented and can be used in production. Contract changes are announced in advance. Platform availability follows the 99.5% monthly SLA from the Growth plan up (see /legal/sla); follow it at /status.
- Early access — the capability exists, but is not yet open for external use: the contract may change with notice. Do not build critical integrations on it yet. This is the case for the REST query API.
- Planned — not available yet (e.g., webhook subscriptions).
General conventions#
- Base:
https://ingestia.io. All data routes live under/api/v1. - Workspace scope (inviolable): every credential is scoped to the workspace
that issued it. The API never crosses datasets/buckets between customers and
only exposes the published marts (
*_goldand*_silver) — never the bronze layer. - Read-only: there is no write API. Every route is
GET(orPOSTonly to send aSELECT). That is why calls are idempotent by nature (see Errors and limits). - Response format: JSON (
application/json; charset=utf-8); OData responds with JSON and$metadatain XML (EDMX). - Error format: always
{ "error": "mensagem em português" }(a message in Portuguese) with the matching HTTP code. The full catalog is in Errors and limits. - CORS: data routes respond to
OPTIONS(preflight) and allowAuthorizationandContent-Type. - Scope header: every response includes
X-Ingestia-Access-Scope: workspace— a reminder that the credential reads the entire workspace, not a single user. - Transparent cost: every paid extraction returns
x-ingestia-cost-brlwith the cost of the call. The BRL amount is a projection, not a guaranteed billed price today. - N−1 compatibility: versioned formats (widgets, filters, theme, URL state, embed token) keep reading the previous version; an unknown field is never silently discarded.
Developer support#
Integration questions, adding your domain to the embed allowlist, or reporting an error: see Support Center and Troubleshooting.
Next steps: Authentication → OData/Power BI.