Materialization API

Materialization API

The materialization API allows you to synchronize a view’s data with the latest data. This API enables you to refresh a materialized view to synchronize its data with the latest data load to the underlying tables.

You may want to invoke this API in the following scenarios:

  • When the status of a materialized view is Stale (out of sync) due to an incremental data load

  • When the status of a materialized view is Error due to an error that occurred

Important

If your materialized view refreshes on a schedule, you cannot use the materialization API to refresh it again during the same refresh window.

Supported operations🔗

API endpointAvailable from

POST /tspublic/v1/materialization/refreshview/{id}
Allows you refresh a materialized view.

ThoughtSpot Cloud Not applicable
ThoughtSpot Software 6.0.x

Resource URL🔗

POST /tspublic/v1/materialization/refreshview/{id}

Request Parameters🔗

Path ParameterDescription

id

String. The GUID of the metadata object.

Request Example🔗

cURL
curl -X POST \
--header 'Content-Type: */*' \
--header 'Accept: application/json' \
--header 'X-Requested-By: ThoughtSpot' \
'https://{ThoughtSpot-Host}/callosum/v1/tspublic/v1/materialization/refreshview/e27f3c1c-a9cd-4996-9029-097449cd6f60'
Request URL
https://{ThoughtSpot-Host}/callosum/v1/tspublic/v1/materialization/refreshview/e27f3c1c-a9cd-4996-9029-097449cd6f60

Response Example🔗

Not applicable
204 - Refresh submitted

Response codes🔗

HTTP status codeDescription

204

Successful operation

400

Invalid parameter values

500

The specified view is not materialized or the materialized view is not stale