Query disclosure tables
uslobbying_dataframe_queryRun one read-only SELECT over staged disclosure tables, materialize the complete result, then retrieve whole rows by result_table and next_offset without rerunning SQL. Each call returns row_limit rows, or the rest of the result when fewer remain. Rows follow the materialized SQL result order set by a top-level ORDER BY; an ORDER BY only inside a CTE or subquery does not guarantee it, and without one the order is fixed once materialized. Inspect columns with uslobbying_dataframe_describe first.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"canvas_id": "<canvas_id>"
},
"name": "uslobbying_dataframe_query"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sql | No | One read-only SELECT; exclusive with result_table and offset. | |
| offset | No | Row offset into result_table, default zero, in the materialized SQL result order set by a top-level ORDER BY; an ORDER BY only inside a CTE or subquery does not guarantee it. An offset equal to row_count returns no rows. | |
| canvas_id | Yes | Canvas token returned by a disclosure analytical tool. | |
| row_limit | No | Whole rows to return, default 25, at most 100 per call; larger values clamp to 100, then to any lower provider ceiling, and the clamp is disclosed in delivery_limits. | |
| register_as | No | Fresh result table name for a new SQL call; omit for a generated name. | |
| result_table | No | Previously materialized result table; exclusive with sql and register_as. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rows | No | Whole JSON-safe rows. | |
| error | No | Present when the call failed. Absent on success. | |
| offset | No | Starting row offset in the materialized SQL result order, which a top-level ORDER BY sets; an ORDER BY only inside a CTE or subquery does not guarantee it. | |
| columns | No | Complete result schema. | |
| dataset | No | Materialized dataset and routing. | |
| guidance | No | Table names and dataframe instructions. | |
| canvas_id | No | Tenant-scoped canvas access token. | |
| row_count | No | Exact materialized result count. | |
| row_order | No | Rows follow the materialized SQL result order set by a top-level ORDER BY; an ORDER BY only inside a CTE or subquery does not guarantee it, and without one the order is fixed once materialized. | |
| truncated | No | More materialized rows remain; continue with next_offset. | |
| query_tool | No | Query or retrieve materialized table rows. | |
| next_offset | No | Next undelivered row offset. | |
| result_table | No | Stable materialized result table. | |
| describe_tool | No | Inspect exact table schemas before SQL. | |
| rows_returned | No | Rows actually delivered. | |
| delivery_limits | No | Clamped controls for this call; an empty map means no clamp. Immediate cursor replay retains its original values. | |
| output_complete | No | Whether this result has no remaining delivery rows. | |
| effective_row_limit | No | Effective row limit when a delivery or provider ceiling lowers the requested limit. |