How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
TextQL

TextQL Dashboard Service API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

TextQL Dashboard Service API is one of 39 APIs that TextQL publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include DashboardService. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and rate-limit docs.

This API exposes 24 operations across 24 paths, and defines 75 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://app.textql.com/rpc/public.

24 operations 24 paths 75 schemas 24 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://app.textql.com/v2
Authentication
API Key
Resource Areas
1

Authentication & Security 1

TextQL Dashboard Service API declares 1 security scheme for authenticating requests. An API key is passed in the header as tql_api_key (apiKey). By default, every request must be authenticated.

Paths & Operations 24

Across 24 paths, the API surfaces 24 operations — 24 POST. Each is listed below with its method, path, parameters, and response codes.

DashboardService 24
POST
/textql.rpc.public.dashboard.DashboardService/CheckDashboardHealth
CheckDashboardHealth
DashboardService_CheckDashboardHealth 2 params body → default200
POST
/textql.rpc.public.dashboard.DashboardService/CreateDashboard
CRUD operations
DashboardService_CreateDashboard 2 params body → default200
POST
/textql.rpc.public.dashboard.DashboardService/CreateDashboardFolder
Folder management
DashboardService_CreateDashboardFolder 2 params body → default200
POST
/textql.rpc.public.dashboard.DashboardService/DeleteDashboard
DeleteDashboard
DashboardService_DeleteDashboard 2 params body → default200
POST
/textql.rpc.public.dashboard.DashboardService/DeleteDashboardFolder
DeleteDashboardFolder
DashboardService_DeleteDashboardFolder 2 params body → default200
POST
/textql.rpc.public.dashboard.DashboardService/DiscardDashboardChanges
DiscardDashboardChanges
DashboardService_DiscardDashboardChanges 2 params body → default200
POST
/textql.rpc.public.dashboard.DashboardService/DuplicateDashboard
DuplicateDashboard
DashboardService_DuplicateDashboard 2 params body → default200
POST
/textql.rpc.public.dashboard.DashboardService/GetDashboard
GetDashboard
DashboardService_GetDashboard 2 params body → default200
POST
/textql.rpc.public.dashboard.DashboardService/GetDashboardVersion
GetDashboardVersion
DashboardService_GetDashboardVersion 2 params body → default200
POST
/textql.rpc.public.dashboard.DashboardService/GetDashboardViewStats
View analytics
DashboardService_GetDashboardViewStats 2 params body → default200
POST
/textql.rpc.public.dashboard.DashboardService/GetMembersWithDashboards
Member management
DashboardService_GetMembersWithDashboards 2 params body → default200
POST
/textql.rpc.public.dashboard.DashboardService/ListDashboardFolders
ListDashboardFolders
DashboardService_ListDashboardFolders 2 params body → default200
POST
/textql.rpc.public.dashboard.DashboardService/ListDashboardVersions
Version history
DashboardService_ListDashboardVersions 2 params body → default200
POST
/textql.rpc.public.dashboard.DashboardService/ListDashboards
ListDashboards
DashboardService_ListDashboards 2 params body → default200
POST
/textql.rpc.public.dashboard.DashboardService/MoveDashboardToFolder
MoveDashboardToFolder
DashboardService_MoveDashboardToFolder 2 params body → default200
POST
/textql.rpc.public.dashboard.DashboardService/PreviewConfigDashboard
Config-managed dashboards: render a .dashboard straight from a patch ref…
DashboardService_PreviewConfigDashboard 2 params body → default200
POST
/textql.rpc.public.dashboard.DashboardService/PublishDashboard
Publishing workflow
DashboardService_PublishDashboard 2 params body → default200
POST
/textql.rpc.public.dashboard.DashboardService/RegenerateScreenshot
Screenshot management
DashboardService_RegenerateScreenshot 2 params body → default200
POST
/textql.rpc.public.dashboard.DashboardService/RestoreDashboardVersion
RestoreDashboardVersion
DashboardService_RestoreDashboardVersion 2 params body → default200
POST
/textql.rpc.public.dashboard.DashboardService/RunScheduledDashboard
RunScheduledDashboard
DashboardService_RunScheduledDashboard 2 params body → default200
POST
/textql.rpc.public.dashboard.DashboardService/SpawnDashboard
Dashboard execution
DashboardService_SpawnDashboard 2 params body → default200
POST
/textql.rpc.public.dashboard.DashboardService/UpdateDashboard
UpdateDashboard
DashboardService_UpdateDashboard 2 params body → default200
POST
/textql.rpc.public.dashboard.DashboardService/UpdateDashboardFolder
UpdateDashboardFolder
DashboardService_UpdateDashboardFolder 2 params body → default200
POST
/textql.rpc.public.dashboard.DashboardService/UpdateDashboardSchedule
Scheduling
DashboardService_UpdateDashboardSchedule 2 params body → default200

Schemas 75

The contract defines 75 schemas that model the data the API accepts and returns. The most detailed are textql.rpc.public.dashboard.Dashboard (28 properties), textql.rpc.public.dashboard.CheckDashboardHealthResponse.DashboardHealth (14 properties), textql.rpc.public.dashboard.DashboardFolder (13 properties), textql.rpc.public.dashboard.ListDashboardsRequest (12 properties). Each schema is shown below with its type and property counts.

textql.rpc.public.dashboard.DashboardType
string
google.protobuf.Timestamp
string
A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond res…
textql.rpc.public.dashboard.GetDashboardViewStatsRequest
object
View analytics
1 property
textql.rpc.public.dashboard.GetDashboardViewStatsResponse
object
3 properties
textql.rpc.public.dashboard.UpdateDashboardResponse
object
1 property
textql.rpc.public.dashboard.OntologySqlSource
object
3 properties
textql.rpc.public.dashboard.DeleteDashboardFolderRequest
object
1 property
textql.rpc.public.config_source.ConfigSyncStatus
string
textql.rpc.public.dashboard.DiscardDashboardChangesResponse
object
1 property
textql.rpc.public.dashboard.UpdateDashboardRequest
object
7 properties
textql.rpc.public.common.SortDirection
string
Common enum for sort direction used across multiple services
textql.rpc.public.dashboard.UpdateDashboardFolderResponse
object
1 property
textql.rpc.public.dashboard.CreateDashboardFolderResponse
object
1 property
textql.rpc.public.dashboard.GetDashboardVersionRequest
object
2 properties
textql.rpc.public.dashboard.UpdateDashboardScheduleRequest
object
4 properties
textql.rpc.public.dashboard.DataSourcesPatch
object
1 property
textql.rpc.public.dashboard.CheckDashboardHealthRequest
object
1 property
textql.rpc.public.dashboard.CreateDashboardFolderRequest
object
Folder management messages
2 properties
textql.rpc.public.dashboard.Grant
object
Grant is an author allowlist gating a data source or compute function. A viewer whose effective role names intersect roles, or whose member id is listed in mem…
2 properties
textql.rpc.public.dashboard.DashboardViewerInfo
object
5 properties
textql.rpc.public.dashboard.DuplicateDashboardRequest
object
2 properties
textql.rpc.public.dashboard.GetDashboardVersionResponse
object
1 property
textql.rpc.public.dashboard.ListDashboardsResponse
object
2 properties
textql.rpc.public.dashboard.CreateDashboardRequest
object
8 properties
textql.rpc.public.dashboard.ListDashboardsRequest
object
12 properties
connect.error
object
Error type returned by Connect: https://connectrpc.com/docs/go/errors/http-representation
3 properties
textql.rpc.public.dashboard.DashboardVersion
object
Version history
12 properties
textql.rpc.public.dashboard.DiscardDashboardChangesRequest
object
1 property
connect-protocol-version
number
Define the version of the Connect protocol
textql.rpc.public.dashboard.DuplicateDashboardResponse
object
1 property
textql.rpc.public.dashboard.PreviewConfigDashboardRequest
object
PreviewConfigDashboard renders a config-managed dashboard from a patch ref before merge (ADR-0022). The previewing member + org come from auth context.
2 properties
textql.rpc.public.dashboard.MoveDashboardToFolderRequest
object
2 properties
textql.rpc.public.config_source.ConfigSource
object
Config-management metadata (provenance + reconcile state) for any file-based object. Presence on an object ⇒ the object is config-managed.
4 properties
textql.rpc.public.dashboard.DashboardFolder
object
Dashboard folder for hierarchical organization
13 properties
google.protobuf.Empty
object
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the resp…
textql.rpc.public.dashboard.CheckDashboardHealthResponse
object
1 property
textql.rpc.public.dashboard.RegenerateScreenshotResponse
object
1 property
textql.rpc.public.dashboard.FileSource
object
3 properties
textql.rpc.public.dashboard.QueryParameter
object
3 properties
textql.rpc.public.dashboard.RegenerateScreenshotRequest
object
1 property
textql.rpc.public.dashboard.MoveDashboardToFolderResponse
object
1 property
textql.rpc.public.dashboard.PreviewConfigDashboardResponse
object
2 properties
textql.rpc.public.dashboard.PythonCodeSource
object
1 property
textql.rpc.public.dashboard.GetDashboardRequest
object
1 property
textql.rpc.public.dashboard.ListDashboardVersionsRequest
object
3 properties
textql.rpc.public.dashboard.ListDashboardFoldersResponse
object
1 property
textql.rpc.public.dashboard.SpawnDashboardResponse
object
1 property
textql.rpc.public.dashboard.Dashboard
object
28 properties
textql.rpc.public.dashboard.DashboardStatus
string
textql.rpc.public.dashboard.UpdateDashboardFolderRequest
object
3 properties
textql.rpc.public.dashboard.PublishDashboardResponse
object
1 property
textql.rpc.public.dashboard.RunScheduledDashboardRequest
object
1 property
textql.rpc.public.dashboard.DashboardSortField
string
textql.rpc.public.dashboard.UpdateDashboardScheduleResponse
object
1 property
textql.rpc.public.dashboard.SpawnDashboardRequest
object
5 properties
textql.rpc.public.dashboard.DeleteDashboardRequest
object
1 property
textql.rpc.identity.MemberPreview
object
4 properties
textql.rpc.public.dashboard.RunScheduledDashboardResponse
object
1 property
textql.rpc.public.dashboard.DataSource
object
Unified data source for dashboards
textql.rpc.public.dashboard.LibraryTQLSource
object
References a .tql file stored in the Context Library. The file is rendered to SQL at fetch time and executed against the provided connector. Template parameter…
3 properties
connect.error_details.Any
object
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC er…
3 properties
textql.rpc.public.dashboard.RestoreDashboardVersionResponse
object
1 property
textql.rpc.public.dashboard.DashboardCreator
object
3 properties
textql.rpc.public.dashboard.RestoreDashboardVersionRequest
object
2 properties
textql.rpc.public.dashboard.GetMembersWithDashboardsResponse
object
1 property
textql.rpc.public.dashboard.GetDashboardResponse
object
2 properties
textql.rpc.public.dashboard.CheckDashboardHealthResponse.DashboardHealth
object
14 properties
textql.rpc.public.dashboard.SqlQuerySource
object
3 properties
textql.rpc.public.dashboard.ListDashboardFoldersRequest
object
textql.rpc.public.dashboard.GetMembersWithDashboardsRequest
object
textql.rpc.public.dashboard.PublishDashboardRequest
object
2 properties
textql.rpc.public.dashboard.CheckDashboardHealthResponse.HealthStatus
string
connect-timeout-header
number
Define the timeout, in ms
textql.rpc.public.dashboard.ListDashboardVersionsResponse
object
2 properties
textql.rpc.public.dashboard.CreateDashboardResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

textql-dashboardservice-api-openapi.yml Raw ↑

Other APIs TextQL publishes across the network.

Ana MCP Server
AE Profile APIs.io
TextQL Agent Service API
AE Profile APIs.io
TextQL API Keys API
AE Profile APIs.io
TextQL App Service API
AE Profile APIs.io
TextQL Audit Log Service API
AE Profile APIs.io
TextQL Changes API
AE Profile APIs.io
TextQL Chat API
AE Profile APIs.io
TextQL Chat Service API
AE Profile APIs.io
TextQL Connectors API
AE Profile APIs.io
TextQL Connector Service API
AE Profile APIs.io
TextQL Dataset Service API
AE Profile APIs.io
TextQL MCP Service API
AE Profile APIs.io
#DashboardService
← Back to T APIs
API Details
ID
textql:textql-dashboardservice-api
Base URL
https://app.textql.com/v2
Docs
https://docs.textql.com/api-reference/v2/introduction
Provider
TextQL
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=textql-dashboardservice-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/textql-dashboardservice-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of TextQL Dashboard Service API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.