Dashboard shares
Execute Shared Dashboard Query
Run one of a shared dashboard's own SQL templates against its agent's data source. The submitted template must match the dashboard's rendered markup; filter inputs are bound parameters validated against the dashboard's declared param controls. Public or team-gated.
Run one of a shared dashboard's own SQL templates against its agent's data source. The submitted template must match the dashboard's rendered markup; filter inputs are bound parameters validated against the dashboard's declared param controls. Public or team-gated.
X-API-Key<token>
Use X-API-Key: .
In: header
Path Parameters
token*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://loading/share/dashboards/string/query" \ -H "Content-Type: application/json" \ -d '{ "sql": "string" }'{
"columns": [
"string"
],
"data": [
{}
]
}{
"cause": {
"code": "api/invalid-json",
"detail": "string"
},
"message": "The request body is not valid JSON"
}{
"cause": {
"code": "dashboard-share/auth-required",
"detail": "This dashboard is only accessible to team members. Please log in."
},
"message": "Authentication required"
}{
"cause": {
"code": "dashboard-share/not-team-member",
"detail": "You are not a member of the team that owns this dashboard."
},
"message": "Access denied"
}{
"cause": {
"code": "dashboard-share/not-found",
"detail": "This shared dashboard does not exist or has been removed."
},
"message": "Shared dashboard not found"
}{
"cause": {
"code": "api/unsupported-media-type",
"detail": "GET requests cannot have a content type header"
},
"message": "Unsupported Media Type"
}