Bigquery: Actions/run Semantic Query

Answer a business question from BigQuery by picking metrics, dimensions and filters defined in your semantic layer.

Tool ID: bigquery_run_semantic_query

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'bigquery_run_semantic_query',
  {
    "credentials": {
      "service_account_json": "example"
    },
    "name": "Example",
    "output_df_name": "Example"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute bigquery_run_semantic_query --input '{
  "credentials": {
    "service_account_json": "example"
  },
  "name": "Example",
  "output_df_name": "Example"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "rows": [
      {}
    ],
    "rowCount": 123,
    "limited": true,
    "columns": [
      "example"
    ],
    "jobId": "job_123",
    "sql": "SELECT * FROM companies LIMIT 10"
  }
}

Use deepline describe bigquery_run_semantic_query --json for the latest machine-readable contract.

Input reference

Render a stored BigQuery semantic layer query and execute it.

Name	Type	Required	Default	Details
`payload.credentials`	`object`	No	—	—
`payload.name`	`string`	No	—	—
`payload.output_df_name`	`string`	No	—	—
`payload.renderer_version`	`"v2"`	No	—	—
`payload.type`	`"metrics" \| "funnel" \| null`	No	—	—
`payload.params`	`object \| null`	No	—	—
`payload.table_name`	`string`	No	—	Legacy semantic table name.
`payload.metrics`	`array`	No	—	—
`payload.dimensions`	`array`	No	—	—
`payload.custom_dimensions`	`array`	No	—	—
`payload.facts`	`array`	No	—	—
`payload.filters`	`array`	No	—	—
`payload.custom_filter_expressions`	`array`	No	—	—
`payload.rowLimit`	`integer`	No	`5000`	Maximum number of rows to return. Default 5000.
`payload.timeoutMs`	`integer`	No	`120000`	BigQuery statement timeout in milliseconds. Default 120000.

Output reference

BigQuery semantic query result.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Semantic query response payload.
`result.data.rows`	`array`	Yes	—	—
`result.data.rowCount`	`integer`	Yes	—	—
`result.data.limited`	`boolean`	Yes	—	—
`result.data.columns`	`array`	Yes	—	—
`result.data.jobId`	`string \| null`	Yes	—	—
`result.data.sql`	`string`	Yes	—	—
`result.data.dataset`	`object`	No	—	—
`result.data.dataset.kind`	`"bigquery_query"`	Yes	—	—
`result.data.dataset.total_rows`	`integer`	Yes	—	—
`result.data.dataset.returned_limit`	`integer`	Yes	—	—
`result.data.dataset.offset`	`integer`	Yes	—	—
`result.data.dataset.page_size`	`integer`	Yes	—	—
`result.meta`	`object`	No	—	—
`result.meta.projectId`	`string`	Yes	—	—
`result.meta.defaultDataset`	`string \| null`	Yes	—	—
`result.meta.location`	`string \| null`	Yes	—	—
`result.meta.rowLimit`	`integer`	Yes	—	—
`result.meta.timeoutMs`	`integer`	Yes	—	—
`result.meta.rendererVersion`	`"v2"`	Yes	—	—
`result.meta.semanticLayerHash`	`string`	Yes	—	—
`result.meta.dataset`	`object`	No	—	—
`result.meta.dataset.limit`	`integer`	Yes	—	—
`result.meta.dataset.offset`	`integer`	Yes	—	—
`result.meta.dataset.pageSize`	`integer`	Yes	—	—

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation