Get Content Thumbnail

Version 4.0.24.6 (latest)

Get an image representing the contents of a dashboard or look.

The returned thumbnail is an abstract representation of the contents of a dashboard or look and does not reflect the actual data displayed in the respective visualizations.

Request

GET /content_thumbnail/{type}/{resource_id}
Datatype
Description
Request
HTTP Request
path
HTTP Path
Expand HTTP Path definition...
type
string
Either dashboard or look
resource_id
string
ID of the dashboard or look to render
query
HTTP Query
Expand HTTP Query definition...
reload
string
Whether or not to refresh the rendered image with the latest content
theme
string
Light or dark background. Default is "light"
format
string
A value of png produces a thumbnail in PNG format instead of SVG (default)
width
integer
The width of the image if format is supplied
height
integer
The height of the image if format is supplied

Response

200: Content thumbnail

Datatype
Description
(string)
string

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