Chilkat Online Tools

phpExt / Datadog API Collection / Get a quick list of security signals

Back to Collection Items

<?php

include("chilkat_9_5_0.php");

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$http = new CkHttp();

$queryParams = new CkJsonObject();
$queryParams->UpdateString('filter[query]','<string>');
$queryParams->UpdateString('filter[from]','<dateTime>');
$queryParams->UpdateString('filter[to]','<dateTime>');
$queryParams->UpdateString('sort','-timestamp');
$queryParams->UpdateString('page[cursor]','<string>');
$queryParams->UpdateInt('page[limit]',10);

$http->SetRequestHeader('Accept','application/json');

// resp is a CkHttpResponse
$resp = $http->QuickRequestParams('GET','https://api.app.ddog-gov.com/api/v2/security_monitoring/signals',$queryParams);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->header() . "\n";
    print 'Failed.' . "\n";

    exit;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "data": [
//     {
//       "attributes": {
//         "attributes": {
//           "laboris6b": {},
//           "qui_4_": {},
//           "sintcb": {}
//         },
//         "message": "<string>",
//         "tags": [
//           "<string>",
//           "<string>"
//         ],
//         "timestamp": "<dateTime>"
//       },
//       "id": "<string>",
//       "type": "signal"
//     },
//     {
//       "attributes": {
//         "attributes": {
//           "cillumc": {},
//           "ut_75": {}
//         },
//         "message": "<string>",
//         "tags": [
//           "<string>",
//           "<string>"
//         ],
//         "timestamp": "<dateTime>",
//         "sit5": {}
//       },
//       "id": "<string>",
//       "type": "signal"
//     }
//   ],
//   "links": {
//     "next": "<string>"
//   },
//   "meta": {
//     "page": {
//       "after": "<string>"
//     }
//   }
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

$v_Next = $jResp->stringOf('links.next');
$After = $jResp->stringOf('meta.page.after');
$i = 0;
$count_i = $jResp->SizeOfArray('data');
while ($i < $count_i) {
    $jResp->put_I($i);
    $Message = $jResp->stringOf('data[i].attributes.message');
    $Timestamp = $jResp->stringOf('data[i].attributes.timestamp');
    $id = $jResp->stringOf('data[i].id');
    $v_type = $jResp->stringOf('data[i].type');
    $j = 0;
    $count_j = $jResp->SizeOfArray('data[i].attributes.tags');
    while ($j < $count_j) {
        $jResp->put_J($j);
        $strVal = $jResp->stringOf('data[i].attributes.tags[j]');
        $j = $j + 1;
    }

    $i = $i + 1;
}


?>

Curl Command

curl -G -d "filter[query]=%3Cstring%3E"
	-d "filter[from]=%3CdateTime%3E"
	-d "filter[to]=%3CdateTime%3E"
	-d "sort=-timestamp"
	-d "page[cursor]=%3Cstring%3E"
	-d "page[limit]=10"
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/security_monitoring/signals

Postman Collection Item JSON

{
  "name": "Get a quick list of security signals",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/security_monitoring/signals?filter[query]=<string>&filter[from]=<dateTime>&filter[to]=<dateTime>&sort=-timestamp&page[cursor]=<string>&page[limit]=10",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "security_monitoring",
        "signals"
      ],
      "query": [
        {
          "key": "filter[query]",
          "value": "<string>",
          "description": "The search query for security signals."
        },
        {
          "key": "filter[from]",
          "value": "<dateTime>",
          "description": "The minimum timestamp for requested security signals."
        },
        {
          "key": "filter[to]",
          "value": "<dateTime>",
          "description": "The maximum timestamp for requested security signals."
        },
        {
          "key": "sort",
          "value": "-timestamp",
          "description": "The order of the security signals in results."
        },
        {
          "key": "page[cursor]",
          "value": "<string>",
          "description": "A list of results using the cursor provided in the previous query."
        },
        {
          "key": "page[limit]",
          "value": "10",
          "description": "The maximum number of security signals in the response."
        }
      ]
    },
    "description": "The list endpoint returns security signals that match a search query.\nBoth this endpoint and the POST endpoint can be used interchangeably when listing\nsecurity signals."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/security_monitoring/signals?filter[query]=<string>&filter[from]=<dateTime>&filter[to]=<dateTime>&sort=-timestamp&page[cursor]=<string>&page[limit]=10",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "security_monitoring",
            "signals"
          ],
          "query": [
            {
              "key": "filter[query]",
              "value": "<string>",
              "description": "The search query for security signals."
            },
            {
              "key": "filter[from]",
              "value": "<dateTime>",
              "description": "The minimum timestamp for requested security signals."
            },
            {
              "key": "filter[to]",
              "value": "<dateTime>",
              "description": "The maximum timestamp for requested security signals."
            },
            {
              "key": "sort",
              "value": "-timestamp",
              "description": "The order of the security signals in results."
            },
            {
              "key": "page[cursor]",
              "value": "<string>",
              "description": "A list of results using the cursor provided in the previous query."
            },
            {
              "key": "page[limit]",
              "value": "10",
              "description": "The maximum number of security signals in the response."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": [\n    {\n      \"attributes\": {\n        \"attributes\": {\n          \"laboris6b\": {},\n          \"qui_4_\": {},\n          \"sintcb\": {}\n        },\n        \"message\": \"<string>\",\n        \"tags\": [\n          \"<string>\",\n          \"<string>\"\n        ],\n        \"timestamp\": \"<dateTime>\"\n      },\n      \"id\": \"<string>\",\n      \"type\": \"signal\"\n    },\n    {\n      \"attributes\": {\n        \"attributes\": {\n          \"cillumc\": {},\n          \"ut_75\": {}\n        },\n        \"message\": \"<string>\",\n        \"tags\": [\n          \"<string>\",\n          \"<string>\"\n        ],\n        \"timestamp\": \"<dateTime>\",\n        \"sit5\": {}\n      },\n      \"id\": \"<string>\",\n      \"type\": \"signal\"\n    }\n  ],\n  \"links\": {\n    \"next\": \"<string>\"\n  },\n  \"meta\": {\n    \"page\": {\n      \"after\": \"<string>\"\n    }\n  }\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/security_monitoring/signals?filter[query]=<string>&filter[from]=<dateTime>&filter[to]=<dateTime>&sort=-timestamp&page[cursor]=<string>&page[limit]=10",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "security_monitoring",
            "signals"
          ],
          "query": [
            {
              "key": "filter[query]",
              "value": "<string>",
              "description": "The search query for security signals."
            },
            {
              "key": "filter[from]",
              "value": "<dateTime>",
              "description": "The minimum timestamp for requested security signals."
            },
            {
              "key": "filter[to]",
              "value": "<dateTime>",
              "description": "The maximum timestamp for requested security signals."
            },
            {
              "key": "sort",
              "value": "-timestamp",
              "description": "The order of the security signals in results."
            },
            {
              "key": "page[cursor]",
              "value": "<string>",
              "description": "A list of results using the cursor provided in the previous query."
            },
            {
              "key": "page[limit]",
              "value": "10",
              "description": "The maximum number of security signals in the response."
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    },
    {
      "name": "Not Authorized",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/security_monitoring/signals?filter[query]=<string>&filter[from]=<dateTime>&filter[to]=<dateTime>&sort=-timestamp&page[cursor]=<string>&page[limit]=10",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "security_monitoring",
            "signals"
          ],
          "query": [
            {
              "key": "filter[query]",
              "value": "<string>",
              "description": "The search query for security signals."
            },
            {
              "key": "filter[from]",
              "value": "<dateTime>",
              "description": "The minimum timestamp for requested security signals."
            },
            {
              "key": "filter[to]",
              "value": "<dateTime>",
              "description": "The maximum timestamp for requested security signals."
            },
            {
              "key": "sort",
              "value": "-timestamp",
              "description": "The order of the security signals in results."
            },
            {
              "key": "page[cursor]",
              "value": "<string>",
              "description": "A list of results using the cursor provided in the previous query."
            },
            {
              "key": "page[limit]",
              "value": "10",
              "description": "The maximum number of security signals in the response."
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    },
    {
      "name": "Too many requests",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/security_monitoring/signals?filter[query]=<string>&filter[from]=<dateTime>&filter[to]=<dateTime>&sort=-timestamp&page[cursor]=<string>&page[limit]=10",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "security_monitoring",
            "signals"
          ],
          "query": [
            {
              "key": "filter[query]",
              "value": "<string>",
              "description": "The search query for security signals."
            },
            {
              "key": "filter[from]",
              "value": "<dateTime>",
              "description": "The minimum timestamp for requested security signals."
            },
            {
              "key": "filter[to]",
              "value": "<dateTime>",
              "description": "The maximum timestamp for requested security signals."
            },
            {
              "key": "sort",
              "value": "-timestamp",
              "description": "The order of the security signals in results."
            },
            {
              "key": "page[cursor]",
              "value": "<string>",
              "description": "A list of results using the cursor provided in the previous query."
            },
            {
              "key": "page[limit]",
              "value": "10",
              "description": "The maximum number of security signals in the response."
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    }
  ]
}