import Roark from '@roarkanalytics/sdk';
const client = new Roark({
bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});
const dashboard = await client.dashboard.create({ name: 'x' });
console.log(dashboard.data);import os
from roark_analytics import Roark
client = Roark(
bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"), # This is the default and can be omitted
)
dashboard = client.dashboard.create(
name="x",
)
print(dashboard.data)curl --request POST \
--url https://api.roark.ai/v1/dashboard \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Support agent health",
"timeRange": {
"type": "LAST",
"value": 30,
"unit": "DAYS"
},
"filters": [
{
"type": "MODALITY",
"value": "call"
}
],
"widgets": [
{
"name": "Sentiment",
"display": "LINE",
"size": "LARGE",
"interval": "DAY",
"measures": [
{
"metric": "sentiment_score",
"aggregation": "AVG"
}
]
},
{
"name": "Calls",
"display": "NUMBER",
"measures": [
{
"type": "CONVERSATION"
}
]
}
]
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.roark.ai/v1/dashboard",
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([
'name' => 'Support agent health',
'timeRange' => [
'type' => 'LAST',
'value' => 30,
'unit' => 'DAYS'
],
'filters' => [
[
'type' => 'MODALITY',
'value' => 'call'
]
],
'widgets' => [
[
'name' => 'Sentiment',
'display' => 'LINE',
'size' => 'LARGE',
'interval' => 'DAY',
'measures' => [
[
'metric' => 'sentiment_score',
'aggregation' => 'AVG'
]
]
],
[
'name' => 'Calls',
'display' => 'NUMBER',
'measures' => [
[
'type' => 'CONVERSATION'
]
]
]
]
]),
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://api.roark.ai/v1/dashboard"
payload := strings.NewReader("{\n \"name\": \"Support agent health\",\n \"timeRange\": {\n \"type\": \"LAST\",\n \"value\": 30,\n \"unit\": \"DAYS\"\n },\n \"filters\": [\n {\n \"type\": \"MODALITY\",\n \"value\": \"call\"\n }\n ],\n \"widgets\": [\n {\n \"name\": \"Sentiment\",\n \"display\": \"LINE\",\n \"size\": \"LARGE\",\n \"interval\": \"DAY\",\n \"measures\": [\n {\n \"metric\": \"sentiment_score\",\n \"aggregation\": \"AVG\"\n }\n ]\n },\n {\n \"name\": \"Calls\",\n \"display\": \"NUMBER\",\n \"measures\": [\n {\n \"type\": \"CONVERSATION\"\n }\n ]\n }\n ]\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://api.roark.ai/v1/dashboard")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Support agent health\",\n \"timeRange\": {\n \"type\": \"LAST\",\n \"value\": 30,\n \"unit\": \"DAYS\"\n },\n \"filters\": [\n {\n \"type\": \"MODALITY\",\n \"value\": \"call\"\n }\n ],\n \"widgets\": [\n {\n \"name\": \"Sentiment\",\n \"display\": \"LINE\",\n \"size\": \"LARGE\",\n \"interval\": \"DAY\",\n \"measures\": [\n {\n \"metric\": \"sentiment_score\",\n \"aggregation\": \"AVG\"\n }\n ]\n },\n {\n \"name\": \"Calls\",\n \"display\": \"NUMBER\",\n \"measures\": [\n {\n \"type\": \"CONVERSATION\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roark.ai/v1/dashboard")
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 \"name\": \"Support agent health\",\n \"timeRange\": {\n \"type\": \"LAST\",\n \"value\": 30,\n \"unit\": \"DAYS\"\n },\n \"filters\": [\n {\n \"type\": \"MODALITY\",\n \"value\": \"call\"\n }\n ],\n \"widgets\": [\n {\n \"name\": \"Sentiment\",\n \"display\": \"LINE\",\n \"size\": \"LARGE\",\n \"interval\": \"DAY\",\n \"measures\": [\n {\n \"metric\": \"sentiment_score\",\n \"aggregation\": \"AVG\"\n }\n ]\n },\n {\n \"name\": \"Calls\",\n \"display\": \"NUMBER\",\n \"measures\": [\n {\n \"type\": \"CONVERSATION\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"isDefault": true,
"configManaged": true,
"timeRange": {
"type": "LAST",
"value": 500,
"unit": "DAYS"
},
"createdAt": "<string>",
"updatedAt": "<string>",
"filters": [
{
"type": "METRIC_PROPERTY",
"value": "<string>",
"property": "<string>",
"operator": "EQUALS"
}
],
"widgets": [
{
"measures": [
{
"type": "METRIC",
"metric": "<string>",
"aggregation": "COUNT",
"percentile": 50,
"distinctBy": "NONE",
"nestedAggregation": "COUNT",
"nestedAggregationPercentile": 50,
"passOperator": "EQUALS",
"passValue": "<string>",
"breakdown": {
"type": "METRIC_PROPERTY",
"property": "<string>"
},
"filters": [
{
"type": "METRIC_PROPERTY",
"value": "<string>",
"property": "<string>",
"operator": "EQUALS"
}
],
"isBaseline": true,
"color": "GREEN"
}
],
"name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filters": [
{
"type": "METRIC_PROPERTY",
"value": "<string>",
"property": "<string>",
"operator": "EQUALS"
}
],
"interval": "HOUR",
"comparisonMode": "NONE",
"comparisonGroups": [
{
"name": "<string>",
"filters": [
{
"type": "METRIC_PROPERTY",
"value": "<string>",
"property": "<string>",
"operator": "EQUALS"
}
],
"color": "GREEN"
}
],
"description": "<string>",
"display": "LINE",
"size": "SMALL"
}
]
}
}{
"type": "validation",
"code": "invalid_parameter",
"message": "The request was invalid",
"param": "email"
}{
"type": "authentication",
"code": "unauthorized",
"message": "Authentication required"
}{
"type": "forbidden",
"code": "permission_denied",
"message": "You do not have permission to access this resource"
}{
"type": "not_found",
"code": "resource_not_found",
"message": "The requested resource could not be found"
}{
"type": "conflict",
"code": "resource_in_use",
"message": "The resource is in use and cannot be deleted"
}{
"type": "rate_limit",
"code": "too_many_requests",
"message": "Rate limit exceeded"
}{
"type": "internal",
"code": "internal_error",
"message": "Internal server error"
}Create a dashboard
Creates a dashboard with its widgets. Each widget is an analytics query (see POST /v1/analytics/query)
with a name unique on the dashboard, a display (LINE, NUMBER, RADAR, STACKED_BAR, TABLE) and a
size (SMALL, MEDIUM, LARGE, EXTRA_LARGE). Widgets render top to bottom in the order given.
Dashboard filters apply over every widget and must be conversation-level: AGENT_PROPERTY,
CALL_PROPERTY, MODALITY, DATASET or METRIC_VALUE. On a field a widget already filters, the dashboard’s wins.
import Roark from '@roarkanalytics/sdk';
const client = new Roark({
bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});
const dashboard = await client.dashboard.create({ name: 'x' });
console.log(dashboard.data);import os
from roark_analytics import Roark
client = Roark(
bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"), # This is the default and can be omitted
)
dashboard = client.dashboard.create(
name="x",
)
print(dashboard.data)curl --request POST \
--url https://api.roark.ai/v1/dashboard \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Support agent health",
"timeRange": {
"type": "LAST",
"value": 30,
"unit": "DAYS"
},
"filters": [
{
"type": "MODALITY",
"value": "call"
}
],
"widgets": [
{
"name": "Sentiment",
"display": "LINE",
"size": "LARGE",
"interval": "DAY",
"measures": [
{
"metric": "sentiment_score",
"aggregation": "AVG"
}
]
},
{
"name": "Calls",
"display": "NUMBER",
"measures": [
{
"type": "CONVERSATION"
}
]
}
]
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.roark.ai/v1/dashboard",
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([
'name' => 'Support agent health',
'timeRange' => [
'type' => 'LAST',
'value' => 30,
'unit' => 'DAYS'
],
'filters' => [
[
'type' => 'MODALITY',
'value' => 'call'
]
],
'widgets' => [
[
'name' => 'Sentiment',
'display' => 'LINE',
'size' => 'LARGE',
'interval' => 'DAY',
'measures' => [
[
'metric' => 'sentiment_score',
'aggregation' => 'AVG'
]
]
],
[
'name' => 'Calls',
'display' => 'NUMBER',
'measures' => [
[
'type' => 'CONVERSATION'
]
]
]
]
]),
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://api.roark.ai/v1/dashboard"
payload := strings.NewReader("{\n \"name\": \"Support agent health\",\n \"timeRange\": {\n \"type\": \"LAST\",\n \"value\": 30,\n \"unit\": \"DAYS\"\n },\n \"filters\": [\n {\n \"type\": \"MODALITY\",\n \"value\": \"call\"\n }\n ],\n \"widgets\": [\n {\n \"name\": \"Sentiment\",\n \"display\": \"LINE\",\n \"size\": \"LARGE\",\n \"interval\": \"DAY\",\n \"measures\": [\n {\n \"metric\": \"sentiment_score\",\n \"aggregation\": \"AVG\"\n }\n ]\n },\n {\n \"name\": \"Calls\",\n \"display\": \"NUMBER\",\n \"measures\": [\n {\n \"type\": \"CONVERSATION\"\n }\n ]\n }\n ]\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://api.roark.ai/v1/dashboard")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Support agent health\",\n \"timeRange\": {\n \"type\": \"LAST\",\n \"value\": 30,\n \"unit\": \"DAYS\"\n },\n \"filters\": [\n {\n \"type\": \"MODALITY\",\n \"value\": \"call\"\n }\n ],\n \"widgets\": [\n {\n \"name\": \"Sentiment\",\n \"display\": \"LINE\",\n \"size\": \"LARGE\",\n \"interval\": \"DAY\",\n \"measures\": [\n {\n \"metric\": \"sentiment_score\",\n \"aggregation\": \"AVG\"\n }\n ]\n },\n {\n \"name\": \"Calls\",\n \"display\": \"NUMBER\",\n \"measures\": [\n {\n \"type\": \"CONVERSATION\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roark.ai/v1/dashboard")
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 \"name\": \"Support agent health\",\n \"timeRange\": {\n \"type\": \"LAST\",\n \"value\": 30,\n \"unit\": \"DAYS\"\n },\n \"filters\": [\n {\n \"type\": \"MODALITY\",\n \"value\": \"call\"\n }\n ],\n \"widgets\": [\n {\n \"name\": \"Sentiment\",\n \"display\": \"LINE\",\n \"size\": \"LARGE\",\n \"interval\": \"DAY\",\n \"measures\": [\n {\n \"metric\": \"sentiment_score\",\n \"aggregation\": \"AVG\"\n }\n ]\n },\n {\n \"name\": \"Calls\",\n \"display\": \"NUMBER\",\n \"measures\": [\n {\n \"type\": \"CONVERSATION\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"isDefault": true,
"configManaged": true,
"timeRange": {
"type": "LAST",
"value": 500,
"unit": "DAYS"
},
"createdAt": "<string>",
"updatedAt": "<string>",
"filters": [
{
"type": "METRIC_PROPERTY",
"value": "<string>",
"property": "<string>",
"operator": "EQUALS"
}
],
"widgets": [
{
"measures": [
{
"type": "METRIC",
"metric": "<string>",
"aggregation": "COUNT",
"percentile": 50,
"distinctBy": "NONE",
"nestedAggregation": "COUNT",
"nestedAggregationPercentile": 50,
"passOperator": "EQUALS",
"passValue": "<string>",
"breakdown": {
"type": "METRIC_PROPERTY",
"property": "<string>"
},
"filters": [
{
"type": "METRIC_PROPERTY",
"value": "<string>",
"property": "<string>",
"operator": "EQUALS"
}
],
"isBaseline": true,
"color": "GREEN"
}
],
"name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filters": [
{
"type": "METRIC_PROPERTY",
"value": "<string>",
"property": "<string>",
"operator": "EQUALS"
}
],
"interval": "HOUR",
"comparisonMode": "NONE",
"comparisonGroups": [
{
"name": "<string>",
"filters": [
{
"type": "METRIC_PROPERTY",
"value": "<string>",
"property": "<string>",
"operator": "EQUALS"
}
],
"color": "GREEN"
}
],
"description": "<string>",
"display": "LINE",
"size": "SMALL"
}
]
}
}{
"type": "validation",
"code": "invalid_parameter",
"message": "The request was invalid",
"param": "email"
}{
"type": "authentication",
"code": "unauthorized",
"message": "Authentication required"
}{
"type": "forbidden",
"code": "permission_denied",
"message": "You do not have permission to access this resource"
}{
"type": "not_found",
"code": "resource_not_found",
"message": "The requested resource could not be found"
}{
"type": "conflict",
"code": "resource_in_use",
"message": "The resource is in use and cannot be deleted"
}{
"type": "rate_limit",
"code": "too_many_requests",
"message": "Rate limit exceeded"
}{
"type": "internal",
"code": "internal_error",
"message": "Internal server error"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
A dashboard: a name, the window and filters every widget reads, and its widgets top to bottom. Each widget is an analytics query (the shape POST /v1/analytics/query takes) plus a name, chart type and size.
1 - 2002000The window: LAST n DAYS/WEEKS/MONTHS up to now, a CALENDAR_ALIGNED period (TODAY, YESTERDAY, THIS_WEEK, LAST_WEEK, THIS_MONTH, LAST_MONTH, THIS_YEAR, LAST_YEAR), FIXED from/to, or SINCE a date. At most 731 days (two years).
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
20Show child attributes
Show child attributes
50Show child attributes
Show child attributes
Response
The created dashboard
Show child attributes
Show child attributes