query_dashboard_visual

Query an existing dashboard visual with governed filters and compact analytical output

Machine-readable: focused JSON · complete manifest

Contract

Input schema

{
  "additionalProperties": false,
  "properties": {
    "dashboard": {
      "type": "string"
    },
    "limit": {
      "maximum": 50,
      "minimum": 1,
      "type": "integer"
    },
    "page": {
      "type": "string"
    },
    "pageToken": {
      "maxLength": 2048,
      "minLength": 1,
      "type": "string"
    },
    "visual": {
      "type": "string"
    },
    "workspace": {
      "description": "Workspace ID to query.",
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "dashboard",
    "page",
    "visual",
    "workspace"
  ],
  "type": "object"
}

Output schema

{
  "additionalProperties": false,
  "properties": {
    "appliedFilters": {
      "additionalProperties": false,
      "properties": {
        "controls": {
          "additionalProperties": {
            "additionalProperties": false,
            "properties": {
              "from": {
                "type": "string"
              },
              "operator": {
                "type": "string"
              },
              "preset": {
                "type": "string"
              },
              "to": {
                "type": "string"
              },
              "type": {
                "type": "string"
              },
              "value": {
                "type": "string"
              },
              "values": {
                "items": {
                  "type": "string"
                },
                "type": "array"
              }
            },
            "required": [
              "type"
            ],
            "type": "object"
          },
          "type": "object"
        },
        "selections": {
          "items": {
            "additionalProperties": {},
            "type": "object"
          },
          "type": "array"
        },
        "spatialSelections": {
          "items": {
            "additionalProperties": {},
            "type": "object"
          },
          "type": "array"
        }
      },
      "required": [
        "controls",
        "selections",
        "spatialSelections"
      ],
      "type": "object"
    },
    "columns": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "dataType": {
            "enum": [
              "string",
              "boolean",
              "integer",
              "decimal",
              "temporal",
              "date",
              "geographic"
            ],
            "type": "string"
          },
          "format": {
            "additionalProperties": {},
            "type": "object"
          },
          "grain": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "nullable": {
            "type": "boolean"
          },
          "role": {
            "enum": [
              "dimension",
              "measure",
              "metadata",
              "identity"
            ],
            "type": "string"
          },
          "sourceRef": {
            "type": "string"
          }
        },
        "required": [
          "dataType",
          "id",
          "label",
          "nullable",
          "role"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "completeness": {
      "additionalProperties": false,
      "properties": {
        "availableRows": {
          "type": "integer"
        },
        "cardinality": {
          "enum": [
            "unknown",
            "lower_bound",
            "estimated",
            "exact"
          ],
          "type": "string"
        },
        "cardinalityCount": {
          "type": "integer"
        },
        "returnedRows": {
          "type": "integer"
        },
        "state": {
          "enum": [
            "complete",
            "truncated",
            "partial",
            "empty"
          ],
          "type": "string"
        }
      },
      "required": [
        "cardinality",
        "returnedRows",
        "state"
      ],
      "type": "object"
    },
    "datasetId": {
      "type": "string"
    },
    "diagnostics": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "code": {
            "type": "string"
          },
          "fieldId": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "severity": {
            "enum": [
              "info",
              "warning",
              "error"
            ],
            "type": "string"
          }
        },
        "required": [
          "code",
          "message",
          "severity"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "freshness": {
      "additionalProperties": false,
      "properties": {
        "lastSuccessfulRefreshAt": {
          "description": "Completion time of the last successful publish or refresh. This is not an upstream event-time watermark.",
          "type": "string"
        },
        "servingStateId": {
          "description": "Serving state that produced the successful data version.",
          "type": "string"
        },
        "snapshotId": {
          "description": "DuckLake snapshot ID recorded for the successful data version.",
          "type": "string"
        },
        "source": {
          "description": "Whether the data version came from publish or refresh.",
          "enum": [
            "publish",
            "refresh"
          ],
          "type": "string"
        },
        "status": {
          "description": "current when the successful data version belongs to the queried serving snapshot; stale otherwise.",
          "enum": [
            "current",
            "stale"
          ],
          "type": "string"
        }
      },
      "required": [
        "lastSuccessfulRefreshAt",
        "servingStateId",
        "snapshotId",
        "source",
        "status"
      ],
      "type": "object"
    },
    "hasMore": {
      "type": "boolean"
    },
    "mark": {
      "type": "string"
    },
    "nextCursor": {
      "type": "string"
    },
    "queryId": {
      "type": "string"
    },
    "rows": {
      "items": {
        "items": {},
        "type": "array"
      },
      "type": "array"
    },
    "servingSnapshot": {
      "type": "string"
    },
    "status": {
      "additionalProperties": false,
      "properties": {
        "kind": {
          "enum": [
            "idle",
            "loading",
            "ready",
            "no_data",
            "partial",
            "error"
          ],
          "type": "string"
        },
        "message": {
          "type": "string"
        }
      },
      "required": [
        "kind"
      ],
      "type": "object"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "visualId": {
      "type": "string"
    }
  },
  "required": [
    "appliedFilters",
    "columns",
    "completeness",
    "datasetId",
    "diagnostics",
    "hasMore",
    "queryId",
    "rows",
    "servingSnapshot",
    "status",
    "title",
    "type",
    "visualId"
  ],
  "type": "object"
}