The identity and technical contract details declared by the specification.
textql.rpc.public.playbook.RunPlaybookResponse
object
1 property
textql.rpc.public.playbook.SetTeamsChannelContextPlaybookResponse
object
1 property
textql.rpc.public.playbook.ListSlackChannelsForContextPlaybookResponse
object
1 property
textql.rpc.public.playbook.PlaybookPreview
object
4 properties
textql.rpc.public.playbook.DeployPlaybookRequest
object
1 property
textql.rpc.public.playbook.GetMembersWithPlaybooksRequest
object
textql.rpc.public.playbook.TeamsChannelPlaybookMapping
object
2 properties
textql.rpc.public.playbook.GetActiveSubscribedPlaybooksCountRequest
object
textql.rpc.public.playbook.PlaybookTriggerType
string
textql.rpc.public.dataset.TableauData
object
5 properties
textql.rpc.public.playbook.RunPlaybookRequest
object
3 properties
textql.rpc.public.playbook.GetReportsWithFiltersRequest
object
1 property
textql.rpc.public.playbook.SetSlackChannelContextPlaybookRequest
object
Associates a playbook to a Slack channel as its context playbook.
2 properties
textql.rpc.public.playbook.GetPlaybooksRequest
object
14 properties
textql.rpc.public.cells.ReportCell
object
6 properties
textql.rpc.public.playbook.UnsetSlackChannelContextPlaybookRequest
object
Unsets the context playbook for a Slack channel by channel ID only.
1 property
textql.rpc.public.playbook.PlaybookAttachDatasetRequest
object
2 properties
textql.rpc.public.playbook.FavoriteReportResponse
object
1 property
textql.rpc.public.playbook.PreviewSlackReportResponse
object
textql.rpc.public.playbook.DeactivatePlaybookRequest
object
1 property
textql.rpc.public.playbook.Playbook
object
44 properties
textql.rpc.public.playbook.ChatReportSummary
object
Lightweight report summary for chat drawer - excludes full blocks
6 properties
textql.rpc.public.dashboard.QueryParameter
object
3 properties
textql.rpc.public.dashboard.PythonCodeSource
object
1 property
textql.rpc.public.reports.ImageTextBlock
object
5 properties
textql.rpc.public.dashboard.Dashboard
object
28 properties
textql.rpc.public.playbook.PreviewSlackReportRequest
object
4 properties
textql.rpc.public.playbook.PlaybookAttachDashboardRequest
object
2 properties
textql.rpc.public.playbook.ReportFilters
object
12 properties
textql.rpc.public.playbook.ChatAccessOverrideList
object
1 property
textql.rpc.public.playbook.ListPlaybookBatchRunsRequest
object
Request to list batch runs for a playbook
3 properties
textql.rpc.identity.MemberPreview
object
4 properties
textql.rpc.public.dashboard.DataSource
object
Unified data source for dashboards
textql.rpc.public.playbook.UnsetTeamsChannelContextPlaybookResponse
object
1 property
textql.rpc.public.playbook.UnsetSlackChannelContextPlaybookResponse
object
1 property
textql.rpc.public.playbook.UnsubscribeFromPlaybookRequest
object
1 property
textql.rpc.public.reports.ReportBlock
object
textql.rpc.public.dataset.SandboxDataFrame
object
1 property
textql.rpc.public.playbook.CancelTemplateExecutionResponse
object
Response from canceling template execution
2 properties
connect-timeout-header
number
Define the timeout, in ms
textql.rpc.public.playbook.ListTeamsChannelsForContextPlaybookRequest
object
1 property
textql.rpc.public.chat.LlmModel
string
textql.rpc.public.playbook.GetPlaybookLineageResponse
object
3 properties
textql.rpc.public.tableau.TableauDatasource
object
TODO: Add datasources support
8 properties
textql.rpc.public.playbook.UnsetTeamsChannelContextPlaybookRequest
object
1 property
textql.rpc.public.dashboard.OntologySqlSource
object
3 properties
textql.rpc.public.playbook.DeletePlaybookResponse
object
2 properties
textql.rpc.public.playbook.UpdatePlaybookRequest
object
30 properties
textql.rpc.public.playbook.MarkReportAsReadResponse
object
2 properties
textql.rpc.public.playbook.PlaybookRemoveDashboardRequest
object
2 properties
textql.rpc.public.dataset.Dataset
object
textql.rpc.public.playbook.SubscribeToPlaybookRequest
object
1 property
textql.rpc.public.reports.CardBlock
object
1 property
textql.rpc.public.playbook.PlaybookRemoveDatasetResponse
object
1 property
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.playbook.ListAllTeamsChannelContextPlaybooksRequest
object
textql.rpc.public.reports.ImageVariant
string
textql.rpc.public.playbook.GetReportsWithFiltersResponse
object
4 properties
textql.rpc.public.playbook.GetReportByIdResponse
object
1 property
textql.rpc.public.playbook.DuplicatePlaybookRequest
object
1 property
connect.error
object
Error type returned by Connect: https://connectrpc.com/docs/go/errors/http-representation
3 properties
textql.rpc.public.playbook.GetReportByIdRequest
object
1 property
textql.rpc.public.reports.ListBlock
object
2 properties
textql.rpc.public.reports.SpacerBlock
object
1 property
textql.rpc.public.playbook.PlaybookLineageNode
object
5 properties
textql.rpc.powerbi_selection.PowerBISelection
object
PowerBISelection captures a chosen PowerBI workspace (and optionally the specific reports/datasets within it) for attaching to a chat. Field shape mirrors text…
5 properties
textql.rpc.public.playbook.SlackChannelPlaybookMapping
object
Maps playbook to its associated Slack channel
2 properties
textql.rpc.paradigm_params.ParadigmType
string
textql.rpc.public.playbook.SetSlackChannelContextPlaybookResponse
object
1 property
textql.rpc.public.playbook.ListTeamsChannelsForContextPlaybookResponse
object
1 property
textql.rpc.public.paradigm.UniversalOptions
object
31 properties
textql.rpc.public.playbook.StringList
object
1 property
textql.rpc.public.paradigm.ParadigmOptions
object
textql.rpc.public.playbook.PlaybookAttachDatasetResponse
object
1 property
textql.rpc.public.playbook.PlaybookReport
object
11 properties
textql.rpc.public.reports.HeroBlock
object
2 properties
textql.rpc.public.dataset.Document
object
2 properties
textql.rpc.public.playbook.CancelTemplateExecutionRequest
object
Request to cancel template execution
2 properties
textql.rpc.public.playbook.GetPlaybooksPreviewsRequest
object
2 properties
textql.rpc.public.playbook.GetPlaybookReportsBatchRequest
object
Batch request to get reports for multiple template data IDs efficiently
4 properties
textql.rpc.public.playbook.GetPlaybookLineageRequest
object
1 property
textql.rpc.public.playbook.DeletePlaybookRequest
object
1 property
textql.rpc.public.reports.DividerBlock
object
textql.rpc.public.dataframe.DataFrameInfo
object
5 properties
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
textql.rpc.public.playbook.PlaybookRemoveDashboardResponse
object
1 property
textql.rpc.public.playbook.DemoPlaybookResponse
object
textql.rpc.public.playbook.SetTeamsChannelContextPlaybookRequest
object
2 properties
textql.rpc.public.playbook.SubscribeToPlaybookResponse
object
1 property
textql.rpc.public.playbook.PlaybookAttachDashboardResponse
object
1 property
textql.rpc.public.dataset.DatasetType
string
never change the names or numbers of existing dataset types!
textql.rpc.public.playbook.GetChatReportsSummaryResponse
object
1 property
textql.rpc.public.playbook.ListAllSlackChannelContextPlaybooksRequest
object
List all Slack channel context playbook mappings for organization
textql.rpc.public.playbook.GetChatReportsSummaryRequest
object
1 property
textql.rpc.public.dataset.TabularFileCategory
string
never change the names or numbers of existing tabular file categories!
textql.rpc.public.common.SortDirection
string
Common enum for sort direction used across multiple services
textql.rpc.public.dataset.PowerBIData
object
7 properties
textql.rpc.public.playbook.GetPlaybookReportsRequest
object
6 properties
textql.rpc.public.playbook.PlaybookRemoveDatasetRequest
object
2 properties
textql.rpc.public.playbook.ListPlaybookBatchRunsResponse
object
Response containing list of batch runs
2 properties
textql.rpc.public.playbook.ListAllSlackChannelContextPlaybooksResponse
object
1 property
textql.rpc.public.playbook.UpdatePlaybookResponse
object
1 property
textql.rpc.public.reports.TextBlock
object
2 properties
textql.rpc.public.playbook.GetMembersWithPlaybooksResponse
object
1 property
textql.rpc.public.cells.PreviewCellRef
object
Preview cell reference for report history
4 properties
textql.rpc.public.dataset.TabularFile
object
4 properties
textql.rpc.public.playbook.FilterConditionList
object
1 property
textql.rpc.public.playbook.GetPlaybookReportsBatchResponse
object
Batch response with reports grouped by templatedataid
1 property
textql.rpc.public.playbook.PlaybookSortField
string
textql.rpc.public.playbook.UnsubscribeFromPlaybookResponse
object
1 property
textql.rpc.public.dashboard.FileSource
object
3 properties
textql.rpc.public.playbook.DeployPlaybookResponse
object
2 properties
textql.rpc.public.playbook.PlaybookReportStyle
string
textql.rpc.public.playbook.MarkReportAsReadRequest
object
Report read tracking messages
1 property
textql.rpc.public.playbook.ListSlackChannelsForContextPlaybookRequest
object
Lists Slack channel IDs that have this playbook set as the context playbook.
1 property
textql.rpc.public.playbook.FavoriteReportRequest
object
Favorite report messages
2 properties
textql.rpc.public.playbook.CreatePlaybookResponse
object
1 property
textql.rpc.public.tableau.TableauView
object
8 properties
textql.rpc.public.playbook.GetPlaybooksResponse
object
2 properties
textql.rpc.public.dashboard.DashboardStatus
string
textql.rpc.public.playbook.DemoPlaybookRequest
object
4 properties
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.config_source.ConfigSyncStatus
string
textql.rpc.public.playbook.ChatAccessMode
string
textql.rpc.public.playbook.GetActiveSubscribedPlaybooksCountResponse
object
1 property
textql.rpc.public.playbook.GetPlaybookRequest
object
3 properties
textql.rpc.public.playbook.GetPlaybookBatchRunResponse
object
Response containing batch run details
1 property
textql.rpc.public.playbook.GetPlaybookBatchRunRequest
object
Request to get a specific batch run
1 property
textql.rpc.public.playbook.TemplateDataReports
object
Grouped reports by templatedataid
4 properties
textql.rpc.public.playbook.PlaybookStatus
string
textql.rpc.public.playbook.ListAllTeamsChannelContextPlaybooksResponse
object
1 property
connect-protocol-version
number
Define the version of the Connect protocol
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.playbook.DuplicatePlaybookResponse
object
1 property
textql.rpc.public.playbook.ChatAccessOverride
object
3 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.playbook.GetPlaybookReportsResponse
object
2 properties
textql.rpc.public.playbook.GetPlaybookResponse
object
3 properties
textql.rpc.public.playbook.GetPlaybooksPreviewsResponse
object
1 property
textql.rpc.public.playbook.PlaybookBatchRun
object
Batch run record
5 properties
textql.rpc.public.dataset.DatasetPermission
string
textql.rpc.public.playbook.CreatePlaybookRequest
object
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.DashboardCreator
object
3 properties
textql.rpc.public.playbook.FilterCondition
object
Filter condition for template data searches
3 properties
textql.rpc.public.reports.ImageBlock
object
3 properties
textql.rpc.public.playbook.Int32List
object
1 property
textql.rpc.public.dashboard.SqlQuerySource
object
3 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs TextQL publishes across the network.