Get Playbook Automation And Performance Data

Get all text and Urls in a PDF file based on file id and source.

Implementation	System
Command Category	System Utility
Tags	PLAYBOOK

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Start Time	Optional	The start of the date range for querying the playbook automation and performance data.	`02/06/2024 01:00 AM`
End Time	Optional	The end of the date range for querying the playbook automation and performance data.	`02/06/2024 02:00 AM`
Recent Minutes	Optional	Performance automation and statistics data for the playbook in the recent minutes.	`50`

Output

Return Data

The returned result of this command. If some required parameters are not defined, this returned data could be empty. The returned result can be passed down directly to a subsequent command in playbooks.

SAMPLE DATA

JSON

{
    "Status": "Successful",
    "Results": [
        {
            "Playbook ID": -1,
            "Playbook Name": "(all)",
            "Command ID": -1,
            "Integration": "(all)",
            "Total Data Size (MB)": "1.310",
            "Total Task Time (Hour)": "1.677",
            "Maximum Task Time (Minutes)": 42.597,
            "Maximum Task Data Size (MB)": "0.033",
            "Average Task Time (Minutes)": 0.258,
            "Average Task Data Size (KB)": 3,
            "Playbook Instance Count": 65,
            "Total Task Count": 390,
            "Average Task Count": "6.000",
            "Task Count Per Minute": "0.004"
        },
        {
            "Playbook ID": 1195,
            "Playbook Name": "Lucky",
            "Command ID": null,
            "Integration": null,
            "Total Data Size (MB)": "0.781",
            "Total Task Time (Hour)": "0.290",
            "Maximum Task Time (Minutes)": 15.391,
            "Maximum Task Data Size (MB)": "0.033",
            "Average Task Time (Minutes)": 0.064,
            "Average Task Data Size (KB)": 2,
            "Playbook Instance Count": 12,
            "Total Task Count": 274,
            "Average Task Count": "22.833",
            "Task Count Per Minute": "0.003"
        },
        {
            "Playbook ID": 1213,
            "Playbook Name": "bug_68059",
            "Command ID": null,
            "Integration": null,
            "Total Data Size (MB)": "0.024",
            "Total Task Time (Hour)": "1.042",
            "Maximum Task Time (Minutes)": 42.597,
            "Maximum Task Data Size (MB)": "0.006",
            "Average Task Time (Minutes)": 6.947,
            "Average Task Data Size (KB)": 2,
            "Playbook Instance Count": 9,
            "Total Task Count": 9,
            "Average Task Count": "1.000",
            "Task Count Per Minute": "0.000"
        },
        {
            "Playbook ID": 1123,
            "Playbook Name": "bug_48647",
            "Command ID": null,
            "Integration": null,
            "Total Data Size (MB)": "0.160",
            "Total Task Time (Hour)": "0.213",
            "Maximum Task Time (Minutes)": 3.263,
            "Maximum Task Data Size (MB)": "0.010",
            "Average Task Time (Minutes)": 0.387,
            "Average Task Data Size (KB)": 4,
            "Playbook Instance Count": 15,
            "Total Task Count": 33,
            "Average Task Count": "2.200",
            "Task Count Per Minute": "0.000"
        }
      ]
}

Remote Command API

The D3 command API allows you to send requests to D3 SOAR to execute this utility command via REST API.

Request

POST

CODE

https:/{base_url}/{api_namespace}/api/Command/GetPlaybookAutomationPerformanceData

Headers

Please refer to the page Webhook Configuration Guide - Authentication Method: API Keys for more details.

Request Body

JSON

{
  "Username": <Username here>,
  "Site": <Site here>,
  "CommandParams": {
    "Start Time": <Start Time here>,
    "End Time": <End Time here>,
    "Recent Minutes": <Recent Minutes here>
  }
}

Body Parameters

Parameter Name	Type	Required/Optional	Description
Username	`Text`	Required	The username of your D3 SOAR account.
Site	`Text`	Required	The D3 SOAR site to run the remote command.
Start Time	`Text`	Optional	The start of the date range for querying the playbook automation and performance data.
End Time	`Text`	Optional	The end of the date range for querying the playbook automation and performance data.
Recent Minutes	`Number`	Optional	Performance automation and statistics data for the playbook in the recent minutes.

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Start Time": "02/06/2024 01:00 AM",
    "End Time": "02/06/2024 02:00 AM",
    "Recent Minutes": 50
  }
}

Response

Response Fields

Field Name	Type	Description
error	`text`	The error message if the API request has failed.
returnData	`text`	The return data from the API request.

Sample Response

JSON

{
    "error": "",
    "returnData": {
        "Status": "Successful",
        "Results": [
            {
                "Playbook ID": -1,
                "Playbook Name": "(all)",
                "Command ID": -1,
                "Integration": "(all)",
                "Total Data Size (MB)": "1.310",
                "Total Task Time (Hour)": "1.677",
                "Maximum Task Time (Minutes)": 42.597,
                "Maximum Task Data Size (MB)": "0.033",
                "Average Task Time (Minutes)": 0.258,
                "Average Task Data Size (KB)": 3,
                "Playbook Instance Count": 65,
                "Total Task Count": 390,
                "Average Task Count": "6.000",
                "Task Count Per Minute": "0.004"
            },
            {
                "Playbook ID": 1195,
                "Playbook Name": "Lucky",
                "Command ID": null,
                "Integration": null,
                "Total Data Size (MB)": "0.781",
                "Total Task Time (Hour)": "0.290",
                "Maximum Task Time (Minutes)": 15.391,
                "Maximum Task Data Size (MB)": "0.033",
                "Average Task Time (Minutes)": 0.064,
                "Average Task Data Size (KB)": 2,
                "Playbook Instance Count": 12,
                "Total Task Count": 274,
                "Average Task Count": "22.833",
                "Task Count Per Minute": "0.003"
            },
            {
                "Playbook ID": 1213,
                "Playbook Name": "bug_68059",
                "Command ID": null,
                "Integration": null,
                "Total Data Size (MB)": "0.024",
                "Total Task Time (Hour)": "1.042",
                "Maximum Task Time (Minutes)": 42.597,
                "Maximum Task Data Size (MB)": "0.006",
                "Average Task Time (Minutes)": 6.947,
                "Average Task Data Size (KB)": 2,
                "Playbook Instance Count": 9,
                "Total Task Count": 9,
                "Average Task Count": "1.000",
                "Task Count Per Minute": "0.000"
            },
            {
                "Playbook ID": 1123,
                "Playbook Name": "bug_48647",
                "Command ID": null,
                "Integration": null,
                "Total Data Size (MB)": "0.160",
                "Total Task Time (Hour)": "0.213",
                "Maximum Task Time (Minutes)": 3.263,
                "Maximum Task Data Size (MB)": "0.010",
                "Average Task Time (Minutes)": 0.387,
                "Average Task Data Size (KB)": 4,
                "Playbook Instance Count": 15,
                "Total Task Count": 33,
                "Average Task Count": "2.200",
                "Task Count Per Minute": "0.000"
            }
          ]
    }
}