Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateString("filter[query]","<string>")
loQueryParams.UpdateString("filter[indexes]","<string>,<string>")
loQueryParams.UpdateString("filter[from]","<dateTime>")
loQueryParams.UpdateString("filter[to]","<dateTime>")
loQueryParams.UpdateString("filter[storage_tier]","indexes")
loQueryParams.UpdateString("sort","-timestamp")
loQueryParams.UpdateString("page[cursor]","<string>")
loQueryParams.UpdateInt("page[limit]",10)
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/logs/events",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loQueryParams
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
return
endif
release loResp
// 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
lcV_Next = loJResp.StringOf("links.next")
lcElapsed = loJResp.StringOf("meta.elapsed")
lcAfter = loJResp.StringOf("meta.page.after")
lcRequest_id = loJResp.StringOf("meta.request_id")
lcStatus = loJResp.StringOf("meta.status")
i = 0
lnCount_i = loJResp.SizeOfArray("data")
do while i < lnCount_i
loJResp.I = i
lcHost = loJResp.StringOf("data[i].attributes.host")
lcMessage = loJResp.StringOf("data[i].attributes.message")
lcService = loJResp.StringOf("data[i].attributes.service")
lcAttributesStatus = loJResp.StringOf("data[i].attributes.status")
lcTimestamp = loJResp.StringOf("data[i].attributes.timestamp")
lcId = loJResp.StringOf("data[i].id")
lcV_type = loJResp.StringOf("data[i].type")
j = 0
lnCount_j = loJResp.SizeOfArray("data[i].attributes.tags")
do while j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("data[i].attributes.tags[j]")
j = j + 1
enddo
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("meta.warnings")
do while i < lnCount_i
loJResp.I = i
lcCode = loJResp.StringOf("meta.warnings[i].code")
lcDetail = loJResp.StringOf("meta.warnings[i].detail")
lcTitle = loJResp.StringOf("meta.warnings[i].title")
i = i + 1
enddo
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
Curl Command
curl -G -d "filter[query]=%3Cstring%3E"
-d "filter[indexes]=%3Cstring%3E,%3Cstring%3E"
-d "filter[from]=%3CdateTime%3E"
-d "filter[to]=%3CdateTime%3E"
-d "filter[storage_tier]=indexes"
-d "sort=-timestamp"
-d "page[cursor]=%3Cstring%3E"
-d "page[limit]=10"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/logs/events
Postman Collection Item JSON
{
"name": "Get a list of logs",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/logs/events?filter[query]=<string>&filter[indexes]=<string>,<string>&filter[from]=<dateTime>&filter[to]=<dateTime>&filter[storage_tier]=indexes&sort=-timestamp&page[cursor]=<string>&page[limit]=10",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "<string>",
"description": "Search query following logs syntax."
},
{
"key": "filter[indexes]",
"value": "<string>,<string>",
"description": "For customers with multiple indexes, the indexes to search.\nDefaults to '*' which means all indexes"
},
{
"key": "filter[from]",
"value": "<dateTime>",
"description": "Minimum timestamp for requested logs."
},
{
"key": "filter[to]",
"value": "<dateTime>",
"description": "Maximum timestamp for requested logs."
},
{
"key": "filter[storage_tier]",
"value": "indexes",
"description": "Specifies the storage type to be used"
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of logs in results."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "List following results with a cursor provided in the previous query."
},
{
"key": "page[limit]",
"value": "10",
"description": "Maximum number of logs in the response."
}
]
},
"description": "List endpoint returns logs that match a log search query.\n[Results are paginated][1].\n\nUse this endpoint to see your latest logs.\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": "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/logs/events?filter[query]=<string>&filter[indexes]=<string>,<string>&filter[from]=<dateTime>&filter[to]=<dateTime>&filter[storage_tier]=indexes&sort=-timestamp&page[cursor]=<string>&page[limit]=10",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "<string>",
"description": "Search query following logs syntax."
},
{
"key": "filter[indexes]",
"value": "<string>,<string>",
"description": "For customers with multiple indexes, the indexes to search.\nDefaults to '*' which means all indexes"
},
{
"key": "filter[from]",
"value": "<dateTime>",
"description": "Minimum timestamp for requested logs."
},
{
"key": "filter[to]",
"value": "<dateTime>",
"description": "Maximum timestamp for requested logs."
},
{
"key": "filter[storage_tier]",
"value": "indexes",
"description": "Specifies the storage type to be used"
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of logs in results."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "List following results with a cursor provided in the previous query."
},
{
"key": "page[limit]",
"value": "10",
"description": "Maximum number of logs 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 \"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": "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/logs/events?filter[query]=<string>&filter[indexes]=<string>,<string>&filter[from]=<dateTime>&filter[to]=<dateTime>&filter[storage_tier]=indexes&sort=-timestamp&page[cursor]=<string>&page[limit]=10",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "<string>",
"description": "Search query following logs syntax."
},
{
"key": "filter[indexes]",
"value": "<string>,<string>",
"description": "For customers with multiple indexes, the indexes to search.\nDefaults to '*' which means all indexes"
},
{
"key": "filter[from]",
"value": "<dateTime>",
"description": "Minimum timestamp for requested logs."
},
{
"key": "filter[to]",
"value": "<dateTime>",
"description": "Maximum timestamp for requested logs."
},
{
"key": "filter[storage_tier]",
"value": "indexes",
"description": "Specifies the storage type to be used"
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of logs in results."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "List following results with a cursor provided in the previous query."
},
{
"key": "page[limit]",
"value": "10",
"description": "Maximum number of logs 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/logs/events?filter[query]=<string>&filter[indexes]=<string>,<string>&filter[from]=<dateTime>&filter[to]=<dateTime>&filter[storage_tier]=indexes&sort=-timestamp&page[cursor]=<string>&page[limit]=10",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "<string>",
"description": "Search query following logs syntax."
},
{
"key": "filter[indexes]",
"value": "<string>,<string>",
"description": "For customers with multiple indexes, the indexes to search.\nDefaults to '*' which means all indexes"
},
{
"key": "filter[from]",
"value": "<dateTime>",
"description": "Minimum timestamp for requested logs."
},
{
"key": "filter[to]",
"value": "<dateTime>",
"description": "Maximum timestamp for requested logs."
},
{
"key": "filter[storage_tier]",
"value": "indexes",
"description": "Specifies the storage type to be used"
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of logs in results."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "List following results with a cursor provided in the previous query."
},
{
"key": "page[limit]",
"value": "10",
"description": "Maximum number of logs 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/logs/events?filter[query]=<string>&filter[indexes]=<string>,<string>&filter[from]=<dateTime>&filter[to]=<dateTime>&filter[storage_tier]=indexes&sort=-timestamp&page[cursor]=<string>&page[limit]=10",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "<string>",
"description": "Search query following logs syntax."
},
{
"key": "filter[indexes]",
"value": "<string>,<string>",
"description": "For customers with multiple indexes, the indexes to search.\nDefaults to '*' which means all indexes"
},
{
"key": "filter[from]",
"value": "<dateTime>",
"description": "Minimum timestamp for requested logs."
},
{
"key": "filter[to]",
"value": "<dateTime>",
"description": "Maximum timestamp for requested logs."
},
{
"key": "filter[storage_tier]",
"value": "indexes",
"description": "Specifies the storage type to be used"
},
{
"key": "sort",
"value": "-timestamp",
"description": "Order of logs in results."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "List following results with a cursor provided in the previous query."
},
{
"key": "page[limit]",
"value": "10",
"description": "Maximum number of logs 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}"
}
]
}
