Skip to main content
Skip table of contents

Get D3 Application Metrics

LAST UPDATED: AUG 13, 2024

Retrieves the following D3 application metrics: Ingested Events, Created IRs, Runtime Tasks, Completed Tasks, Remote Container Metrics, and Agent Proxy Connections.

Implementation

System

Command Category

Basic Utility

Tags

METRICS

Inputs

N/A

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
Successful
Raw Data

The response data from the utility command.

SAMPLE DATA

CODE
123

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/GetD3ApplicationMetrics

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": {
  }
}

Body Parameters

Parameter Name

Type

Required/Optional

Description

Username

string

Required

The username of your D3 SOAR account.

Site

string

Required

The D3 SOAR site to run the remote command.

Sample Request

SAMPLE DATA

JSON
{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {}
}

Response

Response Fields

Field Name

Type

Description

error

string

The error message if the API request has failed.

returnData

JSON Object

The return data from the API request.

Sample Response

JSON
{
    "result": "<table class='cc-table'><thead><tr><th>Category</th><th>Total Count</th><th>Avg Count/Day</th><th>Avg Count/Hour</th><th>Avg Count/Minute</th><th>Prev Day Count</th><th>Prev Hour Count</th><th>Prev Minute Count</th></tr></thead><tbody><tr><td>Ingested Events</td><td>60064</td><td>2002</td><td>199</td><td>9</td><td>0</td><td>0</td><td>0</td></tr><tr><td>Created IRs</td><td>1940</td><td>18</td><td>5</td><td>1</td><td>0</td><td>0</td><td>0</td></tr><tr><td>RunTime Tasks</td><td>84871</td><td>738</td><td>170</td><td>10</td><td>0</td><td>0</td><td>0</td></tr><tr><td>Completed Tasks</td><td>72452</td><td>658</td><td>151</td><td>8</td><td>0</td><td>0</td><td>0</td></tr></tbody></table><table class='cc-table' style='margin-top: 10px;'><thead><tr><th>Remote Container Metrics</th><th>Count</th></tr></thead><tbody><tr><td>Online</td><td>0</td></tr><tr><td>Offline</td><td>1</td></tr></tbody></table><table class='cc-table' style='margin-top: 10px;'><thead><tr><th>Remote Container Executor URL</th><th>Current Task Count</th><th>Status</th></tr></thead><tbody><tr><td>https://exampleUrl.com</td><td>10</td><td>offline</td></tr></tbody></table><table class='cc-table' style='margin-top: 10px;'><thead><tr><th>Agent Status</th><th>Count</th></tr></thead><tbody><tr><td>Connected</td><td>0</td></tr></tbody></table>",
    "error": "",
    "returnData": {
        "IngestedEvents": {
            "Total": 60064,
            "AverageDaily": 2002,
            "AverageHour": 199,
            "AverageMinute": 9,
            "LastDay": 0,
            "LastHour": 0,
            "LastMinute": 0
        },
        "CreatedIRs": {
            "Total": 1940,
            "AverageDaily": 18,
            "AverageHour": 5,
            "AverageMinute": 1,
            "LastDay": 0,
            "LastHour": 0,
            "LastMinute": 0
        },
        "RunTimeTasks": {
            "Total": 84871,
            "AverageDaily": 738,
            "AverageHour": 170,
            "AverageMinute": 10,
            "LastDay": 0,
            "LastHour": 0,
            "LastMinute": 0
        },
        "CompletedTasks": {
            "Total": 72452,
            "AverageDaily": 658,
            "AverageHour": 151,
            "AverageMinute": 8,
            "LastDay": 0,
            "LastHour": 0,
            "LastMinute": 0
        },
        "RemoteContainerMetrics": {
            "ExecutingTasks": [
                {
                    "ExecutorURL": "https://exampleUrl.com",
                    "CurrentTaskCount": 10,
                    "Status": "offline"
                }
            ],
            "Online": 0,
            "Offline": 1
        },
        "AgentConnected": 0
    }
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.