Skip to content

Automatic translation — the Portuguese version is the reference. View in Portuguese

Updated on 2026-09-08

Endpoint: GET /api/v1/odata/{entity}

Reference for the OData EntitySet (server-driven paginated rows) and the $metadata document (EDMX) — with honest pushdown of $select/$filter/$orderby/$top/$count.

On this page (9)

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 · routeGET /api/v1/odata/{entity}
Basehttps://ingestia.io
AuthAPI key (Authorization: Bearer or ?api_key=)
Role (RBAC)data export (member+); data key = owner
Costactual bytes processed in the datalake; $count=true runs an additional COUNT(*)
Statuses200 · 400 · 401 · 403 · 404 · 429 · 402 · 501 · 503

Supported OData options (honest pushdown)#

OptionBecomesNotes
$selectcolumn projectionreduces bytes read
$filtereq/ne/gt/ge/lt/le, and/or/not, contains/startswith/endswithoutside the subset → 501
$orderbyORDER BYtotal order (stable pagination)
$top / $skiplimit/offsetpage of up to 1,000 rows
$count=true@odata.countCOUNT(*) included in the cost
Prefer: odata.maxpagesize=Nshrinks the pageresponds 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/\$metadata

Example — 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"

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#

CodeWhen
400invalid $skiptoken / pagination beyond 1,000,000 rows
401missing/invalid key
403insufficient role/scope
404EntitySet does not exist (also prevents enumeration)
501OData option outside the subset
429 · 402rate limit / overdue payment
503datalake not provisioned / own cloud down

Cost#

  • Charged by the actual bytes; $select/$filter reduce 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/RECORD are 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.

Related links