Validate Content

Version 4.0.24.20 (latest)

Validate All Content

Performs validation of all looks and dashboards Returns a list of errors found as well as metadata about the content validation run.

Request

GET /content_validation
Datatype
Description
Request
HTTP Request
query
HTTP Query
Expand HTTP Query definition...
fields
string
Requested fields.

Response

200: Content validation results

Datatype
Description
content_with_errors
Expand ContentValidatorError definition...
Expand ContentValidationLook definition...
id
string
Unique Id
title
string
Look Title
short_url
string
Short Url
folder
Folder of this Look
Expand ContentValidationDashboard definition...
description
string
Description
id
string
Unique Id
folder
Folder
title
string
Dashboard Title
url
string
Relative URL of the dashboard
dashboard_element
Expand ContentValidationDashboardElement definition...
body_text
string
Text tile body text
dashboard_id
string
Id of Dashboard
id
string
Unique Id
look_id
string
Id Of Look
note_display
string
Note Display
note_state
string
Note State
note_text
string
Note Text
note_text_as_html
string
Note Text as Html
query_id
string
Id Of Query
subtitle_text
string
Text tile subtitle text
title
string
Title of dashboard element
title_hidden
boolean
Whether title is hidden
title_text
string
Text tile title
type
string
Type
rich_content_json
string
JSON with all the properties required for rich editor and buttons elements
extension_id
string
Extension ID
dashboard_filter
Expand ContentValidationDashboardFilter definition...
id
string
Unique Id
dashboard_id
string
Id of Dashboard
name
string
Name of filter
title
string
Title of filter
type
string
Type of filter: one of date, number, string, or field
default_value
string
Default value of filter
model
string
Model of filter (required if type = field)
explore
string
Explore of filter (required if type = field)
dimension
string
Dimension of filter (required if type = field)
scheduled_plan
Expand ContentValidationScheduledPlan definition...
name
string
Name of this scheduled plan
look_id
string
Id of a look
id
string
Unique Id
Expand ContentValidationAlert definition...
id
string
ID of the alert
lookml_dashboard_id
string
ID of the LookML dashboard associated with the alert
lookml_link_id
string
ID of the LookML dashboard element associated with the alert
custom_url_base
string
Domain for the custom url selected by the alert creator from the admin defined domain allowlist
custom_url_params
string
Parameters and path for the custom url defined by the alert creator
custom_url_label
string
Label for the custom url defined by the alert creator
show_custom_url
boolean
Boolean to determine if the custom url should be used
custom_title
string
An optional, user-defined title for the alert
lookml_dashboard
Expand ContentValidationLookMLDashboard definition...
id
string
ID of the LookML Dashboard
title
string
Title of the LookML Dashboard
space_id
string
ID of Space
lookml_dashboard_element
Expand ContentValidationLookMLDashboardElement definition...
lookml_link_id
string
Link ID of the LookML Dashboard Element
title
string
Title of the LookML Dashboard Element
Expand ContentValidationError definition...
message
string
Error message
field_name
string
Name of the field involved in the error
model_name
string
Name of the model involved in the error
explore_name
string
Name of the explore involved in the error
removable
boolean
Whether this validation error is removable
id
string
An id unique to this piece of content for this validation run
computation_time
number
Duration of content validation in seconds
total_looks_validated
integer
The number of looks validated
total_dashboard_elements_validated
integer
The number of dashboard elements validated
total_dashboard_filters_validated
integer
The number of dashboard filters validated
total_scheduled_plans_validated
integer
The number of scheduled plans validated
total_alerts_validated
integer
The number of alerts validated
total_explores_validated
integer
The number of explores used across all content validated

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