Skip to main content

DashboardQueries

No description

type DashboardQueries {
  dashboards(
    folderId: Long
    tagIds: [Long!]
  ): [DashboardDetail!]
  dashboard(
    publicId: String!
    view: Boolean
  ): DashboardDetail
  dashboardCharts(
    folderId: Long
    tagIds: [Long!]
    source: String
  ): [DashboardChartDetail!]
  dashboardChart(
    publicId: String!
  ): DashboardChartDetail
  dashboardSources: [DashboardSourceInfo!]
  dashboardSourceSchema(
    source: String!
  ): OrgDbSchema
  dashboardColumnValues(
    source: String!
    table: String!
    column: String!
    prefix: String
    limit: Int
  ): String
  dashboardFilterOptions(
    dashboardPublicId: String!
    filterId: String!
  ): DashboardFilterOptions
  runDashboardChart(
    dashboardPublicId: String!
    tileId: String!
    filterValues: String
    cache: String
  ): DashboardQueryRun
  runDashboardChartStandalone(
    chartPublicId: String!
    values: String
    cache: String
  ): DashboardQueryRun
  runDashboardAdhoc(
    source: String!
    sql: String!
    parameters: String
    values: String
  ): DashboardQueryRun
  dashboardAnnotations: [DashboardAnnotationDetail!]
}

Fields​

DashboardQueries.dashboards ● [DashboardDetail!] list object​

The organization's dashboards, by name, with their tiles and filters. Any member.

DashboardQueries.dashboards.folderId ● Long scalar​

Only dashboards in this folder

DashboardQueries.dashboards.tagIds ● [Long!] list scalar​

Only dashboards carrying every one of these tags

DashboardQueries.dashboard ● DashboardDetail object​

One dashboard by public id. Any member.

DashboardQueries.dashboard.publicId ● String! non-null scalar​
DashboardQueries.dashboard.view ● Boolean scalar​

True when a person is opening the dashboard (the app sets it on open, not on a re-read): counts one view, which ranks the dashboard for the server's cache warm-up.

DashboardQueries.dashboardCharts ● [DashboardChartDetail!] list object​

The charts library, by name, each with its preview snapshot. Any member.

DashboardQueries.dashboardCharts.folderId ● Long scalar​

Only charts in this folder

DashboardQueries.dashboardCharts.tagIds ● [Long!] list scalar​

Only charts carrying every one of these tags

DashboardQueries.dashboardCharts.source ● String scalar​

Only charts on this source (source JSON, as dashboardSources returns it)

DashboardQueries.dashboardChart ● DashboardChartDetail object​

One chart by public id, including its SQL. Any member.

DashboardQueries.dashboardChart.publicId ● String! non-null scalar​

DashboardQueries.dashboardSources ● [DashboardSourceInfo!] list object​

Where charts can run: Honeybase's own data, the organization database when provisioned, and every enabled SQL integration. Any member.

DashboardQueries.dashboardSourceSchema ● OrgDbSchema object​

Tables, views and columns of a source as dashboards see it (for Honeybase: the reporting views only). Requires canManageDashboards.

DashboardQueries.dashboardSourceSchema.source ● String! non-null scalar​

Source JSON, as dashboardSources returns it

DashboardQueries.dashboardColumnValues ● String scalar​

Distinct values of one column, for filter value pickers; runs through the same gate and caps as any dashboard query. Returns a JSON array. Requires canManageDashboards.

DashboardQueries.dashboardColumnValues.source ● String! non-null scalar​

Source JSON, as dashboardSources returns it

DashboardQueries.dashboardColumnValues.table ● String! non-null scalar​

Table or view as dashboardSourceSchema lists it (schema.table when it is not in the default schema)

DashboardQueries.dashboardColumnValues.column ● String! non-null scalar​
DashboardQueries.dashboardColumnValues.prefix ● String scalar​

Values starting with this text (case-insensitive on Postgres); empty = any

DashboardQueries.dashboardColumnValues.limit ● Int scalar​

At most this many values, 1-50 (default 50)

DashboardQueries.dashboardFilterOptions ● DashboardFilterOptions object​

A dashboard filter's picker options, from a stored snapshot: reading them never queries the source. Values from a column are refreshed in the background when older than an hour. Any member.

DashboardQueries.dashboardFilterOptions.dashboardPublicId ● String! non-null scalar​
DashboardQueries.dashboardFilterOptions.filterId ● String! non-null scalar​

A multi_select filter's id

DashboardQueries.runDashboardChart ● DashboardQueryRun object​

Run a tile's chart with dashboard filter values mapped onto its parameters. Gate and database errors come back verbatim as the error message. Any member.

DashboardQueries.runDashboardChart.dashboardPublicId ● String! non-null scalar​
DashboardQueries.runDashboardChart.tileId ● String! non-null scalar​

The tile's tileId

DashboardQueries.runDashboardChart.filterValues ● String scalar​

JSON object of dashboard filter values by filter id, e.g. {"period": {"from": "2026-01-01", "to": "2026-02-01"}}. A filter without a value falls back to its default; values only reach the chart through the tile's mappings.

DashboardQueries.runDashboardChart.cache ● String scalar​

Server frame cache policy: default (serve a cached result within its TTL, store a fresh one), refresh (skip the cache, store the fresh result for everyone), or bypass (neither). Absent = bypass, so an existing client always gets a live run; the app's dashboards send default.

DashboardQueries.runDashboardChartStandalone ● DashboardQueryRun object​

Run a chart outside a dashboard (library, chart page), on its defaults or on the given parameter values. Any member.

DashboardQueries.runDashboardChartStandalone.chartPublicId ● String! non-null scalar​
DashboardQueries.runDashboardChartStandalone.values ● String scalar​

JSON object of parameter values by the chart's parameter name, e.g. {"period": {"from": "2026-01-01", "to": "2026-02-01"}}. A parameter without a value falls back to its default; a name the chart does not declare is refused. Only a run on the defaults refreshes the chart's preview.

DashboardQueries.runDashboardChartStandalone.cache ● String scalar​

Server frame cache policy: default (serve a cached result within its TTL, store a fresh one), refresh (skip the cache, store the fresh result for everyone), or bypass (neither). Absent = bypass, so an existing client always gets a live run; the app's dashboards send default.

DashboardQueries.runDashboardAdhoc ● DashboardQueryRun object​

Run ad-hoc SQL against a source (the chart editor). Returns the rows and a queryHandle that saveDashboardChart takes. Gate and database errors come back verbatim. Requires canManageDashboards.

DashboardQueries.runDashboardAdhoc.source ● String! non-null scalar​

Source JSON, as dashboardSources returns it

DashboardQueries.runDashboardAdhoc.sql ● String! non-null scalar​

One SELECT. {{name}} binds a declared parameter; [[ ... {{name}} ... ]] is dropped when its parameters have no value (WHERE TRUE [[AND col = {{name}}]]).

DashboardQueries.runDashboardAdhoc.parameters ● String scalar​

JSON array of parameter declarations: [{name, type (text|number|date|date_range|multi_select), required?, default?}]

DashboardQueries.runDashboardAdhoc.values ● String scalar​

JSON object of test values by parameter name

DashboardQueries.dashboardAnnotations ● [DashboardAnnotationDetail!] list object​

Every schema annotation of the organization: notes on tables and columns of its sources. Any member.

Returned By​

dashboards query