CTIX
Network live
CTIXGET

Get Dashboard Details

Source docs
GEThttps://cs-testv2.cyware.com/ctixapi/ingestion/analytics/dashboard/{dashboard_id}/

Returns data about the specific dashboard ID.

Path Parameters

NameTypeRequiredDescription
dashboard_idstringoptional

Pass the ID of the dashboard. You can retrieve this ID using the List Dashboards API. For example: 7749e131-2161-4b19-b77d-e92aa7e945a9.

Query Parameters

NameTypeRequiredDescription
pagestringoptional

Pass the page number to retrieve records.

page_sizestringoptional

Pass the number of records to retrieve on each page.

Run it

Use the Request parameters panel to enter path IDs, query values, JSON body, and credentials. Then run any snippet below — all languages use the same values. Base URL: https://cs-testv2.cyware.com/ctixapi (change in API Settings).

Playground

Request parameters

Edit values here before running any snippet below (cURL, JavaScript, or Python). Code blocks are reference only — your inputs above are what gets sent.

CTIXConnect to Intel ExchangeConnect to run

Open API (HMAC signature) · Get credentials from Cyware Admin → Open API → Generate Credentials.

Signature and Expires are generated when you run a request. Access ID and Secret Key stay in memory for this tab only.

Credentials from Authentication auto-fill here for this product. If fields are empty after connecting, refresh this page or open the product docs again.

Path Parameters
Query Parameters
cURL
curl --request GET \
  --url "https://cs-testv2.cyware.com/ctixapi/ingestion/analytics/dashboard/{dashboard_id}/?AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E"

View-only example — running live API calls requires a role with snippet testing access.

JavaScript
const url = "https://cs-testv2.cyware.com/ctixapi/ingestion/analytics/dashboard/{dashboard_id}/?AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E";

const response = await fetch(url, {
  method: "GET",
});

const text = await response.text();
let data;
try { data = JSON.parse(text); } catch { data = text; }
console.log(response.status, data);

View-only example — running live API calls requires a role with snippet testing access.

Python
import requests

url = "https://cs-testv2.cyware.com/ctixapi/ingestion/analytics/dashboard/{dashboard_id}/"
params = {
    "AccessID": "<your access id>",
    "Signature": "<your signature>",
    "Expires": "<your expires>"
}
headers = {}
response = requests.request("GET", url, params=params, headers=headers)
print(response.status_code)
print(response.text)

View-only example — running live API calls requires a role with snippet testing access.

Example Response
{
  "created_by": {},
  "dashboard_id": "30038717-ce67-48b8-839f-dd84aeb7cc45",
  "description": "Use this dashboard to visualize Intel Exchange automation rules metrics such as performance, processing by IoCs or domain objects, rule actions, and sources.",
  "editable": false,
  "is_default": false,
  "layout": [
    {}
  ],
  "layout_type": 0,
  "name": "Rules Dashboard",
  "overview": [
    {}
  ],
  "rotation_timer": 30,
  "shared_type": "system",
  "shared_users": []
}

View-only example — running live API calls requires a role with snippet testing access.