Two functions on the same route:
entity = "$metadata"→ EDMX (XML) document with the EDM types of the columns.entity = "<tabela>"(a table name) → a page of the EntitySet with server-driven pagination.
Summary#
| Method · route | GET /api/v1/odata/{entity} |
| Base | https://ingestia.io |
| Auth | API key (Authorization: Bearer or ?api_key=) |
| Role (RBAC) | data export (member+); data key = owner |
| Cost | actual bytes processed in the datalake; $count=true runs an additional COUNT(*) |
| Statuses | 200 · 400 · 401 · 403 · 404 · 429 · 402 · 501 · 503 |
Supported OData options (honest pushdown)#
| Option | Becomes | Notes |
|---|---|---|
$select | column projection | reduces bytes read |
$filter | eq/ne/gt/ge/lt/le, and/or/not, contains/startswith/endswith | outside the subset → 501 |
$orderby | ORDER BY | total order (stable pagination) |
$top / $skip | limit/offset | page of up to 1,000 rows |
$count=true | @odata.count | COUNT(*) included in the cost |
Prefer: odata.maxpagesize=N | shrinks the page | responds with Preference-Applied |
We never ignore a filter
An option outside the subset ($expand, $apply, $search, $compute, any/all
lambdas, arithmetic in filters) responds with an explicit 501 listing what is
supported — a silently wrong result would be worse.
Example — $metadata#
curl -H "Authorization: Bearer ing_live_EXEMPLO" \
https://ingestia.io/api/v1/odata/\$metadataconst res = await fetch("https://ingestia.io/api/v1/odata/$metadata", {
headers: { Authorization: "Bearer ing_live_EXEMPLO" },
});
const edmxXml = await res.text();import requests
res = requests.get(
"https://ingestia.io/api/v1/odata/$metadata",
headers={"Authorization": "Bearer ing_live_EXEMPLO"},
)
edmx_xml = res.textExample — page of an entity#
curl -H "Authorization: Bearer ing_live_EXEMPLO" \
"https://ingestia.io/api/v1/odata/vendas?\$select=data,total&\$filter=data ge 2026-01-01&\$orderby=data&\$count=true"const params = new URLSearchParams({
"$select": "data,total",
"$filter": "data ge 2026-01-01",
"$orderby": "data",
"$count": "true",
});
const res = await fetch(`https://ingestia.io/api/v1/odata/vendas?${params}`, {
headers: { Authorization: "Bearer ing_live_EXEMPLO" },
});
const pagina = await res.json();import requests
res = requests.get(
"https://ingestia.io/api/v1/odata/vendas",
params={
"$select": "data,total",
"$filter": "data ge 2026-01-01",
"$orderby": "data",
"$count": "true",
},
headers={"Authorization": "Bearer ing_live_EXEMPLO"},
)
pagina = res.json()200 response (page)#
json
{
"@odata.context": "https://ingestia.io/api/v1/odata/$metadata#vendas",
"@odata.count": 12345,
"value": [ { "data": "2026-01-02", "total": 987.65 } ],
"@odata.nextLink": "https://ingestia.io/api/v1/odata/vendas?...$skiptoken=..."
}Follow the
@odata.nextLink exactly
The link carries an opaque $skiptoken. A tampered token responds with 400.
Power BI/Excel follow the nextLink automatically until the end.
Errors#
| Code | When |
|---|---|
400 | invalid $skiptoken / pagination beyond 1,000,000 rows |
401 | missing/invalid key |
403 | insufficient role/scope |
404 | EntitySet does not exist (also prevents enumeration) |
501 | OData option outside the subset |
429 · 402 | rate limit / overdue payment |
503 | datalake not provisioned / own cloud down |
Cost#
- Charged by the actual bytes;
$select/$filterreduce what is read (pushdown). - Every call leaves its cost attributed in the audit log
(
api.odata.read, with bytes, page, and key).
Security#
- Read-only, workspace scope; PII columns and
STRUCT/RECORDare excluded from the feed. Own cloud down →503(never an empty collection, which Excel would read as "the table was emptied").
Related#
Last reviewed: 2026-09-08.