Harness

dashboards

Download data within a Dashboard

Download the data of all tiles within a Dashboard.

Securityx-api-key
Request
path Parameters
dashboard_id
required
string
query Parameters
file_type
required
string
Value: "csv"
filters
string
Responses
200

Returns files of a specified type within a ZIP file for each tile within a Dashboard.

400

Please specify a valid File Type.

404

Dashboard not found.

default

Unexpected error.

get/dashboard/api/dashboards/{dashboard_id}/download
Request samples 
Response samples 
application/json
{
  • "file": "string"
}
clone_dashboard
Clone a dashboard.


Securityx-api-key 
Request 
query Parameters
accountId
string
 
Request Body schema: application/json
required
Clone a Dashboard


dashboardId
required
string
 
folderId
string
 
name
string
 
description
string
 
Responses 
200
Returns the newly created dashboard's details.


default
Unexpected error.


post/dashboard/clone
Request samples 
application/json
{
  • "dashboardId": "string",
  • "folderId": "string",
  • "name": "string",
  • "description": "string"
}
Response samples 
application/json
{
  • "resource": {
    }
}
get_dashboard_elements
Get all elements within a dashboard by ID.


Securityx-api-key 
Request 
path Parameters
dashboard_id
required
string
 
query Parameters
accountId
string
 
Responses 
200
Returns all of the elements within a dashboard.


404
Dashboard or dashboard elements not found.


default
Unexpected error.


get/dashboard/dashboards/{dashboard_id}/elements
Request samples 
Response samples 
application/json
{
  • "resource": [
    ]
}
Download a Dashboard CSV
Download a Dashboard in CSV format.


Securityx-api-key 
Request 
path Parameters
dashboard_id
required
string
 
query Parameters
accountId
string
 
filters
string
 
expanded_tables
boolean
 
Responses 
200
Returns a zip of CSV files containing raw data of each tile within a Dashboard.


400
Download Task has failed.


403
Forbidden.


404
Dashboard not found.


504
Querying Dashboard to build CSV has timed out.


default
Unexpected error.


get/dashboard/download/dashboards/{dashboard_id}/csv
Request samples 
Response samples 
application/json
{
  • "file": "string"
}
Download a Dashboard PDF
Download a Dashboard in PDF format.


Securityx-api-key 
Request 
path Parameters
dashboard_id
required
string
 
query Parameters
accountId
string
 
filters
string
 
expanded_tables
boolean
 
landscape
boolean
 
paper_size
string
 Enum: "letter" "legal" "tabloid" "a0" "a1" "a2" "a3" "a4" "a5"  
style
string
 Enum: "single_column" "tiled"  
Responses 
200
Returns a PDF file containing the visualization of a Dashboard.


400
Render Task has failed.


403
Forbidden.


404
Dashboard not found.


504
Render Task has timed out.


default
Unexpected error.


get/dashboard/download/dashboards/{dashboard_id}/pdf
Request samples 
Response samples 
application/json
{
  • "file": "string"
}
Runs a schedule delivery once that is then immediately sent via email to recipients
Run a schedule delivery once


Securityx-api-key 
Request 
query Parameters
accountId
string
 
Request Body schema: application/json
required
Run a Dashboard Schedule Delivery once


dashboard_id
required
string
 
destination_emails
required
string
 
file_type
required
string
 Enum: "csv_zip" "assembled_pdf" "wysiwyg_pdf" "wysiwyg_png"  
name
required
string
 
message
string
 
filters
string
 
Responses 
200
A successful request does not necessarily mean successful delivery of emails


400
Please specify a valid File Type.


404
Dashboard not found.


default
Unexpected error.


post/dashboard/schedules/run_once
Request samples 
application/json
{
  • "dashboard_id": "string",
  • "destination_emails": "string",
  • "file_type": "csv_zip",
  • "name": "string",
  • "message": "string",
  • "filters": "string"
}
Response samples 
application/json
{
  • "resource": {
    }
}
➔ Next to dashboard