---
title: "GetExampleQueries"
method: POST
path: "/textql.rpc.public.connector.ConnectorService/GetExampleQueries"
tags: ["ConnectorService"]
---

# GetExampleQueries

`POST /textql.rpc.public.connector.ConnectorService/GetExampleQueries`

## Headers

- `Connect-Protocol-Version` 1, required — Define the version of the Connect protocol
- `Connect-Timeout-Ms` number — Define the timeout, in ms

## Request body

- TextqlRpcPublicConnectorGetExampleQueriesRequest
  - `connectorContexts` TextqlRpcPublicConnectorConnectorContext[]
    - union
      - object
        - `connectorId` integer
        - `powerbi` TextqlRpcPublicConnectorPowerBIConnectorContext, required
          - `reportIds` string[] — PowerBI report IDs
          - `datasetIds` string[] — PowerBI dataset IDs (PowerBI datasets, not internal dataset_source)
          - `collectionIds` string[] — workspace dataset_source IDs (cache key, like Tableau collections)
      - object
        - `connectorId` integer
        - `tableau` TextqlRpcPublicConnectorTableauConnectorContext, required
          - `collectionIds` string[] — dataset IDs for selected Tableau collections
  - `featureFilter` 'FEATURE_TYPE_UNSPECIFIED' | 'FEATURE_TYPE_REPORT' | 'FEATURE_TYPE_PLAYBOOK' | 'FEATURE_TYPE_DASHBOARD' — Feature types for nudge queries - identifies which feature a query promotes

## Response `200`

Success

- TextqlRpcPublicConnectorGetExampleQueriesResponse
  - `examples` TextqlRpcPublicConnectorExampleQuery[]
    - `id` string
    - `label` string — Display name (e.g., "Explore Data")
    - `message` string — Query text to send (plain text, no formatting)
    - `isMultiSource` boolean — True if requires multiple connectors
    - `requiredConnectorIds` integer[] — Specific connectors needed
    - `category` string — Category (e.g., "Users", "Sales", "Performance")
    - `segments` TextqlRpcPublicConnectorMessageSegment[] — Rich formatted message with styled feature words
      - `content` string — The text content of this segment
      - `featureType` 'FEATURE_TYPE_UNSPECIFIED' | 'FEATURE_TYPE_REPORT' | 'FEATURE_TYPE_PLAYBOOK' | 'FEATURE_TYPE_DASHBOARD' — Feature types for nudge queries - identifies which feature a query promotes
    - `requiredFeatures` TextqlRpcPublicConnectorFeatureType[] — Features this query will use (for tool enabling)
    - `sourceContext` union
      - object
        - `connectorId` integer
        - `powerbi` TextqlRpcPublicConnectorPowerBIConnectorContext, required
          - `reportIds` string[] — PowerBI report IDs
          - `datasetIds` string[] — PowerBI dataset IDs (PowerBI datasets, not internal dataset_source)
          - `collectionIds` string[] — workspace dataset_source IDs (cache key, like Tableau collections)
      - object
        - `connectorId` integer
        - `tableau` TextqlRpcPublicConnectorTableauConnectorContext, required
          - `collectionIds` string[] — dataset IDs for selected Tableau collections

## Other responses

- `default` — Error

---

[API](https://skmtc.net/textql/apis/textql-rpc-platform.md) · [All operations](https://skmtc.net/textql/apis/textql-rpc-platform/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/textql/textql-rpc-platform/revisions/31ce2b0c4427/schema)