new Date('2020-05-22').getTime() / 1000
Runtime Parameter overrides
ThoughtSpot lets you create Parameters in a Worksheet and integrate them into formulas, filters, data queries, and Liveboards.
About Parametersđź”—
Parameters are useful for "what-if" analysis, financial planning, cohort analysis, and so on. Parameters allow users to visualize data by running different scenarios with adjustable values. With Parameters, business users can use a single report and adjust the values dynamically to fit the scenario they want to analyze.
You can use Parameters within formulas when querying your data via Search, Liveboards, or Answers. For more information about creating and using Parameters, see the following articles in ThoughtSpot product documentation.
Note
|
Applying Parameter overrides on a Liveboard or Answer via URL, Visual Embed SDK, or REST API hides the filter chips on the Liveboard or Answer page. However, the overrides will be applied to charts and tables. |
Supported data typesđź”—
You can apply runtime Parameters on these data types:
-
VARCHAR
-
BIGINT
-
INT
-
FLOAT
-
DOUBLE
-
BOOLEAN
-
DATE
-
DATE_TIME
-
TIME
Important
|
For the For example, if you want to filter data for 2020-05-22, you can specify the date value in the Epoch time format as |
Apply Parameter overrides in Visual Embed SDKđź”—
The Visual Embed SDK v1.25.0 and later support Parameter overrides on embedded Liveboards and Answers. Before applying a Parameter override on an Answer or Liveboard object, make sure the Parameters and associated formulas are configured in the Worksheet used for generating charts and tables.
The following example shows how to apply multiple runtime filters on a Liveboard embedded using the SDK:
liveboardEmbed.render({
liveboardId: '543619d6-0015-4667-b257-eff547d13a12',
runtimeParameters:[{
name: "Date List Param",
value: 1662361200
},
{
name: "Integer Range Param",
value: 5
}]
});
After loading the embedded object, Parameters can be adjusted using the HostEvent.UpdateParameters event:
liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
name: "Date List Param",
value: 1656914873
},
{
name: "Integer Range Param",
value: 10
}
])
Runtime parameters in object URLsđź”—
You can apply overrides to Parameter values at runtime and visualize data with the adjusted values. Like runtime filters, you can append the Parameter attribute to the object URLs and modify the resulting output.
For example, if you want to override the value of the inflation Parameter on a Liveboard or Answer, add the Parameters to the object URL as shown in these examples:
https://{ThoughtSpot-host}/?param1=Discount¶mVal1=0.25#/pinboard/d084c256-e284-4fc4-b80c-111cb606449a
https://{ThoughtSpot-host}/?param1=Discount¶mVal1=0.25#/saved-answer/3e84d95c-986e-4154-8362-3807906dad50
https://{ThoughtSpot-host}/?param1=Discount¶mVal1=0.25#/answer/
Important
|
ThoughtSpot returns an error if an object URL with Parameter attributes exceeds 2000 characters. |
Apply Parameter overrides via REST APIđź”—
You can apply Parameter overrides to a Liveboard or Answer using REST v1 and v2 API endpoints. Before applying a Parameter override on a Liveboard or Answer object, ensure that the Parameters are configured in the source Worksheet.
REST API v1đź”—
You can apply runtime Parameters when sending an API request to the following v1 Data API endpoints:
-
/tspublic/v1/pinboarddata
(Liveboard data API) -
/tspublic/v1/searchdata
(Search data API)
Liveboard datađź”—
To apply overrides to a Liveboard via REST API, add Parameters to the Liveboard data API request URL as shown in the example here:
https://{ThoughtSpot-host}/callosum/v1/tspublic/v1/pinboarddata?id=86bedf72-c718-49cc-9f49-6e8870233f35&batchsize=-1&pagenumber=-1&offset=-1&formattype=COMPACT¶m1=Double%20list%20param¶mVal1=0
If the API request is valid, overrides are applied to the Liveboard data, and ThoughtSpot returns the requested data in the API response.
{
"adfaa348-755b-4b95-94ff-220c94c0c8b6": {
"columnNames": [
"Ship Mode",
"Total Tax",
"Adjusted Tax"
],
"data": [
[
"fob",
7,
0.0
],
[
"mail",
2,
0.0
]
],
"samplingRatio": 1.0,
"totalRowCount": 2,
"rowCount": 2,
"pageSize": 100000,
"offset": 0,
"name": "Parameters Answer"
}
}
Search datađź”—
To apply overrides on an Answer obtained from a new search query, append the Parameter attributes to the search data API request URL as shown here:
https://{ThoughtSpot-host}/callosum/v1/tspublic/v1/searchdata?query_string=%20%5BTax%5D%5BShip%20Mode%5D&data_source_guid=540c4503-5bc7-4727-897b-f7f4d78dd2ff&batchsize=-1&pagenumber=-1&offset=-1&formattype=COMPACT¶m1=Double%20list%20param¶mVal1=0
Add additional Parametersđź”—
You can add additional Parameters in the URL by incrementing the number for each Parameter attribute; for example, param1, param2, paramVal1, paramVal2, and so on. To add additional overrides, specify the values by separating them with an ampersand (&) as shown in the examples here:
https://{ThoughtSpot-host}/?param1=double%20list%20param¶mVal1=0¶m2=double%20param¶mVal2=0#/pinboard/d084c256-e284-4fc4-b80c-111cb606449a
https://{ThoughtSpot-host}/callosum/v1/tspublic/v1/pinboarddata?id=e36ee65e-64be-436b-a29a-22d8998c4fae&batchsize=-1&pagenumber=-1&offset=-1&formattype=COMPACT¶m1=double%20list%20param¶mVal1=0¶m2=double%20param¶mVal2=0