Get a report delivery
curl --request GET \
--url https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/report-deliveries/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/report-deliveries/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/report-deliveries/{id}', 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/deployments/{deploymentId}/report-deliveries/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/report-deliveries/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/report-deliveries/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/report-deliveries/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"deploymentId": 123,
"destination": {
"anchorCell": "<string>",
"spreadsheetId": "<string>",
"sheetId": 123,
"sheetName": "<string>"
},
"id": 123,
"name": "<string>",
"notifications": {
"email": true,
"inbox": true,
"slackChannelId": "<string>",
"slackChannelName": "<string>"
},
"status": "active",
"writeMode": "overwrite",
"lastRunAt": "2023-11-07T05:31:56Z",
"lastSuccessAt": "2023-11-07T05:31:56Z",
"nextRunAt": "<unknown>",
"ownerUserId": 123,
"pausedAt": "<unknown>",
"reportId": 123,
"reportName": "<string>",
"reportPublicId": "<string>",
"reportWorkbookId": 123,
"runAsUserId": 123,
"runningSince": "2023-11-07T05:31:56Z",
"schedule": {
"cronExpressions": [
"<string>"
],
"timezone": "<string>"
},
"shape": {
"columns": [
{
"column": "<string>",
"header": "<string>",
"placeholder": true
}
]
},
"sheetTitle": "<string>",
"spreadsheetTitle": "<string>"
}Report Deliveries
Get a report delivery
GET
/
api
/
v1
/
deployments
/
{deploymentId}
/
report-deliveries
/
{id}
Get a report delivery
curl --request GET \
--url https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/report-deliveries/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/report-deliveries/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/report-deliveries/{id}', 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/deployments/{deploymentId}/report-deliveries/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/report-deliveries/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/report-deliveries/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/report-deliveries/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"deploymentId": 123,
"destination": {
"anchorCell": "<string>",
"spreadsheetId": "<string>",
"sheetId": 123,
"sheetName": "<string>"
},
"id": 123,
"name": "<string>",
"notifications": {
"email": true,
"inbox": true,
"slackChannelId": "<string>",
"slackChannelName": "<string>"
},
"status": "active",
"writeMode": "overwrite",
"lastRunAt": "2023-11-07T05:31:56Z",
"lastSuccessAt": "2023-11-07T05:31:56Z",
"nextRunAt": "<unknown>",
"ownerUserId": 123,
"pausedAt": "<unknown>",
"reportId": 123,
"reportName": "<string>",
"reportPublicId": "<string>",
"reportWorkbookId": 123,
"runAsUserId": 123,
"runningSince": "2023-11-07T05:31:56Z",
"schedule": {
"cronExpressions": [
"<string>"
],
"timezone": "<string>"
},
"shape": {
"columns": [
{
"column": "<string>",
"header": "<string>",
"placeholder": true
}
]
},
"sheetTitle": "<string>",
"spreadsheetTitle": "<string>"
}In preview: ask Cube support to enable it.
404 if the caller cannot see it. Admins and roles granting ScheduledTasksRead or ScheduledTasksManage on the deployment see every delivery; others only their own.Authorizations
Path Parameters
Response
200 - application/json
What each run does with what the previous one wrote. overwrite (the default) replaces the delivered block. append adds the whole result below it, header only on the first run and no deduplication. new_sheet writes each run to a new tab.
Available options:
overwrite, append, new_sheet