Get Derived Table graph for model beta
GET/api/4.0/derived_table/graph/model/{model}
graph_derived_tables_for_model(model, format, color)
Implementation Notes
Discover information about derived tables.
Response Class
DependencyGraph {
graph_text (string, read-only): The graph structure in the dot language that can be rendered into an image.
}
Parameters
| Parameter | Required? | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| model | true | The name of the Lookml model. | string | string |
| format | false | The format of the graph. Valid values are [dot]. Default is `dot` | string | string |
| color | false | Color denoting the build status of the graph. Grey = not built, green = built, yellow = building, red = error. | string | string |
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Get subgraph of derived table and dependencies beta
GET/api/4.0/derived_table/graph/view/{view}
graph_derived_tables_for_view(view, models, workspace)
Implementation Notes
Get the subgraph representing this derived table and its dependencies.
Response Class
DependencyGraph {
graph_text (string, read-only): The graph structure in the dot language that can be rendered into an image.
}
Parameters
| Parameter | Required? | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| view | true | The derived table’s view name. | string | string |
| models | false | The models where this derived table is defined. | string | string |
| workspace | false | The model directory to look in, either `dev` or `production`. | string | string |
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Start a PDT materialization beta
GET/api/4.0/derived_table/{model_name}/{view_name}/start
start_pdt_build(model_name, view_name, force_rebuild, force_full_incremental, workspace, source)
Implementation Notes
Enqueue materialization for a PDT with the given model name and view name.
Response Class
MaterializePDT {
materialization_id (string, read-only): The ID of the enqueued materialization task,
resp_text (string, read-only): Detailed response in text format
}
Parameters
| Parameter | Required? | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| model_name | true | The model of the PDT to start building. | string | string |
| view_name | true | The view name of the PDT to start building. | string | string |
| force_rebuild | false | Force rebuild of required dependent PDTs, even if they are already materialized. | string | string |
| force_full_incremental | false | Force involved incremental PDTs to fully re-materialize. | string | string |
| workspace | false | Workspace in which to materialize selected PDT (‘dev’ or default ‘production’). | string | string |
| source | false | The source of this request. | string | string |
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Check status of a PDT materialization beta
GET/api/4.0/derived_table/{materialization_id}/status
check_pdt_build(materialization_id)
Implementation Notes
Check status of PDT materialization.
Response Class
MaterializePDT {
materialization_id (string, read-only): The ID of the enqueued materialization task,
resp_text (string, read-only): Detailed response in text format
}
Parameters
| Parameter | Required? | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| materialization_id | true | The materialization id to check status for. | string | string |
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Stop a PDT materialization beta
GET/api/4.0/derived_table/{materialization_id}/stop
stop_pdt_build(materialization_id, source)
Implementation Notes
Stop a PDT materialization.
Response Class
MaterializePDT {
materialization_id (string, read-only): The ID of the enqueued materialization task,
resp_text (string, read-only): Detailed response in text format
}
Parameters
| Parameter | Required? | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| materialization_id | true | The materialization id to stop. | string | string |
| source | false | The source of this request. | string | string |
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|