Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()
var success: Bool
let queryParams = CkoJsonObject()
queryParams.UpdateString("filter[query]", value: "<string>")
queryParams.UpdateString("filter[from]", value: "<dateTime>")
queryParams.UpdateString("filter[to]", value: "<dateTime>")
queryParams.UpdateString("sort", value: "timestamp")
queryParams.UpdateString("page[cursor]", value: "<string>")
queryParams.UpdateInt("page[limit]", value: 10)
http.SetRequestHeader("DD-API-KEY", value: "{{apiKey}}")
http.SetRequestHeader("Accept", value: "application/json")
var resp: CkoHttpResponse? = http.QuickRequestParams("GET", url: "https://api.app.ddog-gov.com/api/v2/ci/pipelines/events", json: queryParams)
if http.LastMethodSuccess == false {
print("\(http.LastErrorText)")
return
}
let sbResponseBody = CkoStringBuilder()
resp!.GetBodySb(sbResponseBody)
let jResp = CkoJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = false
print("Response Body:")
print("\(jResp.Emit())")
var respStatusCode: Int = resp!.StatusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.Header)")
print("Failed.")
resp = nil
return
}
resp = nil
// 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
var Ci_level: String?
var id: String?
var v_type: String?
var j: Int
var count_j: Int
var strVal: String?
var code: String?
var detail: String?
var title: String?
var v_Next: String? = jResp.StringOf("links.next")
var Elapsed: String? = jResp.StringOf("meta.elapsed")
var After: String? = jResp.StringOf("meta.page.after")
var Request_id: String? = jResp.StringOf("meta.request_id")
var Status: String? = jResp.StringOf("meta.status")
var i: Int = 0
var count_i: Int = jResp.SizeOfArray("data").intValue
while i < count_i {
jResp.I = i
Ci_level = jResp.StringOf("data[i].attributes.ci_level")
id = jResp.StringOf("data[i].id")
v_type = jResp.StringOf("data[i].type")
j = 0
count_j = jResp.SizeOfArray("data[i].attributes.tags").intValue
while j < count_j {
jResp.J = j
strVal = jResp.StringOf("data[i].attributes.tags[j]")
j = j + 1
}
i = i + 1
}
i = 0
count_i = jResp.SizeOfArray("meta.warnings").intValue
while i < count_i {
jResp.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 -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}"
}
]
}
