Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("filter[query]","<string>")
$oQueryParams.UpdateString("filter[from]","<dateTime>")
$oQueryParams.UpdateString("filter[to]","<dateTime>")
$oQueryParams.UpdateString("sort","timestamp")
$oQueryParams.UpdateString("page[cursor]","<string>")
$oQueryParams.UpdateInt("page[limit]",10)
$oHttp.SetRequestHeader "DD-API-KEY","{{apiKey}}"
$oHttp.SetRequestHeader "Accept","application/json"
Local $oResp = $oHttp.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/ci/pipelines/events",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "data": [
; {
; "attributes": {
; "attributes": {
; "ex_4_": {},
; "fugiat69": {},
; "ad_7": {}
; },
; "ci_level": "job",
; "tags": [
; "<string>",
; "<string>"
; ]
; },
; "id": "<string>",
; "type": "cipipeline"
; },
; {
; "attributes": {
; "attributes": {
; "pariatur7_": {}
; },
; "ci_level": "pipeline",
; "tags": [
; "<string>",
; "<string>"
; ]
; },
; "id": "<string>",
; "type": "cipipeline"
; }
; ],
; "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
Local $sCi_level
Local $sId
Local $sV_type
Local $iJ
Local $iCount_j
Local $strVal
Local $sCode
Local $sDetail
Local $sTitle
Local $sV_Next = $oJResp.StringOf("links.next")
Local $sElapsed = $oJResp.StringOf("meta.elapsed")
Local $sAfter = $oJResp.StringOf("meta.page.after")
Local $sRequest_id = $oJResp.StringOf("meta.request_id")
Local $sStatus = $oJResp.StringOf("meta.status")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("data")
While $i < $iCount_i
$oJResp.I = $i
$sCi_level = $oJResp.StringOf("data[i].attributes.ci_level")
$sId = $oJResp.StringOf("data[i].id")
$sV_type = $oJResp.StringOf("data[i].type")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("data[i].attributes.tags")
While $iJ < $iCount_j
$oJResp.J = $iJ
$strVal = $oJResp.StringOf("data[i].attributes.tags[j]")
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("meta.warnings")
While $i < $iCount_i
$oJResp.I = $i
$sCode = $oJResp.StringOf("meta.warnings[i].code")
$sDetail = $oJResp.StringOf("meta.warnings[i].detail")
$sTitle = $oJResp.StringOf("meta.warnings[i].title")
$i = $i + 1
Wend
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 "DD-API-KEY: {{apiKey}}"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/ci/pipelines/events
Postman Collection Item JSON
{
"name": "Get a list of pipelines events",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "DD-API-KEY",
"type": "string"
},
{
"key": "value",
"value": "{{apiKey}}",
"type": "string"
},
{
"key": "in",
"value": "header",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ci/pipelines/events?filter[query]=<string>&filter[from]=<dateTime>&filter[to]=<dateTime>&sort=timestamp&page[cursor]=<string>&page[limit]=10",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipelines",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "<string>",
"description": "Search query following log syntax."
},
{
"key": "filter[from]",
"value": "<dateTime>",
"description": "Minimum timestamp for requested events."
},
{
"key": "filter[to]",
"value": "<dateTime>",
"description": "Maximum timestamp for requested events."
},
{
"key": "sort",
"value": "timestamp",
"description": "Order of events 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 events in the response."
}
]
},
"description": "List endpoint returns CI Visibility pipeline events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).\n[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).\n\nUse this endpoint to see your latest pipeline events."
},
"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/ci/pipelines/events?filter[query]=<string>&filter[from]=<dateTime>&filter[to]=<dateTime>&sort=timestamp&page[cursor]=<string>&page[limit]=10",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipelines",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "<string>",
"description": "Search query following log syntax."
},
{
"key": "filter[from]",
"value": "<dateTime>",
"description": "Minimum timestamp for requested events."
},
{
"key": "filter[to]",
"value": "<dateTime>",
"description": "Maximum timestamp for requested events."
},
{
"key": "sort",
"value": "timestamp",
"description": "Order of events 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 events 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 \"ex_4_\": {},\n \"fugiat69\": {},\n \"ad_7\": {}\n },\n \"ci_level\": \"job\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"id\": \"<string>\",\n \"type\": \"cipipeline\"\n },\n {\n \"attributes\": {\n \"attributes\": {\n \"pariatur7_\": {}\n },\n \"ci_level\": \"pipeline\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"id\": \"<string>\",\n \"type\": \"cipipeline\"\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/ci/pipelines/events?filter[query]=<string>&filter[from]=<dateTime>&filter[to]=<dateTime>&sort=timestamp&page[cursor]=<string>&page[limit]=10",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipelines",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "<string>",
"description": "Search query following log syntax."
},
{
"key": "filter[from]",
"value": "<dateTime>",
"description": "Minimum timestamp for requested events."
},
{
"key": "filter[to]",
"value": "<dateTime>",
"description": "Maximum timestamp for requested events."
},
{
"key": "sort",
"value": "timestamp",
"description": "Order of events 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 events 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/ci/pipelines/events?filter[query]=<string>&filter[from]=<dateTime>&filter[to]=<dateTime>&sort=timestamp&page[cursor]=<string>&page[limit]=10",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipelines",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "<string>",
"description": "Search query following log syntax."
},
{
"key": "filter[from]",
"value": "<dateTime>",
"description": "Minimum timestamp for requested events."
},
{
"key": "filter[to]",
"value": "<dateTime>",
"description": "Maximum timestamp for requested events."
},
{
"key": "sort",
"value": "timestamp",
"description": "Order of events 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 events 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/ci/pipelines/events?filter[query]=<string>&filter[from]=<dateTime>&filter[to]=<dateTime>&sort=timestamp&page[cursor]=<string>&page[limit]=10",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ci",
"pipelines",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "<string>",
"description": "Search query following log syntax."
},
{
"key": "filter[from]",
"value": "<dateTime>",
"description": "Minimum timestamp for requested events."
},
{
"key": "filter[to]",
"value": "<dateTime>",
"description": "Maximum timestamp for requested events."
},
{
"key": "sort",
"value": "timestamp",
"description": "Order of events 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 events 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}"
}
]
}
