Chilkat Online Tools

Perl / Datadog API Collection / Search logs

Back to Collection Items

use chilkat();

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

$http = chilkat::CkHttp->new();

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "filter": {
#     "from": "now-15m",
#     "indexes": [
#       "*"
#     ],
#     "query": "*",
#     "storage_tier": "indexes",
#     "to": "now"
#   },
#   "options": {
#     "timeOffset": "<long>",
#     "timezone": "UTC"
#   },
#   "page": {
#     "cursor": "<string>",
#     "limit": 10
#   },
#   "sort": "timestamp"
# }

$json = chilkat::CkJsonObject->new();
$json->UpdateString("filter.from","now-15m");
$json->UpdateString("filter.indexes[0]","*");
$json->UpdateString("filter.query","*");
$json->UpdateString("filter.storage_tier","indexes");
$json->UpdateString("filter.to","now");
$json->UpdateString("options.timeOffset","<long>");
$json->UpdateString("options.timezone","UTC");
$json->UpdateString("page.cursor","<string>");
$json->UpdateInt("page.limit",10);
$json->UpdateString("sort","timestamp");

$http->SetRequestHeader("Content-Type","application/json");
$http->SetRequestHeader("Accept","application/json");

# resp is a HttpResponse
$resp = $http->PostJson3("https://api.app.ddog-gov.com/api/v2/logs/events/search","application/json",$json);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

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

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

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

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

    exit;
}

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

# {
#   "data": [
#     {
#       "attributes": {
#         "attributes": {
#           "consectetur__9": {},
#           "aliquip_43": {}
#         },
#         "host": "<string>",
#         "message": "<string>",
#         "service": "<string>",
#         "status": "<string>",
#         "tags": [
#           "<string>",
#           "<string>"
#         ],
#         "timestamp": "<dateTime>"
#       },
#       "id": "<string>",
#       "type": "log"
#     },
#     {
#       "attributes": {
#         "attributes": {
#           "nisia4a": {},
#           "dolor4": {}
#         },
#         "host": "<string>",
#         "message": "<string>",
#         "service": "<string>",
#         "status": "<string>",
#         "tags": [
#           "<string>",
#           "<string>"
#         ],
#         "timestamp": "<dateTime>"
#       },
#       "id": "<string>",
#       "type": "log"
#     }
#   ],
#   "links": {
#     "next": "<string>"
#   },
#   "meta": {
#     "elapsed": "<long>",
#     "page": {
#       "after": "<string>"
#     },
#     "request_id": "<string>",
#     "status": "done",
#     "warnings": [
#       {
#         "code": "<string>",
#         "detail": "<string>",
#         "title": "<string>"
#       },
#       {
#         "code": "<string>",
#         "detail": "<string>",
#         "title": "<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");
$Elapsed = $jResp->stringOf("meta.elapsed");
$After = $jResp->stringOf("meta.page.after");
$Request_id = $jResp->stringOf("meta.request_id");
$Status = $jResp->stringOf("meta.status");
$i = 0;
$count_i = $jResp->SizeOfArray("data");
while ($i < $count_i) {
    $jResp->put_I($i);
    $Host = $jResp->stringOf("data[i].attributes.host");
    $Message = $jResp->stringOf("data[i].attributes.message");
    $Service = $jResp->stringOf("data[i].attributes.service");
    $attributesStatus = $jResp->stringOf("data[i].attributes.status");
    $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;
}

$i = 0;
$count_i = $jResp->SizeOfArray("meta.warnings");
while ($i < $count_i) {
    $jResp->put_I($i);
    $code = $jResp->stringOf("meta.warnings[i].code");
    $detail = $jResp->stringOf("meta.warnings[i].detail");
    $title = $jResp->stringOf("meta.warnings[i].title");
    $i = $i + 1;
}

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "filter": {
    "from": "now-15m",
    "indexes": [
      "*"
    ],
    "query": "*",
    "storage_tier": "indexes",
    "to": "now"
  },
  "options": {
    "timeOffset": "<long>",
    "timezone": "UTC"
  },
  "page": {
    "cursor": "<string>",
    "limit": 10
  },
  "sort": "timestamp"
}'
https://api.app.ddog-gov.com/api/v2/logs/events/search

Postman Collection Item JSON

{
  "name": "Search logs",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"filter\": {\n    \"from\": \"now-15m\",\n    \"indexes\": [\n      \"*\"\n    ],\n    \"query\": \"*\",\n    \"storage_tier\": \"indexes\",\n    \"to\": \"now\"\n  },\n  \"options\": {\n    \"timeOffset\": \"<long>\",\n    \"timezone\": \"UTC\"\n  },\n  \"page\": {\n    \"cursor\": \"<string>\",\n    \"limit\": 10\n  },\n  \"sort\": \"timestamp\"\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v2/logs/events/search",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "logs",
        "events",
        "search"
      ]
    },
    "description": "List endpoint returns logs that match a log search query.\n[Results are paginated][1].\n\nUse this endpoint to build complex logs filtering and search.\n\n**If you are considering archiving logs for your organization,\nconsider use of the Datadog archive capabilities instead of the log list API.\nSee [Datadog Logs Archive documentation][2].**\n\n[1]: /logs/guide/collect-multiple-logs-with-pagination\n[2]: https://docs.datadoghq.com/logs/archives"
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"filter\": {\n    \"from\": \"now-15m\",\n    \"indexes\": [\n      \"*\"\n    ],\n    \"query\": \"*\",\n    \"storage_tier\": \"indexes\",\n    \"to\": \"now\"\n  },\n  \"options\": {\n    \"timeOffset\": \"<long>\",\n    \"timezone\": \"UTC\"\n  },\n  \"page\": {\n    \"cursor\": \"<string>\",\n    \"limit\": 10\n  },\n  \"sort\": \"timestamp\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/logs/events/search",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "events",
            "search"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": [\n    {\n      \"attributes\": {\n        \"attributes\": {\n          \"consectetur__9\": {},\n          \"aliquip_43\": {}\n        },\n        \"host\": \"<string>\",\n        \"message\": \"<string>\",\n        \"service\": \"<string>\",\n        \"status\": \"<string>\",\n        \"tags\": [\n          \"<string>\",\n          \"<string>\"\n        ],\n        \"timestamp\": \"<dateTime>\"\n      },\n      \"id\": \"<string>\",\n      \"type\": \"log\"\n    },\n    {\n      \"attributes\": {\n        \"attributes\": {\n          \"nisia4a\": {},\n          \"dolor4\": {}\n        },\n        \"host\": \"<string>\",\n        \"message\": \"<string>\",\n        \"service\": \"<string>\",\n        \"status\": \"<string>\",\n        \"tags\": [\n          \"<string>\",\n          \"<string>\"\n        ],\n        \"timestamp\": \"<dateTime>\"\n      },\n      \"id\": \"<string>\",\n      \"type\": \"log\"\n    }\n  ],\n  \"links\": {\n    \"next\": \"<string>\"\n  },\n  \"meta\": {\n    \"elapsed\": \"<long>\",\n    \"page\": {\n      \"after\": \"<string>\"\n    },\n    \"request_id\": \"<string>\",\n    \"status\": \"done\",\n    \"warnings\": [\n      {\n        \"code\": \"<string>\",\n        \"detail\": \"<string>\",\n        \"title\": \"<string>\"\n      },\n      {\n        \"code\": \"<string>\",\n        \"detail\": \"<string>\",\n        \"title\": \"<string>\"\n      }\n    ]\n  }\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"filter\": {\n    \"from\": \"now-15m\",\n    \"indexes\": [\n      \"*\"\n    ],\n    \"query\": \"*\",\n    \"storage_tier\": \"indexes\",\n    \"to\": \"now\"\n  },\n  \"options\": {\n    \"timeOffset\": \"<long>\",\n    \"timezone\": \"UTC\"\n  },\n  \"page\": {\n    \"cursor\": \"<string>\",\n    \"limit\": 10\n  },\n  \"sort\": \"timestamp\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/logs/events/search",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "events",
            "search"
          ]
        }
      },
      "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": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"filter\": {\n    \"from\": \"now-15m\",\n    \"indexes\": [\n      \"*\"\n    ],\n    \"query\": \"*\",\n    \"storage_tier\": \"indexes\",\n    \"to\": \"now\"\n  },\n  \"options\": {\n    \"timeOffset\": \"<long>\",\n    \"timezone\": \"UTC\"\n  },\n  \"page\": {\n    \"cursor\": \"<string>\",\n    \"limit\": 10\n  },\n  \"sort\": \"timestamp\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/logs/events/search",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "events",
            "search"
          ]
        }
      },
      "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": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"filter\": {\n    \"from\": \"now-15m\",\n    \"indexes\": [\n      \"*\"\n    ],\n    \"query\": \"*\",\n    \"storage_tier\": \"indexes\",\n    \"to\": \"now\"\n  },\n  \"options\": {\n    \"timeOffset\": \"<long>\",\n    \"timezone\": \"UTC\"\n  },\n  \"page\": {\n    \"cursor\": \"<string>\",\n    \"limit\": 10\n  },\n  \"sort\": \"timestamp\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/logs/events/search",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "events",
            "search"
          ]
        }
      },
      "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}"
    }
  ]
}