Filtered Liveboard URLs
With Filtered Liveboard URLs, you can share a Liveboard in a specific pre-filtered state by appending filter and parameter tokens to the Liveboard URL. When a user opens the URL, ThoughtSpot applies the specified filters and parameter overrides before rendering the Liveboard.
This is useful when you want to share a Liveboard that is already scoped to a particular region, time period, or business unit, without requiring the recipient to set filters manually.
| To use Filtered Liveboard URLs, the feature must be enabled on your ThoughtSpot instance. To enable it, contact your ThoughtSpot Administrator. |
|
Dynamic parameters are not supported in this release. |
URL structure
A filtered Liveboard URL follows this pattern:
https://<your-instance>/#/pinboard/<liveboard-id>?<filter-tokens>
You append one or more filter tokens or parameter tokens as query string parameters after the Liveboard ID. You can combine filter tokens and parameter tokens in the same URL.
Filter tokens
Each filter token is a set of three query parameters that work together to define one filter condition.
colN
|
The name of the column to filter on. Replace |
opN
|
The filter operator. See Supported filter operators. |
valN
|
The value to filter by. To filter by multiple values, repeat |
For example, to filter a Liveboard to show data only where Region equals West:
https://<your-instance>/#/pinboard/<liveboard-id>?col1=Region&op1=EQ&val1=West
To apply multiple filters, increment the token number for each filter condition:
https://<your-instance>/#/pinboard/<liveboard-id>?col1=Region&op1=EQ&val1=West&col2=Product&op2=IN&val2=Shirts&val2=Shoes
Filter token numbers must be sequential and start from 1. If a number is skipped, ThoughtSpot stops reading filters at the gap and ignores all subsequent tokens.
|
Parameter tokens
You can override Liveboard parameter values in the URL using parameter tokens.
paramN
|
The name of the parameter to override. Replace |
paramValN
|
The value to apply to the parameter. |
For example, to set a parameter named Fiscal Year to 2025:
https://<your-instance>/#/pinboard/<liveboard-id>?param1=Fiscal+Year¶mVal1=2025
To override multiple parameters, increment the number for each pair:
https://<your-instance>/#/pinboard/<liveboard-id>?param1=Fiscal+Year¶mVal1=2025¶m2=Currency¶mVal2=USD
You can combine filter tokens and parameter tokens in the same URL:
https://<your-instance>/#/pinboard/<liveboard-id>?col1=Region&op1=EQ&val1=West¶m1=Fiscal+Year¶mVal1=2025
Supported filter operators
Use one of the following values for the opN parameter.
| Operator | Description | Number of values required |
|---|---|---|
|
Equals |
1 |
|
Not equal to |
1 |
|
Less than |
1 |
|
Less than or equal to |
1 |
|
Greater than |
1 |
|
Greater than or equal to |
1 |
|
Contains |
1 |
|
Begins with |
1 |
|
Ends with |
1 |
|
Between, inclusive of the higher value |
2 |
|
Between, inclusive of the lower value |
2 |
|
Between, inclusive of both values |
2 |
|
Between, exclusive of both values |
2 |
|
Is one of these values |
Multiple |
|
Is not one of these values |
Multiple |
Limitations
-
Dynamic parameters are not supported.
-
The total URL length must not exceed 2000 characters. If the URL is too long, ThoughtSpot returns an error.
-
Filter and parameter token numbers must be sequential starting from
1. Any tokens after a gap in the sequence are ignored. -
Filtered Liveboard URLs is not a data security mechanism. To restrict data access by user or group, use Row Level Security. For more information, see Data security.