Validate Project

Version 4.0.24.18

Validate Project

Performs lint validation of all lookml files in the project. Returns a list of errors found, if any.

Validating the content of all the files in a project can be computationally intensive for large projects. For best performance, call validate_project(project_id) only when you really want to recompute project validation. To quickly display the results of the most recent project validation (without recomputing), use project_validation_results(project_id)

Request

POST /projects/{project_id}/validate
Datatype
Description
Request
HTTP Request
path
HTTP Path
Expand HTTP Path definition...
project_id
string
Project Id
query
HTTP Query
Expand HTTP Query definition...
fields
string
Requested fields

Response

200: Project validation results

Datatype
Description
errors
Expand ProjectError definition...
code
string
A stable token that uniquely identifies this class of error, ignoring parameter values. Error message text may vary due to parameters or localization, but error codes do not. For example, a "File not found" error will have the same error code regardless of the filename in question or the user's display language
severity
string
Severity: fatal, error, warning, info, success
kind
string
Error classification: syntax, deprecation, model_configuration, etc
message
string
Error message which may contain information such as dashboard or model names that may be considered sensitive in some use cases. Avoid storing or sending this message outside of Looker
field_name
string
The field associated with this error
file_path
string
Name of the file containing this error
line_number
integer
Line number in the file of this error
model_id
string
The model associated with this error
explore
string
The explore associated with this error
help_url
string
A link to Looker documentation about this error
params
object
Error parameters
sanitized_message
string
A version of the error message that does not contain potentially sensitive information. Suitable for situations in which messages are stored or sent to consumers outside of Looker, such as external logs. Sanitized messages will display "(?)" where sensitive information would appear in the corresponding non-sanitized message
project_digest
string
A hash value computed from the project's current state
models_not_validated
Expand ModelsNotValidated definition...
name
string
Model name
project_file_id
string
Project file
computation_time
number
Duration of project validation in seconds

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

422: Validation Error

Datatype
Description
(object)
message
string
Error details
Expand ValidationErrorDetail definition...
field
string
Field with error
code
string
Error code
message
string
Error info message
documentation_url
string
Documentation link
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

Examples