Exports a dashboard in the Intel Exchange application. On successful exporting, you will receive an email with the subject line Cyware Dashboard Report Mail.
Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| dashboards | array | optional | Pass the list of dashboards to export. |
| start_date | string | optional | Pass the start date of the date range to show data in the dashboard. |
| end_date | string | optional | Pass the end date of the date range to show the data in the dashboard. |
| template_config | object | optional | Pass the configuration of the export format of the dashboard. |
| external_recipients | object | optional | Pass the list of emails of the external users to mail the dashboard to in cc and bcc format. |
| internal_recipients | object | optional | Pass the list of the emails of the internal users to mail the dashboard to in cc and bcc format. |
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.
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.
curl --request POST \
--url "https://cs-testv2.cyware.com/ctixapi/ingestion/analytics/dashboard_export/?AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E" \
--data '{
"dashboards": [
"c28f0aec-3640-45df-a3ab-37ed35745d8a"
],
"start_date": "1634601600",
"end_date": "1637279999",
"template_config": {},
"external_recipients": {},
"internal_recipients": {}
}'View-only example — running live API calls requires a role with snippet testing access.
const url = "https://cs-testv2.cyware.com/ctixapi/ingestion/analytics/dashboard_export/?AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E";
const response = await fetch(url, {
method: "POST",
headers: {},
body: JSON.stringify({
"dashboards": [
"c28f0aec-3640-45df-a3ab-37ed35745d8a"
],
"start_date": "1634601600",
"end_date": "1637279999",
"template_config": {},
"external_recipients": {},
"internal_recipients": {}
}),
});
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.
import requests
url = "https://cs-testv2.cyware.com/ctixapi/ingestion/analytics/dashboard_export/"
params = {
"AccessID": "<your access id>",
"Signature": "<your signature>",
"Expires": "<your expires>"
}
headers = {}
payload = {
"dashboards": [
"c28f0aec-3640-45df-a3ab-37ed35745d8a"
],
"start_date": "1634601600",
"end_date": "1637279999",
"template_config": {},
"external_recipients": {},
"internal_recipients": {}
}
response = requests.request("POST", url, params=params, headers=headers, json=payload)
print(response.status_code)
print(response.text)View-only example — running live API calls requires a role with snippet testing access.
{
"dashboards": [
"c28f0aec-3640-45df-a3ab-37ed35745d8a"
],
"start_date": "1634601600",
"end_date": "1637279999",
"template_config": {},
"external_recipients": {},
"internal_recipients": {}
}View-only example — running live API calls requires a role with snippet testing access.
{
"result": "Your Dashboard will be mailed to you as soon as it is ready."
}View-only example — running live API calls requires a role with snippet testing access.