JavaScript
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 response = await client.dashboard.getData('dashboardId');
console.log(response.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
)
response = client.dashboard.get_data(
dashboard_id="dashboardId",
)
print(response.data)curl --request GET \
--url https://api.roark.ai/v1/dashboard/{dashboardId}/data \
--header 'Authorization: Bearer <token>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.roark.ai/v1/dashboard/{dashboardId}/data",
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://api.roark.ai/v1/dashboard/{dashboardId}/data"
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://api.roark.ai/v1/dashboard/{dashboardId}/data")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roark.ai/v1/dashboard/{dashboardId}/data")
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{
"data": {
"dashboardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"from": "<string>",
"to": "<string>",
"timezone": "<string>",
"widgets": [
{
"widgetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"interval": "HOUR",
"blocked": true,
"error": "<string>",
"series": [
{
"measureIndex": 123,
"type": "METRIC",
"metric": "<string>",
"aggregation": "COUNT",
"breakdownValue": "<string>",
"comparisonGroup": "<string>",
"value": 123,
"sampleSize": 123,
"comparisonValue": 123,
"percentageOfBaseline": 123,
"buckets": [
{
"date": "<string>",
"value": 123,
"passed": 123,
"sampleSize": 123,
"comparisonDate": "<string>",
"comparisonValue": 123,
"percentageOfBaseline": 123
}
]
}
],
"omittedSeries": 123
}
]
}
}{
"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": "rate_limit",
"code": "too_many_requests",
"message": "Rate limit exceeded"
}{
"type": "internal",
"code": "internal_error",
"message": "Internal server error"
}Dashboard
Get dashboard data
Runs every widget on the dashboard and returns each one’s series, exactly as the dashboard shows them:
over the dashboard’s saved window and with its filters applied. Pass from (and optionally to) to
read a different window, and timezone to align buckets to a zone.
GET
/
v1
/
dashboard
/
{dashboardId}
/
data
JavaScript
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 response = await client.dashboard.getData('dashboardId');
console.log(response.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
)
response = client.dashboard.get_data(
dashboard_id="dashboardId",
)
print(response.data)curl --request GET \
--url https://api.roark.ai/v1/dashboard/{dashboardId}/data \
--header 'Authorization: Bearer <token>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.roark.ai/v1/dashboard/{dashboardId}/data",
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://api.roark.ai/v1/dashboard/{dashboardId}/data"
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://api.roark.ai/v1/dashboard/{dashboardId}/data")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roark.ai/v1/dashboard/{dashboardId}/data")
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{
"data": {
"dashboardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"from": "<string>",
"to": "<string>",
"timezone": "<string>",
"widgets": [
{
"widgetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"interval": "HOUR",
"blocked": true,
"error": "<string>",
"series": [
{
"measureIndex": 123,
"type": "METRIC",
"metric": "<string>",
"aggregation": "COUNT",
"breakdownValue": "<string>",
"comparisonGroup": "<string>",
"value": 123,
"sampleSize": 123,
"comparisonValue": 123,
"percentageOfBaseline": 123,
"buckets": [
{
"date": "<string>",
"value": 123,
"passed": 123,
"sampleSize": 123,
"comparisonDate": "<string>",
"comparisonValue": 123,
"percentageOfBaseline": 123
}
]
}
],
"omittedSeries": 123
}
]
}
}{
"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": "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.
Path Parameters
Query Parameters
ISO 8601 start. Overrides the saved window; without to, runs until now.
ISO 8601 end. Requires from.
IANA zone buckets and calendar periods align to. Default UTC.
Minimum string length:
1Response
The dashboard's data
Every widget's series over the window, top to bottom. A widget that fails on its own (say its metric was deleted) carries error and no series; the others still return.
Show child attributes
Show child attributes