Chilkat Online Tools

VB.NET / Datadog API Collection / Search spans

Back to Collection Items

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim http As New Chilkat.Http
Dim success As Boolean

' Use this online tool to generate code from sample JSON: Generate Code to Create JSON

' The following JSON is sent in the request body.

' {
'   "data": {
'     "attributes": {
'       "filter": {
'         "from": "now-15m",
'         "query": "*",
'         "to": "now"
'       },
'       "options": {
'         "timeOffset": "<long>",
'         "timezone": "UTC"
'       },
'       "page": {
'         "cursor": "<string>",
'         "limit": 10
'       },
'       "sort": "-timestamp"
'     },
'     "type": "search_request"
'   }
' }

Dim json As New Chilkat.JsonObject
json.UpdateString("data.attributes.filter.from","now-15m")
json.UpdateString("data.attributes.filter.query","*")
json.UpdateString("data.attributes.filter.to","now")
json.UpdateString("data.attributes.options.timeOffset","<long>")
json.UpdateString("data.attributes.options.timezone","UTC")
json.UpdateString("data.attributes.page.cursor","<string>")
json.UpdateInt("data.attributes.page.limit",10)
json.UpdateString("data.attributes.sort","-timestamp")
json.UpdateString("data.type","search_request")

http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("Accept","application/json")

Dim resp As Chilkat.HttpResponse = http.PostJson3("https://api.app.ddog-gov.com/api/v2/spans/events/search","application/json",json)
If (http.LastMethodSuccess = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(resp.Header)
    Debug.WriteLine("Failed.")

    Exit Sub
End If



' 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



Dim End_timestamp As String
Dim Env As String
Dim Host As String
Dim Ingestion_reason As String
Dim Parent_id As String
Dim Resource_hash As String
Dim Resource_name As String
Dim Retained_by As String
Dim Service As String
Dim Single_span As String
Dim Span_id As String
Dim Start_timestamp As String
Dim Trace_id As String
Dim v_Type As String
Dim id As String
Dim v_type As String
Dim j As Integer
Dim count_j As Integer
Dim strVal As String
Dim code As String
Dim detail As String
Dim title As String

Dim v_Next As String = jResp.StringOf("links.next")
Dim Elapsed As String = jResp.StringOf("meta.elapsed")
Dim After As String = jResp.StringOf("meta.page.after")
Dim Request_id As String = jResp.StringOf("meta.request_id")
Dim Status As String = jResp.StringOf("meta.status")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("data")
While i < count_i
    jResp.I = i
    End_timestamp = jResp.StringOf("data[i].attributes.end_timestamp")
    Env = jResp.StringOf("data[i].attributes.env")
    Host = jResp.StringOf("data[i].attributes.host")
    Ingestion_reason = jResp.StringOf("data[i].attributes.ingestion_reason")
    Parent_id = jResp.StringOf("data[i].attributes.parent_id")
    Resource_hash = jResp.StringOf("data[i].attributes.resource_hash")
    Resource_name = jResp.StringOf("data[i].attributes.resource_name")
    Retained_by = jResp.StringOf("data[i].attributes.retained_by")
    Service = jResp.StringOf("data[i].attributes.service")
    Single_span = jResp.StringOf("data[i].attributes.single_span")
    Span_id = jResp.StringOf("data[i].attributes.span_id")
    Start_timestamp = jResp.StringOf("data[i].attributes.start_timestamp")
    Trace_id = jResp.StringOf("data[i].attributes.trace_id")
    v_Type = jResp.StringOf("data[i].attributes.type")
    id = jResp.StringOf("data[i].id")
    v_type = jResp.StringOf("data[i].type")
    j = 0
    count_j = jResp.SizeOfArray("data[i].attributes.tags")
    While j < count_j
        jResp.J = j
        strVal = jResp.StringOf("data[i].attributes.tags[j]")
        j = j + 1
    End While
    i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("meta.warnings")
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
End While

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "data": {
    "attributes": {
      "filter": {
        "from": "now-15m",
        "query": "*",
        "to": "now"
      },
      "options": {
        "timeOffset": "<long>",
        "timezone": "UTC"
      },
      "page": {
        "cursor": "<string>",
        "limit": 10
      },
      "sort": "-timestamp"
    },
    "type": "search_request"
  }
}'
https://api.app.ddog-gov.com/api/v2/spans/events/search

Postman Collection Item JSON

{
  "name": "Search spans",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"filter\": {\n        \"from\": \"now-15m\",\n        \"query\": \"*\",\n        \"to\": \"now\"\n      },\n      \"options\": {\n        \"timeOffset\": \"<long>\",\n        \"timezone\": \"UTC\"\n      },\n      \"page\": {\n        \"cursor\": \"<string>\",\n        \"limit\": 10\n      },\n      \"sort\": \"-timestamp\"\n    },\n    \"type\": \"search_request\"\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v2/spans/events/search",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "spans",
        "events",
        "search"
      ]
    },
    "description": "List endpoint returns spans that match a span search query.\n[Results are paginated][1].\n\nUse this endpoint to build complex spans filtering and search.\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": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"filter\": {\n        \"from\": \"now-15m\",\n        \"query\": \"*\",\n        \"to\": \"now\"\n      },\n      \"options\": {\n        \"timeOffset\": \"<long>\",\n        \"timezone\": \"UTC\"\n      },\n      \"page\": {\n        \"cursor\": \"<string>\",\n        \"limit\": 10\n      },\n      \"sort\": \"-timestamp\"\n    },\n    \"type\": \"search_request\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/spans/events/search",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "spans",
            "events",
            "search"
          ]
        }
      },
      "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": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"filter\": {\n        \"from\": \"now-15m\",\n        \"query\": \"*\",\n        \"to\": \"now\"\n      },\n      \"options\": {\n        \"timeOffset\": \"<long>\",\n        \"timezone\": \"UTC\"\n      },\n      \"page\": {\n        \"cursor\": \"<string>\",\n        \"limit\": 10\n      },\n      \"sort\": \"-timestamp\"\n    },\n    \"type\": \"search_request\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/spans/events/search",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "spans",
            "events",
            "search"
          ]
        }
      },
      "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": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"filter\": {\n        \"from\": \"now-15m\",\n        \"query\": \"*\",\n        \"to\": \"now\"\n      },\n      \"options\": {\n        \"timeOffset\": \"<long>\",\n        \"timezone\": \"UTC\"\n      },\n      \"page\": {\n        \"cursor\": \"<string>\",\n        \"limit\": 10\n      },\n      \"sort\": \"-timestamp\"\n    },\n    \"type\": \"search_request\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/spans/events/search",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "spans",
            "events",
            "search"
          ]
        }
      },
      "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": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"filter\": {\n        \"from\": \"now-15m\",\n        \"query\": \"*\",\n        \"to\": \"now\"\n      },\n      \"options\": {\n        \"timeOffset\": \"<long>\",\n        \"timezone\": \"UTC\"\n      },\n      \"page\": {\n        \"cursor\": \"<string>\",\n        \"limit\": 10\n      },\n      \"sort\": \"-timestamp\"\n    },\n    \"type\": \"search_request\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/spans/events/search",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "spans",
            "events",
            "search"
          ]
        }
      },
      "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": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"filter\": {\n        \"from\": \"now-15m\",\n        \"query\": \"*\",\n        \"to\": \"now\"\n      },\n      \"options\": {\n        \"timeOffset\": \"<long>\",\n        \"timezone\": \"UTC\"\n      },\n      \"page\": {\n        \"cursor\": \"<string>\",\n        \"limit\": 10\n      },\n      \"sort\": \"-timestamp\"\n    },\n    \"type\": \"search_request\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/spans/events/search",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "spans",
            "events",
            "search"
          ]
        }
      },
      "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}"
    }
  ]
}