post_api_workspaces_workspaceId_notebook_read
POST
/api/workspaces/{workspaceId}/notebook/read
const url = 'http://localhost:8080/api/workspaces/example/notebook/read';const options = { method: 'POST', headers: {cookie: 'auth_session=<auth_session>', 'Content-Type': 'application/json'}, body: '{"connectionId":"507f1f77bcf86cd799439011","query":"select date, mrr from metrics.mrr","limit":1,"params":{"additionalProperty":"example"},"format":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url http://localhost:8080/api/workspaces/example/notebook/read \ --header 'Content-Type: application/json' \ --cookie auth_session=<auth_session> \ --data '{ "connectionId": "507f1f77bcf86cd799439011", "query": "select date, mrr from metrics.mrr", "limit": 1, "params": { "additionalProperty": "example" }, "format": "example" }'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”workspaceId
required
string
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
connectionId
required
string
Example
507f1f77bcf86cd799439011query
required
string
Example
select date, mrr from metrics.mrrlimit
integer
params
object
key
additional properties
format
string
Responses
Section titled “Responses”Successful response
Media typeapplication/json
object
success
Whether the request succeeded.
boolean
data
Endpoint-specific response payload.
message
string
error
string
Example
{ "message": "Operation completed", "error": "Error message"}Invalid request
Media typeapplication/json
object
success
boolean
error
string
Example
{ "error": "Error message"}Internal server error
Media typeapplication/json
object
success
boolean
error
string
Example
{ "error": "Error message"}