v3
latestOpenAPI 3.1.02026-07-31115157197.4 KBGet Example Table
Resolve the animal-name namespace and a representative table for a dataset.
Pre-filled context (cut/lag provided): uses the entitled SKU. Dropdown context (cut/lag omitted): returns any table from the graph.
catalog selects which polaris catalog to source the example from. The SQL editor's "Connect your query engine" entry passes sample so the example reflects the lagged tables actually populated in the sample warehouse the user just queried; everything else defaults to bulk.
Auth + per-client entitlement are enforced by the parent router in api.py (bearer token via get_authenticated_user plus _require_example_table_access, which 404s datasets denied to the caller or globally disabled); no redundant per-endpoint dep needed here.
Path parameters
Query parameters
Response
Successful Response