Reports
APIs for managing reports
Get all of the reports.
Responses
200
OK
application/json
cacheVersnintegerOptional
commitMessagestringOptional
cronViewbooleanOptional
definitionIdstringOptional
disableHeaderbooleanOptional
endingDatestringOptional
fromServerVersionstringOptional
idstringOptional
itemVersionstringOptional
latestReportNamestringOptional
latestReportTimestringOptional
latestReportUsernamestringOptional
latestScheduledReportTimestringOptional
lockedbooleanOptional
modifiedstringOptional
namestringOptional
nextScheduledTimestringOptional
orientationstringOptional
packIDstringOptional
packNamestringOptional
paperSizestringOptional
prevNamestringOptional
prevTypestringOptional
primaryTermintegerOptional
propagationLabelsstring[]Optional
recipientsnullOptional
recurrentbooleanOptional
reportTypestringOptional
runOncebooleanOptional
runningRolesnullOptional
runningUserstringOptional
scheduledbooleanOptional
scheduledEntryGuidstringOptional
sensitivebooleanOptional
sequenceNumberintegerOptional
shouldCommitbooleanOptional
sizeInBytesintegerOptional
sortValuesstring[]Optional
startDatestringOptional
systembooleanOptional
timesintegerOptional
timezoneOffsetintegerOptional
toServerVersionstringOptional
typestringOptional
vcShouldIgnorebooleanOptional
vcShouldKeepItemLegacyProdMachinebooleanOptional
versionintegerOptional
get/xsoar/public/v1/reports
GET /xsoar/public/v1/reports HTTP/1.1
Host: api-yourfqdn
Accept: */*
200
OK
[
{
"cacheVersn": 0,
"commitMessage": "",
"cronView": false,
"dashboard": {
"cacheVersn": 0,
"commitMessage": "",
"definitionId": "",
"fromDate": "0001-01-01T00:00:00Z",
"fromDateLicense": "0001-01-01T00:00:00Z",
"fromServerVersion": "",
"hidePivot": false,
"hideSearch": false,
"id": "",
"isCommon": false,
"itemVersion": "",
"layout": [
{
"forceRange": false,
"h": 3,
"i": "07fa5490-1023-11ee-96c3-b3c2a624deaa",
"id": "07fa5490-1023-11ee-96c3-b3c2a624deaa",
"reflectDimensions": true,
"w": 12,
"widget": {
"Cache": null,
"cacheVersn": 0,
"category": "",
"commitMessage": "",
"dataType": "incidents",
"dateRange": {
"fromDate": "0001-01-01T00:00:00Z",
"fromDateLicense": "0001-01-01T00:00:00Z",
"period": {
"by": "",
"byFrom": "days",
"byTo": "",
"field": "",
"fromValue": 7,
"toValue": null
},
"toDate": "0001-01-01T00:00:00Z"
},
"definitionId": "",
"fromServerVersion": "5.0.0",
"id": "",
"isPredefined": false,
"itemVersion": "1.2.20",
"modified": "2023-05-18T17:20:56.961761445Z",
"name": "Closed Incidents by Severity",
"packID": "CommonWidgets",
"packName": "Common Widgets",
"packPropagationLabels": [
"all"
],
"params": {
"groupBy": [
"severity"
]
},
"prevName": "Closed Incidents by Role",
"primaryTerm": 8,
"propagationLabels": [],
"query": "status:closed",
"sequenceNumber": 12934438,
"shouldCommit": false,
"size": 10,
"sizeInBytes": 0,
"sortValues": [
"29713"
],
"toServerVersion": "",
"vcShouldIgnore": false,
"vcShouldKeepItemLegacyProdMachine": false,
"version": 0,
"widgetType": "bar"
},
"x": 0,
"y": 0
}
],
"locked": false,
"modified": "0001-01-01T00:00:00Z",
"modulePage": false,
"name": "test_report_closed_incidents_by_severity",
"owner": "",
"packID": "",
"packName": "",
"period": {
"by": "",
"byFrom": "days",
"byTo": "",
"field": "",
"fromValue": 7,
"toValue": null
},
"prevName": "",
"shouldCommit": false,
"sizeInBytes": 0,
"system": false,
"toDate": "0001-01-01T00:00:00Z",
"toServerVersion": "",
"vcShouldIgnore": false,
"vcShouldKeepItemLegacyProdMachine": false,
"version": 0
},
"decoder": {
"evidences.fetched": {
"type": "date",
"value": "02/01/06 3:04:05 PM"
},
"evidences.markedDate": {
"type": "date",
"value": "02/01/06 3:04:05 PM"
},
"evidences.occurred": {
"type": "date",
"value": "02/01/06 3:04:05 PM"
},
"incident.dbotStatus.0": {
"type": "string",
"value": "Pending"
},
"incident.dbotStatus.1": {
"type": "string",
"value": "Active"
},
"incident.dbotStatus.2": {
"type": "string",
"value": "Closed"
},
"incident.dbotStatus.3": {
"type": "string",
"value": "Closed"
},
"incident.dbotStatus.4": {
"type": "string",
"value": "On Hold"
},
"incident.dueDate": {
"type": "date",
"value": "2006-01-02T15:04:05Z07:00"
},
"incident.openDuration": {
"type": "duration",
"value": ""
},
"incident.phase.": {
"type": "string",
"value": "Unassigned"
},
"incident.roles.": {
"type": "string",
"value": "Unassigned"
},
"incident.severity.0": {
"type": "string",
"value": "Unknown"
},
"incident.severity.0.5": {
"type": "string",
"value": "Informational"
},
"incident.severity.1": {
"type": "string",
"value": "Low"
},
"incident.severity.2": {
"type": "string",
"value": "Medium"
},
"incident.severity.3": {
"type": "string",
"value": "High"
},
"incident.severity.4": {
"type": "string",
"value": "Critical"
},
"incident.status.0": {
"type": "string",
"value": "Pending"
},
"incident.status.1": {
"type": "string",
"value": "Active"
},
"incident.status.2": {
"type": "string",
"value": "Closed"
},
"incident.status.3": {
"type": "string",
"value": "Closed"
},
"incident.status.4": {
"type": "string",
"value": "On Hold"
},
"indicators.score.0": {
"type": "string",
"value": "Unknown"
},
"indicators.score.1": {
"type": "string",
"value": "Benign"
},
"indicators.score.2": {
"type": "string",
"value": "Suspicious"
},
"indicators.score.3": {
"type": "string",
"value": "Malicious"
},
"investigation.openDuration": {
"type": "duration",
"value": ""
},
"investigation.status.0": {
"type": "string",
"value": "Active"
},
"investigation.status.1": {
"type": "string",
"value": "Done"
},
"investigation.type.0": {
"type": "string",
"value": "Standard"
},
"investigation.type.1": {
"type": "string",
"value": "Restricted"
},
"investigation.type.9": {
"type": "string",
"value": "Playground"
},
"relationships.revoked.": {
"type": "string",
"value": "Active"
},
"relationships.revoked.false": {
"type": "string",
"value": "Active"
},
"relationships.revoked.true": {
"type": "string",
"value": "Revoked"
}
},
"definitionId": "",
"disableHeader": false,
"endingDate": "0001-01-01T00:00:00Z",
"fromServerVersion": "",
"id": "1a416199-403d-4ed5-8b0a-e9dd0513792e",
"itemVersion": "",
"latestReportName": "",
"latestReportTime": "0001-01-01T00:00:00Z",
"latestReportUsername": "",
"latestScheduledReportTime": "0001-01-01T00:00:00Z",
"locked": false,
"modified": "2023-06-21T11:03:07.189907723Z",
"name": "test_report_closed_incidents_by_severity",
"nextScheduledTime": "0001-01-01T00:00:00Z",
"orientation": "portrait",
"packID": "",
"packName": "",
"paperSize": "A4",
"prevName": "test_report_closed_incidents_by_severity",
"prevType": "pdf",
"primaryTerm": 8,
"propagationLabels": [
"all"
],
"recipients": null,
"recurrent": false,
"reportType": "",
"runOnce": false,
"runningRoles": null,
"runningUser": "",
"scheduled": false,
"scheduledEntryGuid": "",
"sections": [
{
"autoPageBreak": false,
"automation": {
"args": null,
"id": "",
"name": "",
"noEvent": false
},
"data": null,
"layout": {
"chartProperties": {
"axis": {
"x": {},
"y": {}
},
"barSize": 4,
"format": "DD MMM Y",
"isDatesChart": false,
"layout": "vertical",
"timeFrame": "days",
"valuesFormat": "abbreviated"
},
"chartType": "bar",
"columnPos": 0,
"dimensions": {
"height": 300,
"width": 738
},
"forceRangeMessage": "",
"h": 3,
"i": "07fa5490-1023-11ee-96c3-b3c2a624deaa",
"legendStyle": {
"align": "right",
"hideLegend": false,
"iconType": "circle",
"layout": "horizontal",
"verticalAlign": "top",
"wrapperStyle": {
"maxHeight": 96,
"top": 5,
"width": "100%"
}
},
"reflectDimensions": true,
"rowPos": 0,
"w": 12
},
"query": {
"filter": {
"period": {
"byFrom": "days",
"fromValue": 7
},
"query": "status:closed"
},
"groupBy": [
"severity"
],
"type": "incident"
},
"title": "Closed Incidents by Severity",
"titleStyle": null,
"type": "chart"
}
],
"sensitive": false,
"sequenceNumber": 16420940,
"shouldCommit": false,
"sizeInBytes": 0,
"sortValues": [
"31623"
],
"startDate": "0001-01-01T00:00:00Z",
"system": false,
"times": 0,
"timezoneOffset": 0,
"toServerVersion": "",
"type": "pdf",
"vcShouldIgnore": false,
"vcShouldKeepItemLegacyProdMachine": false,
"version": 1
}
]Get the latest report by its ID.
Note: To get the report, it must be a scheduled report with recipients.
Path parameters
idstringRequired
Report ID
Header parameters
authorizationstringRequiredExample:
api_key
DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmrx-xdr-auth-idstringRequiredExample:
api_key_id
2841Responses
200
OK - Returns a report file.
No content
get/xsoar/public/v1/report/{id}/latest
GET /xsoar/public/v1/report/{id}/latest HTTP/1.1
Host: api-yourfqdn
authorization: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-id: 2841
Accept: */*
200
OK - Returns a report file.
No content
Last updated
Was this helpful?