Python (SDK)
import os
from textql_sdk import Textql
with Textql(
api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:
res = textql.playbooks.get_playbook_reports_batch()
# 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.playbooks.getPlaybookReportsBatch({
body: {},
});
console.log(result);
}
run();curl --request POST \
--url https://app.textql.com/textql.rpc.public.playbook.PlaybookService/GetPlaybookReportsBatch \
--header 'Connect-Protocol-Version: <connect-protocol-version>' \
--header 'Content-Type: application/json' \
--header 'tql_api_key: <api-key>' \
--data '
{
"playbookId": "<string>",
"templateDataIds": [
"<string>"
],
"limitPerTemplate": 123,
"batchRunId": "<string>"
}
'const options = {
method: 'POST',
headers: {
'Connect-Protocol-Version': '<connect-protocol-version>',
tql_api_key: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
playbookId: '<string>',
templateDataIds: ['<string>'],
limitPerTemplate: 123,
batchRunId: '<string>'
})
};
fetch('https://app.textql.com/textql.rpc.public.playbook.PlaybookService/GetPlaybookReportsBatch', 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.playbook.PlaybookService/GetPlaybookReportsBatch",
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([
'playbookId' => '<string>',
'templateDataIds' => [
'<string>'
],
'limitPerTemplate' => 123,
'batchRunId' => '<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.playbook.PlaybookService/GetPlaybookReportsBatch"
payload := strings.NewReader("{\n \"playbookId\": \"<string>\",\n \"templateDataIds\": [\n \"<string>\"\n ],\n \"limitPerTemplate\": 123,\n \"batchRunId\": \"<string>\"\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.playbook.PlaybookService/GetPlaybookReportsBatch")
.header("Connect-Protocol-Version", "<connect-protocol-version>")
.header("tql_api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"playbookId\": \"<string>\",\n \"templateDataIds\": [\n \"<string>\"\n ],\n \"limitPerTemplate\": 123,\n \"batchRunId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.textql.com/textql.rpc.public.playbook.PlaybookService/GetPlaybookReportsBatch")
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 \"playbookId\": \"<string>\",\n \"templateDataIds\": [\n \"<string>\"\n ],\n \"limitPerTemplate\": 123,\n \"batchRunId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"templateDataReports": [
{
"templateDataId": "<string>",
"reports": [
{
"id": "<string>",
"chatId": "<string>",
"cellId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"subject": "<string>",
"summary": "<string>",
"blocks": [
{
"card": {
"blocks": "<array>"
}
}
],
"htmlPreview": "<string>",
"playbookId": "<string>",
"readAt": "2023-11-07T05:31:56Z",
"playbookTemplateDataId": "<string>"
}
],
"totalCount": 123,
"previewCells": [
{
"target": "<string>",
"previewType": "<string>",
"name": "<string>",
"url": "<string>"
}
]
}
]
}{
"message": "<string>",
"details": [
{
"type": "<string>",
"value": "<string>",
"debug": {}
}
]
}Playbook Service
Get Playbook Reports Batch
Get reports for multiple template data IDs in a single batch request
POST
/
textql.rpc.public.playbook.PlaybookService
/
GetPlaybookReportsBatch
Python (SDK)
import os
from textql_sdk import Textql
with Textql(
api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:
res = textql.playbooks.get_playbook_reports_batch()
# 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.playbooks.getPlaybookReportsBatch({
body: {},
});
console.log(result);
}
run();curl --request POST \
--url https://app.textql.com/textql.rpc.public.playbook.PlaybookService/GetPlaybookReportsBatch \
--header 'Connect-Protocol-Version: <connect-protocol-version>' \
--header 'Content-Type: application/json' \
--header 'tql_api_key: <api-key>' \
--data '
{
"playbookId": "<string>",
"templateDataIds": [
"<string>"
],
"limitPerTemplate": 123,
"batchRunId": "<string>"
}
'const options = {
method: 'POST',
headers: {
'Connect-Protocol-Version': '<connect-protocol-version>',
tql_api_key: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
playbookId: '<string>',
templateDataIds: ['<string>'],
limitPerTemplate: 123,
batchRunId: '<string>'
})
};
fetch('https://app.textql.com/textql.rpc.public.playbook.PlaybookService/GetPlaybookReportsBatch', 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.playbook.PlaybookService/GetPlaybookReportsBatch",
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([
'playbookId' => '<string>',
'templateDataIds' => [
'<string>'
],
'limitPerTemplate' => 123,
'batchRunId' => '<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.playbook.PlaybookService/GetPlaybookReportsBatch"
payload := strings.NewReader("{\n \"playbookId\": \"<string>\",\n \"templateDataIds\": [\n \"<string>\"\n ],\n \"limitPerTemplate\": 123,\n \"batchRunId\": \"<string>\"\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.playbook.PlaybookService/GetPlaybookReportsBatch")
.header("Connect-Protocol-Version", "<connect-protocol-version>")
.header("tql_api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"playbookId\": \"<string>\",\n \"templateDataIds\": [\n \"<string>\"\n ],\n \"limitPerTemplate\": 123,\n \"batchRunId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.textql.com/textql.rpc.public.playbook.PlaybookService/GetPlaybookReportsBatch")
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 \"playbookId\": \"<string>\",\n \"templateDataIds\": [\n \"<string>\"\n ],\n \"limitPerTemplate\": 123,\n \"batchRunId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"templateDataReports": [
{
"templateDataId": "<string>",
"reports": [
{
"id": "<string>",
"chatId": "<string>",
"cellId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"subject": "<string>",
"summary": "<string>",
"blocks": [
{
"card": {
"blocks": "<array>"
}
}
],
"htmlPreview": "<string>",
"playbookId": "<string>",
"readAt": "2023-11-07T05:31:56Z",
"playbookTemplateDataId": "<string>"
}
],
"totalCount": 123,
"previewCells": [
{
"target": "<string>",
"previewType": "<string>",
"name": "<string>",
"url": "<string>"
}
]
}
]
}{
"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
Batch request to get reports for multiple template data IDs efficiently
Response
Success
Batch response with reports grouped by template_data_id
Show child attributes
Show child attributes
⌘I