Python (SDK)
import os
from textql_sdk import Textql
with Textql(
api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:
res = textql.dashboards.update_dashboard_schedule()
# Handle response
print(res)import { Textql } from "@textql/sdk";
const textql = new Textql({
apiKey: process.env["TEXTQL_API_KEY"] ?? "",
});
async function run() {
const result = await textql.dashboards.updateDashboardSchedule({
body: {},
});
console.log(result);
}
run();curl --request POST \
--url https://app.textql.com/textql.rpc.public.dashboard.DashboardService/UpdateDashboardSchedule \
--header 'Connect-Protocol-Version: <connect-protocol-version>' \
--header 'Content-Type: application/json' \
--header 'tql_api_key: <api-key>' \
--data '
{
"dashboardId": "<string>",
"scheduleEnabled": true,
"cronString": "<string>",
"dataSources": [
{
"file": {
"datasetId": "<string>",
"fileName": "<string>",
"sheetIndex": 123
},
"type": "<string>",
"name": "<string>",
"parameters": [
{
"name": "<string>",
"type": "<string>",
"default": "<string>"
}
],
"grant": {
"roles": [
"<string>"
],
"members": [
"<string>"
]
}
}
]
}
'const options = {
method: 'POST',
headers: {
'Connect-Protocol-Version': '<connect-protocol-version>',
tql_api_key: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
dashboardId: '<string>',
scheduleEnabled: true,
cronString: '<string>',
dataSources: [
{
file: {datasetId: '<string>', fileName: '<string>', sheetIndex: 123},
type: '<string>',
name: '<string>',
parameters: [{name: '<string>', type: '<string>', default: '<string>'}],
grant: {roles: ['<string>'], members: ['<string>']}
}
]
})
};
fetch('https://app.textql.com/textql.rpc.public.dashboard.DashboardService/UpdateDashboardSchedule', 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://app.textql.com/textql.rpc.public.dashboard.DashboardService/UpdateDashboardSchedule",
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([
'dashboardId' => '<string>',
'scheduleEnabled' => true,
'cronString' => '<string>',
'dataSources' => [
[
'file' => [
'datasetId' => '<string>',
'fileName' => '<string>',
'sheetIndex' => 123
],
'type' => '<string>',
'name' => '<string>',
'parameters' => [
[
'name' => '<string>',
'type' => '<string>',
'default' => '<string>'
]
],
'grant' => [
'roles' => [
'<string>'
],
'members' => [
'<string>'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Connect-Protocol-Version: <connect-protocol-version>",
"Content-Type: application/json",
"tql_api_key: <api-key>"
],
]);
$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://app.textql.com/textql.rpc.public.dashboard.DashboardService/UpdateDashboardSchedule"
payload := strings.NewReader("{\n \"dashboardId\": \"<string>\",\n \"scheduleEnabled\": true,\n \"cronString\": \"<string>\",\n \"dataSources\": [\n {\n \"file\": {\n \"datasetId\": \"<string>\",\n \"fileName\": \"<string>\",\n \"sheetIndex\": 123\n },\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"parameters\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"default\": \"<string>\"\n }\n ],\n \"grant\": {\n \"roles\": [\n \"<string>\"\n ],\n \"members\": [\n \"<string>\"\n ]\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Connect-Protocol-Version", "<connect-protocol-version>")
req.Header.Add("tql_api_key", "<api-key>")
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://app.textql.com/textql.rpc.public.dashboard.DashboardService/UpdateDashboardSchedule")
.header("Connect-Protocol-Version", "<connect-protocol-version>")
.header("tql_api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"dashboardId\": \"<string>\",\n \"scheduleEnabled\": true,\n \"cronString\": \"<string>\",\n \"dataSources\": [\n {\n \"file\": {\n \"datasetId\": \"<string>\",\n \"fileName\": \"<string>\",\n \"sheetIndex\": 123\n },\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"parameters\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"default\": \"<string>\"\n }\n ],\n \"grant\": {\n \"roles\": [\n \"<string>\"\n ],\n \"members\": [\n \"<string>\"\n ]\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.textql.com/textql.rpc.public.dashboard.DashboardService/UpdateDashboardSchedule")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Connect-Protocol-Version"] = '<connect-protocol-version>'
request["tql_api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dashboardId\": \"<string>\",\n \"scheduleEnabled\": true,\n \"cronString\": \"<string>\",\n \"dataSources\": [\n {\n \"file\": {\n \"datasetId\": \"<string>\",\n \"fileName\": \"<string>\",\n \"sheetIndex\": 123\n },\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"parameters\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"default\": \"<string>\"\n }\n ],\n \"grant\": {\n \"roles\": [\n \"<string>\"\n ],\n \"members\": [\n \"<string>\"\n ]\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"dashboard": {
"id": "<string>",
"orgId": "<string>",
"creatorId": "<string>",
"name": "<string>",
"description": "<string>",
"code": "<string>",
"chatId": "<string>",
"cellId": "<string>",
"isPublic": true,
"screenshotUrl": "<string>",
"htmlUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"refreshedAt": "2023-11-07T05:31:56Z",
"creator": {
"memberId": "<string>",
"memberEmail": "<string>",
"memberName": "<string>"
},
"streamlitUrl": "<string>",
"publishedCode": "<string>",
"publishedAt": "2023-11-07T05:31:56Z",
"hasUnpublishedChanges": true,
"dataSources": [
{
"file": {
"datasetId": "<string>",
"fileName": "<string>",
"sheetIndex": 123
},
"type": "<string>",
"name": "<string>",
"parameters": [
{
"name": "<string>",
"type": "<string>",
"default": "<string>"
}
],
"grant": {
"roles": [
"<string>"
],
"members": [
"<string>"
]
}
}
],
"scheduleEnabled": true,
"cronString": "<string>",
"latestScheduledRunAt": "2023-11-07T05:31:56Z",
"folderId": "<string>",
"configSource": {
"filePath": "<string>",
"syncError": "<string>",
"breakingPatchId": "<string>"
},
"isFavorited": true
}
}{
"message": "<string>",
"details": [
{
"type": "<string>",
"value": "<string>",
"debug": {}
}
]
}Dashboard Service
Update Dashboard Schedule
Scheduling
POST
/
textql.rpc.public.dashboard.DashboardService
/
UpdateDashboardSchedule
Python (SDK)
import os
from textql_sdk import Textql
with Textql(
api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:
res = textql.dashboards.update_dashboard_schedule()
# Handle response
print(res)import { Textql } from "@textql/sdk";
const textql = new Textql({
apiKey: process.env["TEXTQL_API_KEY"] ?? "",
});
async function run() {
const result = await textql.dashboards.updateDashboardSchedule({
body: {},
});
console.log(result);
}
run();curl --request POST \
--url https://app.textql.com/textql.rpc.public.dashboard.DashboardService/UpdateDashboardSchedule \
--header 'Connect-Protocol-Version: <connect-protocol-version>' \
--header 'Content-Type: application/json' \
--header 'tql_api_key: <api-key>' \
--data '
{
"dashboardId": "<string>",
"scheduleEnabled": true,
"cronString": "<string>",
"dataSources": [
{
"file": {
"datasetId": "<string>",
"fileName": "<string>",
"sheetIndex": 123
},
"type": "<string>",
"name": "<string>",
"parameters": [
{
"name": "<string>",
"type": "<string>",
"default": "<string>"
}
],
"grant": {
"roles": [
"<string>"
],
"members": [
"<string>"
]
}
}
]
}
'const options = {
method: 'POST',
headers: {
'Connect-Protocol-Version': '<connect-protocol-version>',
tql_api_key: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
dashboardId: '<string>',
scheduleEnabled: true,
cronString: '<string>',
dataSources: [
{
file: {datasetId: '<string>', fileName: '<string>', sheetIndex: 123},
type: '<string>',
name: '<string>',
parameters: [{name: '<string>', type: '<string>', default: '<string>'}],
grant: {roles: ['<string>'], members: ['<string>']}
}
]
})
};
fetch('https://app.textql.com/textql.rpc.public.dashboard.DashboardService/UpdateDashboardSchedule', 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://app.textql.com/textql.rpc.public.dashboard.DashboardService/UpdateDashboardSchedule",
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([
'dashboardId' => '<string>',
'scheduleEnabled' => true,
'cronString' => '<string>',
'dataSources' => [
[
'file' => [
'datasetId' => '<string>',
'fileName' => '<string>',
'sheetIndex' => 123
],
'type' => '<string>',
'name' => '<string>',
'parameters' => [
[
'name' => '<string>',
'type' => '<string>',
'default' => '<string>'
]
],
'grant' => [
'roles' => [
'<string>'
],
'members' => [
'<string>'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Connect-Protocol-Version: <connect-protocol-version>",
"Content-Type: application/json",
"tql_api_key: <api-key>"
],
]);
$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://app.textql.com/textql.rpc.public.dashboard.DashboardService/UpdateDashboardSchedule"
payload := strings.NewReader("{\n \"dashboardId\": \"<string>\",\n \"scheduleEnabled\": true,\n \"cronString\": \"<string>\",\n \"dataSources\": [\n {\n \"file\": {\n \"datasetId\": \"<string>\",\n \"fileName\": \"<string>\",\n \"sheetIndex\": 123\n },\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"parameters\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"default\": \"<string>\"\n }\n ],\n \"grant\": {\n \"roles\": [\n \"<string>\"\n ],\n \"members\": [\n \"<string>\"\n ]\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Connect-Protocol-Version", "<connect-protocol-version>")
req.Header.Add("tql_api_key", "<api-key>")
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://app.textql.com/textql.rpc.public.dashboard.DashboardService/UpdateDashboardSchedule")
.header("Connect-Protocol-Version", "<connect-protocol-version>")
.header("tql_api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"dashboardId\": \"<string>\",\n \"scheduleEnabled\": true,\n \"cronString\": \"<string>\",\n \"dataSources\": [\n {\n \"file\": {\n \"datasetId\": \"<string>\",\n \"fileName\": \"<string>\",\n \"sheetIndex\": 123\n },\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"parameters\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"default\": \"<string>\"\n }\n ],\n \"grant\": {\n \"roles\": [\n \"<string>\"\n ],\n \"members\": [\n \"<string>\"\n ]\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.textql.com/textql.rpc.public.dashboard.DashboardService/UpdateDashboardSchedule")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Connect-Protocol-Version"] = '<connect-protocol-version>'
request["tql_api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dashboardId\": \"<string>\",\n \"scheduleEnabled\": true,\n \"cronString\": \"<string>\",\n \"dataSources\": [\n {\n \"file\": {\n \"datasetId\": \"<string>\",\n \"fileName\": \"<string>\",\n \"sheetIndex\": 123\n },\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"parameters\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"default\": \"<string>\"\n }\n ],\n \"grant\": {\n \"roles\": [\n \"<string>\"\n ],\n \"members\": [\n \"<string>\"\n ]\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"dashboard": {
"id": "<string>",
"orgId": "<string>",
"creatorId": "<string>",
"name": "<string>",
"description": "<string>",
"code": "<string>",
"chatId": "<string>",
"cellId": "<string>",
"isPublic": true,
"screenshotUrl": "<string>",
"htmlUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"refreshedAt": "2023-11-07T05:31:56Z",
"creator": {
"memberId": "<string>",
"memberEmail": "<string>",
"memberName": "<string>"
},
"streamlitUrl": "<string>",
"publishedCode": "<string>",
"publishedAt": "2023-11-07T05:31:56Z",
"hasUnpublishedChanges": true,
"dataSources": [
{
"file": {
"datasetId": "<string>",
"fileName": "<string>",
"sheetIndex": 123
},
"type": "<string>",
"name": "<string>",
"parameters": [
{
"name": "<string>",
"type": "<string>",
"default": "<string>"
}
],
"grant": {
"roles": [
"<string>"
],
"members": [
"<string>"
]
}
}
],
"scheduleEnabled": true,
"cronString": "<string>",
"latestScheduledRunAt": "2023-11-07T05:31:56Z",
"folderId": "<string>",
"configSource": {
"filePath": "<string>",
"syncError": "<string>",
"breakingPatchId": "<string>"
},
"isFavorited": true
}
}{
"message": "<string>",
"details": [
{
"type": "<string>",
"value": "<string>",
"debug": {}
}
]
}Authorizations
Headers
Define the version of the Connect protocol
Available options:
1 Define the timeout, in ms
Body
application/json
Response
Success
Show child attributes
Show child attributes
⌘I