Run a python report over dashboard-filtered SQL

curl --request POST \
  --url https://{tenant}.cubecloud.dev/api/v1/embed/dashboard/{publicId}/python-run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reportId": 123,
  "reportVersionId": 123,
  "sqlQuery": "<string>"
}
'

import requests

url = "https://{tenant}.cubecloud.dev/api/v1/embed/dashboard/{publicId}/python-run"

payload = {
    "reportId": 123,
    "reportVersionId": 123,
    "sqlQuery": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reportId: 123, reportVersionId: 123, sqlQuery: '<string>'})
};

fetch('https://{tenant}.cubecloud.dev/api/v1/embed/dashboard/{publicId}/python-run', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenant}.cubecloud.dev/api/v1/embed/dashboard/{publicId}/python-run",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reportId' => 123,
    'reportVersionId' => 123,
    'sqlQuery' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenant}.cubecloud.dev/api/v1/embed/dashboard/{publicId}/python-run"

	payload := strings.NewReader("{\n  \"reportId\": 123,\n  \"reportVersionId\": 123,\n  \"sqlQuery\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{tenant}.cubecloud.dev/api/v1/embed/dashboard/{publicId}/python-run")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reportId\": 123,\n  \"reportVersionId\": 123,\n  \"sqlQuery\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant}.cubecloud.dev/api/v1/embed/dashboard/{publicId}/python-run")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reportId\": 123,\n  \"reportVersionId\": 123,\n  \"sqlQuery\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "at": "<string>",
  "inputRowCount": 123,
  "stderr": "<string>",
  "stdout": "<string>",
  "executionError": "<string>",
  "outputData": null
}

POST

api

embed

dashboard

{publicId}

python-run

Run a python report over dashboard-filtered SQL

curl --request POST \
  --url https://{tenant}.cubecloud.dev/api/v1/embed/dashboard/{publicId}/python-run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reportId": 123,
  "reportVersionId": 123,
  "sqlQuery": "<string>"
}
'

import requests

url = "https://{tenant}.cubecloud.dev/api/v1/embed/dashboard/{publicId}/python-run"

payload = {
    "reportId": 123,
    "reportVersionId": 123,
    "sqlQuery": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reportId: 123, reportVersionId: 123, sqlQuery: '<string>'})
};

fetch('https://{tenant}.cubecloud.dev/api/v1/embed/dashboard/{publicId}/python-run', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenant}.cubecloud.dev/api/v1/embed/dashboard/{publicId}/python-run",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reportId' => 123,
    'reportVersionId' => 123,
    'sqlQuery' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenant}.cubecloud.dev/api/v1/embed/dashboard/{publicId}/python-run"

	payload := strings.NewReader("{\n  \"reportId\": 123,\n  \"reportVersionId\": 123,\n  \"sqlQuery\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{tenant}.cubecloud.dev/api/v1/embed/dashboard/{publicId}/python-run")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reportId\": 123,\n  \"reportVersionId\": 123,\n  \"sqlQuery\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant}.cubecloud.dev/api/v1/embed/dashboard/{publicId}/python-run")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reportId\": 123,\n  \"reportVersionId\": 123,\n  \"sqlQuery\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "at": "<string>",
  "inputRowCount": 123,
  "stderr": "<string>",
  "stdout": "<string>",
  "executionError": "<string>",
  "outputData": null
}

Re-runs the Python analysis attached to one of this dashboard’s reports over sqlQuery — the report’s own query with the dashboard’s filters and time grains already applied — and returns the result without persisting it. Authorized against the dashboard, exactly as GET /api/v1/embed/dashboard/{publicId} is. The reportVersionId must be one of that dashboard’s published report snapshots and must belong to reportId; anything else returns 403. The Python itself is read server-side from that snapshot — it is never supplied by the caller. The analysis runs under the calling embed user’s own security context, so row-level security applies to the viewer, and the stored result other viewers see is left untouched. Results are cached briefly per (report, code, SQL, user); failures are not cached. Returns 403 when Python analysis is not enabled for the account.

Authorizations

Authorization

string

header

required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

publicId

string

required

Body

application/json

EmbedPythonFilteredRunInput

reportId

integer

required

reportVersionId

integer

required

sqlQuery

string

required

Response

200 - application/json

string

required

inputRowCount

integer

required

stderr

string

required

stdout

string

required

executionError

string | null

outputData

unknown

Enable or disable signed embedding for a dashboard Generate an embed session

⌘I

Getting Started

Core Data Endpoints

AI Endpoints

Platform Endpoints

Run a python report over dashboard-filtered SQL

Authorizations

Path Parameters

Body

Response