TextQL

TextQL Dashboard Service API

The DashboardService API from TextQL — 24 operation(s) for dashboardservice.

GitHub OpenAPI
Business capability
Analytics & BI Management BC-610.50

Operations 24

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /textql.rpc.public.dashboard.DashboardService/CheckDashboardHealth Check the health of dashboards · CheckDashboardHealth #
Ask an LLM
“Are any of my dashboards broken?”
“Can I health-check several dashboards in one call?”
Tell an agent
Check the health of dashboards {dashboard_ids}.
Run a health check across dashboard IDs {dashboard_ids}.
POST /textql.rpc.public.dashboard.DashboardService/CreateDashboard Create a dashboard · CRUD operations #
Ask an LLM
“How do I build a new dashboard?”
“Can a dashboard be created from a cell in a chat?”
Tell an agent
Create a dashboard named {name} described as {description}.
Turn cell {cell_id} from chat {chat_id} into a dashboard called {name}.
POST /textql.rpc.public.dashboard.DashboardService/CreateDashboardFolder Create a dashboard folder · Folder management #
Ask an LLM
“Can I organize dashboards into folders?”
“Is nesting one dashboard folder inside another supported?”
Tell an agent
Create a dashboard folder named {name}.
Make folder {name} under parent folder {parent_id}.
POST /textql.rpc.public.dashboard.DashboardService/DeleteDashboard Delete a dashboard · DeleteDashboard #
Ask an LLM
“How do I delete a dashboard I no longer need?”
“Can a deleted dashboard be recovered?”
Tell an agent destructive · confirm first
Delete dashboard {dashboard_id}.
Permanently remove the dashboard {dashboard_id}.
POST /textql.rpc.public.dashboard.DashboardService/DeleteDashboardFolder Delete a dashboard folder · DeleteDashboardFolder #
Ask an LLM
“Can I remove an empty dashboard folder?”
“What happens to a folder's dashboards if the folder is deleted?”
Tell an agent destructive · confirm first
Delete dashboard folder {folder_id}.
Remove the folder {folder_id} from my dashboards.
POST /textql.rpc.public.dashboard.DashboardService/DiscardDashboardChanges Discard unpublished dashboard changes · DiscardDashboardChanges #
Ask an LLM
“Can I throw away edits to a dashboard I haven't published yet?”
“How do I revert a dashboard draft to its published state?”
Tell an agent destructive · confirm first
Discard unpublished changes on dashboard {dashboard_id}.
Throw away my draft edits to dashboard {dashboard_id}.
POST /textql.rpc.public.dashboard.DashboardService/DuplicateDashboard Duplicate a dashboard · DuplicateDashboard #
Ask an LLM
“Can I clone a dashboard as a starting point?”
“What is a duplicated dashboard named by default?”
Tell an agent
Duplicate dashboard {dashboard_id}.
Copy dashboard {dashboard_id} and call the copy {name}.
POST /textql.rpc.public.dashboard.DashboardService/GetDashboard Get a dashboard · GetDashboard #
Ask an LLM
“What's in a specific dashboard?”
“Can I fetch a dashboard's code and data sources by ID?”
Tell an agent
Get dashboard {dashboard_id}.
Open the current details of dashboard {dashboard_id}.
POST /textql.rpc.public.dashboard.DashboardService/GetDashboardVersion Get a specific dashboard version · GetDashboardVersion #
Ask an LLM
“What did a dashboard look like in an earlier version?”
“Can I view one numbered version of a dashboard?”
Tell an agent
Get version {version_number} of dashboard {dashboard_id}.
Show me how dashboard {dashboard_id} looked at version {version_number}.
POST /textql.rpc.public.dashboard.DashboardService/GetDashboardViewStats Get view analytics for a dashboard · View analytics #
Ask an LLM
“How many people have viewed my dashboard?”
“Who is actually looking at a dashboard?”
Tell an agent
Get view stats for dashboard {dashboard_id}.
Show the viewing analytics of dashboard {dashboard_id}.
POST /textql.rpc.public.dashboard.DashboardService/GetMembersWithDashboards List members who own dashboards · Member management #
Ask an LLM
“Which teammates have created dashboards?”
“Who can I filter the dashboard list by as a creator?”
Tell an agent
List members who have dashboards.
Show all dashboard creators, timing out after {timeout_ms} ms.
POST /textql.rpc.public.dashboard.DashboardService/ListDashboardFolders List dashboard folders · ListDashboardFolders #
Ask an LLM
“What dashboard folders exist in my workspace?”
“How are our dashboards organized into folders?”
Tell an agent
List my dashboard folders.
Show the dashboard folder tree with a {timeout_ms} ms timeout.
POST /textql.rpc.public.dashboard.DashboardService/ListDashboardVersions List a dashboard's version history · Version history #
Ask an LLM
“Can I see every published version of a dashboard?”
“How far back does a dashboard's version history go?”
Tell an agent
List versions of dashboard {dashboard_id}.
Show {limit} versions of dashboard {dashboard_id} from offset {offset}.
POST /textql.rpc.public.dashboard.DashboardService/ListDashboards Search and list dashboards · ListDashboards #
Ask an LLM
“How do I find a dashboard by name?”
“Can I list only dashboards shared with me or ones without a folder?”
Tell an agent
Search dashboards for {search_term}.
List dashboards in folder {folder_id}.
POST /textql.rpc.public.dashboard.DashboardService/MoveDashboardToFolder Move a dashboard to a folder · MoveDashboardToFolder #
Ask an LLM
“Can I move a dashboard into a different folder?”
“How do I put a dashboard back at the root?”
Tell an agent
Move dashboard {dashboard_id} into folder {folder_id}.
Move dashboard {dashboard_id} back to the uncategorized root.
POST /textql.rpc.public.dashboard.DashboardService/PreviewConfigDashboard Preview a config-managed dashboard from a patch · Config-managed dashboards: render a `.dashboard` straight from a patch ref… #
Ask an LLM
“Can I render a .dashboard file from a git patch before it merges?”
“Does previewing a config-managed dashboard save anything?”
Tell an agent
Preview dashboard file {dashboard_path} from patch ref {patch_ref}.
Render the unmerged {dashboard_path} at git ref {patch_ref} without persisting it.
POST /textql.rpc.public.dashboard.DashboardService/PublishDashboard Publish a dashboard version · Publishing workflow #
Ask an LLM
“How do I publish my dashboard edits so others see them?”
“Can I label a version when publishing a dashboard?”
Tell an agent
Publish dashboard {dashboard_id}.
Publish dashboard {dashboard_id} as a version labeled {label}.
POST /textql.rpc.public.dashboard.DashboardService/RegenerateScreenshot Regenerate a dashboard's screenshot · Screenshot management #
Ask an LLM
“Can I refresh the thumbnail image of a dashboard?”
“Why is a dashboard's preview image out of date, and can I redo it?”
Tell an agent
Regenerate the screenshot for dashboard {dashboard_id}.
Retake the preview thumbnail of dashboard {dashboard_id}.
POST /textql.rpc.public.dashboard.DashboardService/RestoreDashboardVersion Restore a previous dashboard version · RestoreDashboardVersion #
Ask an LLM
“Can I roll a dashboard back to an older version?”
“How do I undo a bad dashboard publish?”
Tell an agent
Restore dashboard {dashboard_id} to version {version_number}.
Roll back dashboard {dashboard_id} to its version {version_number}.
POST /textql.rpc.public.dashboard.DashboardService/RunScheduledDashboard Run a scheduled dashboard refresh now · RunScheduledDashboard #
Ask an LLM
“Can I trigger a scheduled dashboard's run immediately?”
“Is there a way to run a dashboard's schedule on demand?”
Tell an agent
Run the scheduled refresh for dashboard {dashboard_id} now.
Kick off dashboard {dashboard_id}'s scheduled job out of cycle.
POST /textql.rpc.public.dashboard.DashboardService/SpawnDashboard Start or refresh a running dashboard app · Dashboard execution #
Ask an LLM
“How do I launch a dashboard app so it can be viewed?”
“Can I refresh only the data, or only the code, without restarting the app?”
Tell an agent
Spawn dashboard {dashboard_id}.
Reload data sources {refresh_source_names} on dashboard {dashboard_id} without a restart.
POST /textql.rpc.public.dashboard.DashboardService/UpdateDashboard Update a dashboard's content · UpdateDashboard #
Ask an LLM
“Can I edit a dashboard's code or description?”
“How do I change the data sources a dashboard reads from?”
Tell an agent
Rename dashboard {dashboard_id} to {name}.
Replace the code of dashboard {dashboard_id} with {code}.
POST /textql.rpc.public.dashboard.DashboardService/UpdateDashboardFolder Rename or move a dashboard folder · UpdateDashboardFolder #
Ask an LLM
“Can I rename a dashboard folder?”
“How do I nest a folder under a different parent?”
Tell an agent
Rename dashboard folder {folder_id} to {name}.
Move folder {folder_id} under parent {parent_id}.
POST /textql.rpc.public.dashboard.DashboardService/UpdateDashboardSchedule Set a dashboard's refresh schedule · Scheduling #
Ask an LLM
“Can a dashboard refresh itself on a schedule?”
“How do I turn off a dashboard's scheduled refresh?”
Tell an agent
Schedule dashboard {dashboard_id} to refresh on cron {cron_string}.
Disable the refresh schedule on dashboard {dashboard_id}.

Documentation

📖
Documentation
https://docs.textql.com/api-reference/v2/introduction
📖
APIReference
https://docs.textql.com/api-reference/v2/introduction
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/authentication/textql-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/rate-limits/textql-rate-limits.yml
📖
Documentation
https://docs.textql.com/api-reference/introduction
📖
APIReference
https://docs.textql.com/api-reference/introduction

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/openapi/textql-dashboardservice-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/scopes/textql-scopes.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/errors/textql-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/conventions/textql-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/data-model/textql-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/asyncapi/textql-webhooks.yml
🔗
Deprecation
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/lifecycle/textql-lifecycle.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/conformance/textql-conformance.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/textql:textql-dashboardservice-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

textql-dashboardservice-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: TextQL Dashboard Service API
  version: 1.0.0
  description: 'TextQL public API. Generated from protobuf service definitions; internal

    endpoints are excluded via google.api.visibility / file_visibility.'
servers:
- url: https://app.textql.com/rpc/public
security:
- apiKey: []
tags:


# --- truncated at 32 KB (89 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/openapi/textql-dashboardservice-api-openapi.yml