Get the dashboard layout preference for the authenticated user
curl --request GET \
--url https://api.octaviatech.app/cms/reports/dashboardConfig \
--header 'x-api-key: <api-key>'import requests
url = "https://api.octaviatech.app/cms/reports/dashboardConfig"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.octaviatech.app/cms/reports/dashboardConfig', 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://api.octaviatech.app/cms/reports/dashboardConfig",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-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"
"net/http"
"io"
)
func main() {
url := "https://api.octaviatech.app/cms/reports/dashboardConfig"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
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.octaviatech.app/cms/reports/dashboardConfig")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.octaviatech.app/cms/reports/dashboardConfig")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 200,
"message": "Dashboard config retrieved successfully",
"data": {
"dashboardConfig": {
"version": 1,
"templateId": "executive_focus",
"slots": [
{
"id": "hero",
"type": "operationsOverview",
"enabled": true,
"span": "full",
"settings": {
"range": "2weeks"
}
},
{
"id": "slot_1",
"type": "reportIntelligence",
"enabled": true,
"span": "full",
"settings": {
"range": "2weeks"
}
},
{
"id": "slot_2",
"type": "contentTrend",
"enabled": true,
"span": "full",
"settings": {
"range": "2weeks"
}
},
{
"id": "slot_3",
"type": "tenantCapacity",
"enabled": true,
"span": "half",
"settings": {
"range": "2weeks"
}
},
{
"id": "slot_4",
"type": "summaryOverview",
"enabled": true,
"span": "half",
"settings": {
"range": "2weeks"
}
},
{
"id": "slot_5",
"type": "topArticles",
"enabled": true,
"span": "full",
"settings": {
"range": "2weeks"
}
}
]
}
}
}{
"success": false,
"statusCode": 400,
"message": "Missing userId",
"data": null
}{
"success": false,
"statusCode": 500,
"message": "Failed to retrieve dashboard config",
"data": null
}Reports
Get the dashboard layout preference for the authenticated user
Returns the stored dashboard configuration for the tenant and user resolved from the request context. If the user has never saved a configuration, the built-in default is returned instead of a 404.
GET
/
reports
/
dashboardConfig
Get the dashboard layout preference for the authenticated user
curl --request GET \
--url https://api.octaviatech.app/cms/reports/dashboardConfig \
--header 'x-api-key: <api-key>'import requests
url = "https://api.octaviatech.app/cms/reports/dashboardConfig"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.octaviatech.app/cms/reports/dashboardConfig', 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://api.octaviatech.app/cms/reports/dashboardConfig",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-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"
"net/http"
"io"
)
func main() {
url := "https://api.octaviatech.app/cms/reports/dashboardConfig"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
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.octaviatech.app/cms/reports/dashboardConfig")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.octaviatech.app/cms/reports/dashboardConfig")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 200,
"message": "Dashboard config retrieved successfully",
"data": {
"dashboardConfig": {
"version": 1,
"templateId": "executive_focus",
"slots": [
{
"id": "hero",
"type": "operationsOverview",
"enabled": true,
"span": "full",
"settings": {
"range": "2weeks"
}
},
{
"id": "slot_1",
"type": "reportIntelligence",
"enabled": true,
"span": "full",
"settings": {
"range": "2weeks"
}
},
{
"id": "slot_2",
"type": "contentTrend",
"enabled": true,
"span": "full",
"settings": {
"range": "2weeks"
}
},
{
"id": "slot_3",
"type": "tenantCapacity",
"enabled": true,
"span": "half",
"settings": {
"range": "2weeks"
}
},
{
"id": "slot_4",
"type": "summaryOverview",
"enabled": true,
"span": "half",
"settings": {
"range": "2weeks"
}
},
{
"id": "slot_5",
"type": "topArticles",
"enabled": true,
"span": "full",
"settings": {
"range": "2weeks"
}
}
]
}
}
}{
"success": false,
"statusCode": 400,
"message": "Missing userId",
"data": null
}{
"success": false,
"statusCode": 500,
"message": "Failed to retrieve dashboard config",
"data": null
}Authorizations
Response
OK
Was this page helpful?

