Get Data Ingestion Schedule Running Results‎

POST /Command/GetDataIngestionScheduleRunningResults

Returns data ingestion schedule running results

Request

Authentication: API keys or JSON web tokens (JWT)

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.
Integration Name	`string`	Required	Specify the integration name
Data Type	`string`	Optional	Specify the type of record to fetch. (Options: “Event Intake“ or “Incident Intake“)
Connection Name	`string`	Optional	Specify the connection name
Site Name	`string`	Optional	Specify the name of the site
Start Time	`string`	Optional	The start of the date range (UTC). Note: The start time of the fetched records will be converted from PST time zone to UTC time zone.
End Time	`string`	Optional	The end of the date range (UTC). Note: The end time of the fetched records will be converted from PST time zone to UTC time zone.
Record Limit	`integer`	Optional	Specify the maximum number of records per schedule to be fetched. Using a positive value will order the records by newest first and using a negative value will order by oldest first. Note: A default of 100 maximum records will be returned if no value is specified.
Error Only	`boolean`	Optional	Only fetch the records with error results
Include Raw Data	`boolean`	Optional	Specify whether to include raw data in the output

READER NOTE

For Date/Time parameters Start Time, End Time:

All times and timestamps are in this format: yyyy-MM-dd HH:mm:ss.

For example, May 15, 2024, 2:32 PM should be 2024-05-15 14:32:00.

Body Sample Data

application/json

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Integration Name": "Gmail",
    "Data Type": "Event Intake",
    "Connection Name": "connection1",
    "Site Name": "Security Operations",
    "Start Time": "2022-08-01 00:00:00",
    "End Time": "2022-08-31 00:00:00",
    "Record Limit": 3,
    "Error Only": "No",
    "Include Raw Data": "Yes"
  }
}

Response

200 OK

application/json

Response Fields

Field Name	Type	Description
error	`string`	The error message if the API request has failed.
rawData	`array<JSON Object>`	The raw data from the API request.

Sample Data

JSON

{
    "error": "",
    "returnData": "Successful",
    "rawData": {
        "Data Type": "Event Intake",
        "Integration Name": "Gmail",
        "Connection Name": "connection1",
        "Site Name": "Security Operations",
        "Records": [
            {
                "UTCStarttime": "2022-08-04 22:46:36.873000",
                "UTCEndtime": "2022-08-04 22:46:37.113000",
                "ExecutionDurationInSec": "0.240",
                "IntervalDurationInMinute": "",
                "State": "Successful",
                "Input Data": [
                    {
                        "Command Name": "Fetch Event",
                        "Parameter 1: User Email": "phishixx@d3cyberlab.com",
                        "Parameter 2: Start Time": "2022-08-04 00:00:00",
                        "Parameter 3: End Time": "2022-08-04 01:00:00",
                        "Parameter 4: Top Recent Event Number": "5",
                        "Parameter 5: Search Condition": ""
                    }
                ],
                "Output Data": {
                    "EventCount": 0,
                    "NotifyChanges": false,
                    "CompositeId": null,
                    "ConnectionId": 1038,
                    "SiteId": 2,
                    "Error": null,
                    "DataSourceId": 1093,
                    "Result": {
                        "Result": "0 event(s) are created.",
                        "Events": []
                    },
                    "OutputModel": {
                        "result": {
                            "description": "<table class='cc-table'><tr><th>Result</th></tr><tr><td>No result</td></tr></table>",
                            "actions": [],
                            "references": [],
                            "resultFormatType": 9
                        },
                        "error": "",
                        "returnData": "Successful",
                        "rawData": "[]",
                        "contextData": "[]",
                        "outputData": {
                            "MessageIDs": "[]"
                        },
                        "passdownData": null,
                        "testingDetailData": null,
                        "customLog": null,
                        "others": {}
                    }
                },
                "Raw Data": [],
                "Error Message": null
            },
            {
                "UTCStarttime": "2022-08-04 22:46:41.890000",
                "UTCEndtime": "2022-08-04 22:46:42.150000",
                "ExecutionDurationInSec": "0.260",
                "IntervalDurationInMinute": "0.080",
                "State": "Successful",
                "Input Data": [
                    {
                        "Command Name": "Fetch Event",
                        "Parameter 1: User Email": "phishixx@d3cyberlab.com",
                        "Parameter 2: Start Time": "2022-08-04 01:00:00",
                        "Parameter 3: End Time": "2022-08-04 02:00:00",
                        "Parameter 4: Top Recent Event Number": "5",
                        "Parameter 5: Search Condition": ""
                    }
                ],
                "Output Data": {
                    "EventCount": 0,
                    "NotifyChanges": false,
                    "CompositeId": null,
                    "ConnectionId": 1038,
                    "SiteId": 2,
                    "Error": null,
                    "DataSourceId": 1093,
                    "Result": {
                        "Result": "0 event(s) are created.",
                        "Events": []
                    },
                    "OutputModel": {
                        "result": {
                            "description": "<table class='cc-table'><tr><th>Result</th></tr><tr><td>No result</td></tr></table>",
                            "actions": [],
                            "references": [],
                            "resultFormatType": 9
                        },
                        "error": "",
                        "returnData": "Successful",
                        "rawData": "[]",
                        "contextData": "[]",
                        "outputData": {
                            "MessageIDs": "[]"
                        },
                        "passdownData": null,
                        "testingDetailData": null,
                        "customLog": null,
                        "others": {}
                    }
                },
                "Raw Data": [],
                "Error Message": null
            },
            {
                "UTCStarttime": "2022-08-04 22:46:46.913000",
                "UTCEndtime": "2022-08-04 22:46:47.143000",
                "ExecutionDurationInSec": "0.230",
                "IntervalDurationInMinute": "0.079",
                "State": "Successful",
                "Input Data": [
                    {
                        "Command Name": "Fetch Event",
                        "Parameter 1: User Email": "phishixx@d3cyberlab.com",
                        "Parameter 2: Start Time": "2022-08-04 02:00:00",
                        "Parameter 3: End Time": "2022-08-04 03:00:00",
                        "Parameter 4: Top Recent Event Number": "5",
                        "Parameter 5: Search Condition": ""
                    }
                ],
                "Output Data": {
                    "EventCount": 0,
                    "NotifyChanges": false,
                    "CompositeId": null,
                    "ConnectionId": 1038,
                    "SiteId": 2,
                    "Error": null,
                    "DataSourceId": 1093,
                    "Result": {
                        "Result": "0 event(s) are created.",
                        "Events": []
                    },
                    "OutputModel": {
                        "result": {
                            "description": "<table class='cc-table'><tr><th>Result</th></tr><tr><td>No result</td></tr></table>",
                            "actions": [],
                            "references": [],
                            "resultFormatType": 9
                        },
                        "error": "",
                        "returnData": "Successful",
                        "rawData": "[]",
                        "contextData": "[]",
                        "outputData": {
                            "MessageIDs": "[]"
                        },
                        "passdownData": null,
                        "testingDetailData": null,
                        "customLog": null,
                        "others": {}
                    }
                },
                "Raw Data": [],
                "Error Message": null
            }
        ]
    }
}

400 BadRequest

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "The body of the request must be a valid JSON object"}

401 Unauthorized

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "Invalid authentication key."}

429 TooManyRequests

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "The request exceeds rate limits or is otherwise blocked by rate limiting policies."}

500 InternalServerError

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "Unexpected Error."}