On this page
Query table data through the API
Page through Golden table records through the API, inspect rows, apply supported filters, and run administrator data operations.
Tables expose paged record reads to every built-in role within its data grants. Creating, clearing,
loading, transforming, or exporting a table requires ADMIN.
Browser users should start with Find and inspect records in the web application. This page documents the equivalent API reads and administrator data operations.
Page through records
curl --fail-with-body --silent --show-error \
--header "Authorization: Bearer ${GOLDEN_TOKEN}" \
"${GOLDEN_URL}/api/tables/sample_customer/records?pageNumber=0&pageSize=50"
Supported query parameters include:
| Parameter | Purpose |
|---|---|
type | Select TABLE (the default) or HISTORY records |
pageNumber, pageSize | Control pagination |
filterError | true selects records with quality errors; false or omission leaves this filter off |
filterUpdatedAfter, filterUpdatedBefore | Inclusive lower and upper update-time bounds |
filterQualityGreater, filterQualityLess | Inclusive lower and upper quality bounds, from 0 to 100 |
filterSource, filterSourceId | Match provenance source and source identifier; when combined, both must match the same provenance entry |
Use the running explorer, where enabled, for exact parameter formats and defaults. These are structured filters; the endpoint does not accept an arbitrary SQL expression.
Find the record that holds a source pair
To find the record that holds an exact provenance pair, read the entity’s
table with both filterSource and filterSourceId:
curl --fail-with-body --silent --show-error \
--header "Authorization: Bearer ${GOLDEN_TOKEN}" \
--get \
--data-urlencode "filterSource=sample-source-crm" \
--data-urlencode "filterSourceId=CRM-0001" \
"${GOLDEN_URL}/api/tables/sample_customer/records"
The two parameters match one _source entry carrying both values, never two
entries that carry one each. type defaults to TABLE, so the answer is the
live records that hold the pair. There can be several when lineageUnique is
off or was enabled over existing duplicates. After a merge the survivor’s
_source holds the pairs of the records it absorbed. Request type=HISTORY to
find archived rows that hold it.
This read is the lookup by pair. A record search cannot
take a pair as its only criterion: its filter only narrows what the search
record found.
Read one record
curl --fail-with-body --silent --show-error \
--header "Authorization: Bearer ${GOLDEN_TOKEN}" \
"${GOLDEN_URL}/api/tables/sample_customer/records/CRM-0001?type=TABLE&expanded=true"
The response includes the table and record. An expanded response can also
include related dataset, column, and merge information, but never inline audit.
Read events through the dedicated audit endpoint. When an entity assigns a data view, the resolved view is included
so clients can reproduce its presentation choices.
A record absent from the requested current/history collection may be returned
from the other collection with servedFromOtherTable:true. Check that flag and
record metadata before treating a successful read as proof the record is current.
Read history
If the table was created with history: true, request type=HISTORY from the
same record endpoints. History availability depends on that table setting and
the operation that changed the record; do not assume every prior state is
retained. History is versioned: the list shows identities that are not live at
their latest version. Independent table loads also consult history.
Restore a deleted record
For an entity table with history, a STEWARD or ADMIN can call
POST /api/golden/{entity}/restore with the deleted _id and an optional
comment. There is no restore route for a table outside an entity.
Run data operations
Golden provides administrator operations for configured flows:
POST /api/tables/loadreads through a configured source into a table.POST /api/tables/transformapplies configured transformation behavior.POST /api/tables/exportcreates downloadable data files. Entity destinations use the separate delivery workflow.
These operations use resource identifiers in operation-specific request bodies and can create asynchronous tasks. Obtain the exact schema from the target deployment, test with controlled data, and follow the returned task.
Clear a table
curl --fail-with-body --silent --show-error \
--request PUT \
--header "Authorization: Bearer ${GOLDEN_ADMIN_TOKEN}" \
"${GOLDEN_URL}/api/tables/clear/customers"