CustomDashboardDashlet

One dashlet: one dataset request and how to draw it.

type CustomDashboardDashlet {
  id: ID!
  schema_version: Int!
  dataset: String!
  fields: [String!]!
  chart: DatasetReportChart!
  title: String
  filters: [DatasetReportFilter!]!
  filterLogic: FilterLogic!
  parameters: [DatasetReportParameter!]!
  sort: CustomDashboardDashletSort
  limit: Int
  cumulative: Boolean!
  charts: [DatasetReportChart!]!
  compare: Boolean!
  accent: Int
  other: Boolean!
  trend: Boolean!
  goal: CustomDashboardDashletGoal
}

Fields

CustomDashboardDashlet.id ● ID! non-null scalar

Stable within the dashboard. Layout slots, and later Ask edits, name the dashlet by it.

CustomDashboardDashlet.schema_version ● Int! non-null scalar

CustomDashboardDashlet.dataset ● String! non-null scalar

Dataset key, as returned by datasets.

CustomDashboardDashlet.fields ● [String!]! non-null scalar

Field keys to request, in the order the dashlet shows them.

CustomDashboardDashlet.chart ● DatasetReportChart! non-null enum

CustomDashboardDashlet.title ● String scalar

CustomDashboardDashlet.filters ● [DatasetReportFilter!]! non-null object

CustomDashboardDashlet.filterLogic ● FilterLogic! non-null enum

CustomDashboardDashlet.parameters ● [DatasetReportParameter!]! non-null object

CustomDashboardDashlet.sort ● CustomDashboardDashletSort object

Null keeps the rows query's own group order.

CustomDashboardDashlet.limit ● Int scalar

Draw only the first N rows after sorting. Null draws every row.

CustomDashboardDashlet.cumulative ● Boolean! non-null scalar

A LINE over a date dimension drawn as a running total: each bucket adds to the ones before it, starting from everything before the window.

CustomDashboardDashlet.charts ● [DatasetReportChart!]! non-null enum

Every chart the card's toggle offers, chart (the one it opens as) among them. Empty: the card offers its own defaults for chart.

CustomDashboardDashlet.compare ● Boolean! non-null scalar

Drawn beside the same request over an earlier window: the previous period, or the previous year on a dashboard saved comparing with that (the dashboard's compare). Only a NUMBER, on a dataset the window applies to.

CustomDashboardDashlet.accent ● Int scalar

The palette slot, 1 to 8, a chart of one series is drawn in. Null draws it in the first.

CustomDashboardDashlet.other ● Boolean! non-null scalar

A top N (limit) also draws everything past it as one grey "Other" bar or slice: the request's total less the N, for metrics that add up.

CustomDashboardDashlet.trend ● Boolean! non-null scalar

A NUMBER draws its metric over the window as a line under the figure, by a date grain the window's length picks: days up to 90 days, weeks up to a year, months beyond.

CustomDashboardDashlet.goal ● CustomDashboardDashletGoal object

A GOAL's target and period. Null on every other chart.

Member Of

CustomDashboard object ● CustomDashboardTemplateInfo object ● DashletLibraryEntry object ● PublicDashboardDefinition object