Version 4.0.25.14 (latest)
Run a Look
Runs a given look's query and returns the results in the requested format.
Supported formats:
| result_format | Description |
|---|---|
| json | Plain json |
| json_bi | ( RECOMMENDED ) Row data plus metadata describing the fields, pivots, table calcs, and other aspects of the query. See JsonBi type for schema |
| json_detail | ( LEGACY ) Row data plus metadata describing the fields, pivots, table calcs, and other aspects of the query |
| csv | Comma separated values with a header |
| txt | Tab separated values with a header |
| html | Simple html |
| md | Simple markdown |
| xlsx | MS Excel spreadsheet |
| sql | Returns the generated SQL rather than running the query |
| png | A PNG image of the visualization of the query |
| jpg | A JPG image of the visualization of the query |
Request
GET
/looks/{look_id}/run/{result_format}
Datatype
Description
Request
HTTP Request
path
HTTP Path
Expand HTTP Path definition...
look_id
string
Id of look
result_format
string
Format of result
query
HTTP Query
Expand HTTP Query definition...
limit
integer
Row limit (may override the limit in the saved query).
apply_formatting
boolean
Apply model-specified formatting to each result.
apply_vis
boolean
Apply visualization options to results.
cache
boolean
Get results from cache if available.
image_width
integer
Render width for image formats.
image_height
integer
Render height for image formats.
generate_drill_links
boolean
Generate drill links (only applicable to 'json_detail' format.
force_production
boolean
Force use of production models even if the user is in development mode. Note that this flag being false does not guarantee development models will be used.
cache_only
boolean
Retrieve any results from cache even if the results have expired.
path_prefix
string
Prefix to use for drill links (url encoded).
rebuild_pdts
boolean
Rebuild PDTS used in query.
server_table_calcs
boolean
Perform table calculations on query results
Response
200: Look
Datatype
Description
(string)
string
400: Bad Request
Datatype
Description
(object)
message
lock
string
Error details
documentation_url
lock
string
Documentation link
404: Not Found
Datatype
Description
(object)
message
lock
string
Error details
documentation_url
lock
string
Documentation link
422: Validation Error
Datatype
Description
(object)
message
lock
string
Error details
errors
Expand ValidationErrorDetail definition...
field
lock
string
Field with error
code
lock
string
Error code
message
lock
string
Error info message
documentation_url
lock
string
Documentation link
documentation_url
lock
string
Documentation link
429: Too Many Requests
Datatype
Description
(object)
message
lock
string
Error details
documentation_url
lock
string
Documentation link
Examples
Python
Ruby
TypeScript
