Chilkat Online Tools

Swift3 / Datadog API Collection / Get a list of spans

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.update("filter[query]", value: "<string>")
    queryParams.update("filter[from]", value: "<string>")
    queryParams.update("filter[to]", value: "<string>")
    queryParams.update("sort", value: "timestamp")
    queryParams.update("page[cursor]", value: "<string>")
    queryParams.updateInt("page[limit]", value: 10)

    http.setRequestHeader("Accept", value: "application/json")

    var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://api.app.ddog-gov.com/api/v2/spans/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": {
    //           "culpac": {}
    //         },
    //         "custom": {
    //           "aliquip_8": {},
    //           "commodo_9c1": {}
    //         },
    //         "end_timestamp": "<dateTime>",
    //         "env": "<string>",
    //         "host": "<string>",
    //         "ingestion_reason": "<string>",
    //         "parent_id": "<string>",
    //         "resource_hash": "<string>",
    //         "resource_name": "<string>",
    //         "retained_by": "<string>",
    //         "service": "<string>",
    //         "single_span": "<boolean>",
    //         "span_id": "<string>",
    //         "start_timestamp": "<dateTime>",
    //         "tags": [
    //           "<string>",
    //           "<string>"
    //         ],
    //         "trace_id": "<string>",
    //         "type": "<string>"
    //       },
    //       "id": "<string>",
    //       "type": "spans"
    //     },
    //     {
    //       "attributes": {
    //         "attributes": {
    //           "Lorem_c": {}
    //         },
    //         "custom": {
    //           "culpa_c": {},
    //           "consectetur_cf": {}
    //         },
    //         "end_timestamp": "<dateTime>",
    //         "env": "<string>",
    //         "host": "<string>",
    //         "ingestion_reason": "<string>",
    //         "parent_id": "<string>",
    //         "resource_hash": "<string>",
    //         "resource_name": "<string>",
    //         "retained_by": "<string>",
    //         "service": "<string>",
    //         "single_span": "<boolean>",
    //         "span_id": "<string>",
    //         "start_timestamp": "<dateTime>",
    //         "tags": [
    //           "<string>",
    //           "<string>"
    //         ],
    //         "trace_id": "<string>",
    //         "type": "<string>"
    //       },
    //       "id": "<string>",
    //       "type": "spans"
    //     }
    //   ],
    //   "links": {
    //     "next": "<string>"
    //   },
    //   "meta": {
    //     "elapsed": "<long>",
    //     "page": {
    //       "after": "<string>"
    //     },
    //     "request_id": "<string>",
    //     "status": "timeout",
    //     "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 End_timestamp: String?
    var Env: String?
    var Host: String?
    var Ingestion_reason: String?
    var Parent_id: String?
    var Resource_hash: String?
    var Resource_name: String?
    var Retained_by: String?
    var Service: String?
    var Single_span: String?
    var Span_id: String?
    var Start_timestamp: String?
    var Trace_id: String?
    var v_Type: 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.string(of: "links.next")
    var Elapsed: String? = jResp.string(of: "meta.elapsed")
    var After: String? = jResp.string(of: "meta.page.after")
    var Request_id: String? = jResp.string(of: "meta.request_id")
    var Status: String? = jResp.string(of: "meta.status")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "data").intValue
    while i < count_i {
        jResp.i = i
        End_timestamp = jResp.string(of: "data[i].attributes.end_timestamp")
        Env = jResp.string(of: "data[i].attributes.env")
        Host = jResp.string(of: "data[i].attributes.host")
        Ingestion_reason = jResp.string(of: "data[i].attributes.ingestion_reason")
        Parent_id = jResp.string(of: "data[i].attributes.parent_id")
        Resource_hash = jResp.string(of: "data[i].attributes.resource_hash")
        Resource_name = jResp.string(of: "data[i].attributes.resource_name")
        Retained_by = jResp.string(of: "data[i].attributes.retained_by")
        Service = jResp.string(of: "data[i].attributes.service")
        Single_span = jResp.string(of: "data[i].attributes.single_span")
        Span_id = jResp.string(of: "data[i].attributes.span_id")
        Start_timestamp = jResp.string(of: "data[i].attributes.start_timestamp")
        Trace_id = jResp.string(of: "data[i].attributes.trace_id")
        v_Type = jResp.string(of: "data[i].attributes.type")
        id = jResp.string(of: "data[i].id")
        v_type = jResp.string(of: "data[i].type")
        j = 0
        count_j = jResp.size(ofArray: "data[i].attributes.tags").intValue
        while j < count_j {
            jResp.j = j
            strVal = jResp.string(of: "data[i].attributes.tags[j]")
            j = j + 1
        }

        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "meta.warnings").intValue
    while i < count_i {
        jResp.i = i
        code = jResp.string(of: "meta.warnings[i].code")
        detail = jResp.string(of: "meta.warnings[i].detail")
        title = jResp.string(of: "meta.warnings[i].title")
        i = i + 1
    }


}

Curl Command

curl -G -d "filter[query]=%3Cstring%3E"
	-d "filter[from]=%3Cstring%3E"
	-d "filter[to]=%3Cstring%3E"
	-d "sort=timestamp"
	-d "page[cursor]=%3Cstring%3E"
	-d "page[limit]=10"
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/spans/events

Postman Collection Item JSON

{
  "name": "Get a list of spans",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/spans/events?filter[query]=<string>&filter[from]=<string>&filter[to]=<string>&sort=timestamp&page[cursor]=<string>&page[limit]=10",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "spans",
        "events"
      ],
      "query": [
        {
          "key": "filter[query]",
          "value": "<string>",
          "description": "Search query following spans syntax."
        },
        {
          "key": "filter[from]",
          "value": "<string>",
          "description": "Minimum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds)."
        },
        {
          "key": "filter[to]",
          "value": "<string>",
          "description": "Maximum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds)."
        },
        {
          "key": "sort",
          "value": "timestamp",
          "description": "Order of spans 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 spans in the response."
        }
      ]
    },
    "description": "List endpoint returns spans that match a span search query.\n[Results are paginated][1].\n\nUse this endpoint to see your latest spans.\nThis endpoint is rate limited to `300` requests per hour.\n\n[1]: /logs/guide/collect-multiple-logs-with-pagination?tab=v2api"
  },
  "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/spans/events?filter[query]=<string>&filter[from]=<string>&filter[to]=<string>&sort=timestamp&page[cursor]=<string>&page[limit]=10",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "spans",
            "events"
          ],
          "query": [
            {
              "key": "filter[query]",
              "value": "<string>",
              "description": "Search query following spans syntax."
            },
            {
              "key": "filter[from]",
              "value": "<string>",
              "description": "Minimum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds)."
            },
            {
              "key": "filter[to]",
              "value": "<string>",
              "description": "Maximum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds)."
            },
            {
              "key": "sort",
              "value": "timestamp",
              "description": "Order of spans 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 spans 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          \"culpac\": {}\n        },\n        \"custom\": {\n          \"aliquip_8\": {},\n          \"commodo_9c1\": {}\n        },\n        \"end_timestamp\": \"<dateTime>\",\n        \"env\": \"<string>\",\n        \"host\": \"<string>\",\n        \"ingestion_reason\": \"<string>\",\n        \"parent_id\": \"<string>\",\n        \"resource_hash\": \"<string>\",\n        \"resource_name\": \"<string>\",\n        \"retained_by\": \"<string>\",\n        \"service\": \"<string>\",\n        \"single_span\": \"<boolean>\",\n        \"span_id\": \"<string>\",\n        \"start_timestamp\": \"<dateTime>\",\n        \"tags\": [\n          \"<string>\",\n          \"<string>\"\n        ],\n        \"trace_id\": \"<string>\",\n        \"type\": \"<string>\"\n      },\n      \"id\": \"<string>\",\n      \"type\": \"spans\"\n    },\n    {\n      \"attributes\": {\n        \"attributes\": {\n          \"Lorem_c\": {}\n        },\n        \"custom\": {\n          \"culpa_c\": {},\n          \"consectetur_cf\": {}\n        },\n        \"end_timestamp\": \"<dateTime>\",\n        \"env\": \"<string>\",\n        \"host\": \"<string>\",\n        \"ingestion_reason\": \"<string>\",\n        \"parent_id\": \"<string>\",\n        \"resource_hash\": \"<string>\",\n        \"resource_name\": \"<string>\",\n        \"retained_by\": \"<string>\",\n        \"service\": \"<string>\",\n        \"single_span\": \"<boolean>\",\n        \"span_id\": \"<string>\",\n        \"start_timestamp\": \"<dateTime>\",\n        \"tags\": [\n          \"<string>\",\n          \"<string>\"\n        ],\n        \"trace_id\": \"<string>\",\n        \"type\": \"<string>\"\n      },\n      \"id\": \"<string>\",\n      \"type\": \"spans\"\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\": \"timeout\",\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/spans/events?filter[query]=<string>&filter[from]=<string>&filter[to]=<string>&sort=timestamp&page[cursor]=<string>&page[limit]=10",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "spans",
            "events"
          ],
          "query": [
            {
              "key": "filter[query]",
              "value": "<string>",
              "description": "Search query following spans syntax."
            },
            {
              "key": "filter[from]",
              "value": "<string>",
              "description": "Minimum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds)."
            },
            {
              "key": "filter[to]",
              "value": "<string>",
              "description": "Maximum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds)."
            },
            {
              "key": "sort",
              "value": "timestamp",
              "description": "Order of spans 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 spans in the response."
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    {\n      \"detail\": \"<string>\",\n      \"status\": \"<string>\",\n      \"title\": \"<string>\"\n    },\n    {\n      \"detail\": \"<string>\",\n      \"status\": \"<string>\",\n      \"title\": \"<string>\"\n    }\n  ]\n}"
    },
    {
      "name": "Forbidden: Access denied.",
      "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/spans/events?filter[query]=<string>&filter[from]=<string>&filter[to]=<string>&sort=timestamp&page[cursor]=<string>&page[limit]=10",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "spans",
            "events"
          ],
          "query": [
            {
              "key": "filter[query]",
              "value": "<string>",
              "description": "Search query following spans syntax."
            },
            {
              "key": "filter[from]",
              "value": "<string>",
              "description": "Minimum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds)."
            },
            {
              "key": "filter[to]",
              "value": "<string>",
              "description": "Maximum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds)."
            },
            {
              "key": "sort",
              "value": "timestamp",
              "description": "Order of spans 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 spans in the response."
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    {\n      \"detail\": \"<string>\",\n      \"status\": \"<string>\",\n      \"title\": \"<string>\"\n    },\n    {\n      \"detail\": \"<string>\",\n      \"status\": \"<string>\",\n      \"title\": \"<string>\"\n    }\n  ]\n}"
    },
    {
      "name": "Unprocessable Entity.",
      "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/spans/events?filter[query]=<string>&filter[from]=<string>&filter[to]=<string>&sort=timestamp&page[cursor]=<string>&page[limit]=10",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "spans",
            "events"
          ],
          "query": [
            {
              "key": "filter[query]",
              "value": "<string>",
              "description": "Search query following spans syntax."
            },
            {
              "key": "filter[from]",
              "value": "<string>",
              "description": "Minimum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds)."
            },
            {
              "key": "filter[to]",
              "value": "<string>",
              "description": "Maximum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds)."
            },
            {
              "key": "sort",
              "value": "timestamp",
              "description": "Order of spans 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 spans in the response."
            }
          ]
        }
      },
      "status": "Unprocessable Entity (WebDAV) (RFC 4918)",
      "code": 422,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    {\n      \"detail\": \"<string>\",\n      \"status\": \"<string>\",\n      \"title\": \"<string>\"\n    },\n    {\n      \"detail\": \"<string>\",\n      \"status\": \"<string>\",\n      \"title\": \"<string>\"\n    }\n  ]\n}"
    },
    {
      "name": "Too many requests: The rate limit set by the API has been exceeded.",
      "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/spans/events?filter[query]=<string>&filter[from]=<string>&filter[to]=<string>&sort=timestamp&page[cursor]=<string>&page[limit]=10",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "spans",
            "events"
          ],
          "query": [
            {
              "key": "filter[query]",
              "value": "<string>",
              "description": "Search query following spans syntax."
            },
            {
              "key": "filter[from]",
              "value": "<string>",
              "description": "Minimum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds)."
            },
            {
              "key": "filter[to]",
              "value": "<string>",
              "description": "Maximum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds)."
            },
            {
              "key": "sort",
              "value": "timestamp",
              "description": "Order of spans 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 spans in the response."
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    {\n      \"detail\": \"<string>\",\n      \"status\": \"<string>\",\n      \"title\": \"<string>\"\n    },\n    {\n      \"detail\": \"<string>\",\n      \"status\": \"<string>\",\n      \"title\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}