Chilkat Online Tools

Unicode C++ / Datadog API Collection / Get a list of pipelines events

Back to Collection Items

void ChilkatSample(void)
    {
    queryParams.UpdateString(L"filter[query]",L"<string>");    queryParams.UpdateString(L"filter[from]",L"<dateTime>");    queryParams.UpdateString(L"filter[to]",L"<dateTime>");    queryParams.UpdateString(L"sort",L"timestamp");    queryParams.UpdateString(L"page[cursor]",L"<string>");    queryParams.UpdateInt(L"page[limit]",10);    resp->GetBodySb(sbResponseBody);    jResp.LoadSb(sbResponseBody);    jResp.put_EmitCompact(false);    jResp.put_I(i);    Ci_level = jResp.stringOf(L"data[i].attributes.ci_level");    id = jResp.stringOf(L"data[i].id");    v_type = jResp.stringOf(L"data[i].type");    j = 0;    count_j = jResp.SizeOfArray(L"data[i].attributes.tags");    jResp.put_J(j);    strVal = jResp.stringOf(L"data[i].attributes.tags[j]");    j = j + 1;    i = i + 1;    i = 0;    count_i = jResp.SizeOfArray(L"meta.warnings");    jResp.put_I(i);    code = jResp.stringOf(L"meta.warnings[i].code");    detail = jResp.stringOf(L"meta.warnings[i].detail");    title = jResp.stringOf(L"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}"
    }
  ]
}