Chilkat Online Tools

TCL / Datadog API Collection / Get an API test result

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

CkHttp_SetRequestHeader $http "Accept" "application/json"

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://api.app.ddog-gov.com/api/v1/synthetics/tests/:public_id/results/:result_id" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttp_lastHeader $http]
    puts "Failed."
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "check": {
#     "config": {
#       "configVariables": [
#         {
#           "description": "Example for the variable.",
#           "type": "string"
#         },
#         {
#           "description": "Example for the variable.",
#           "type": "string"
#         }
#       ],
#       "request": {
#         "allow_insecure": false,
#         "basicAuth": {
#           "password": "PaSSw0RD!",
#           "username": "my_username",
#           "type": "web"
#         },
#         "body": "proident",
#         "bodyType": "text/plain",
#         "callType": "unary",
#         "certificate": {
#           "cert": {
#             "content": "reprehenderit labore Ut sed mollit",
#             "filename": "Duis consectetur incididunt eiusmod",
#             "updatedAt": "aliquip in"
#           },
#           "key": {
#             "content": "consequat sint nulla aute aliquip",
#             "filename": "non nisi",
#             "updatedAt": "et"
#           }
#         },
#         "compressedJsonDescriptor": "dolore",
#         "dnsServer": "elit nostrud in adipisic",
#         "dnsServerPort": 60578,
#         "follow_redirects": false,
#         "headers": {
#           "proident_69": "quis dolor occaecat"
#         },
#         "host": "laborum laboris",
#         "message": "aliqua ea laborum laboris",
#         "metadata": {
#           "dolor_d": "veniam nostrud anim nulla",
#           "labore_7c6": "consequat eu",
#           "sed002": "Excepteur eiusmod adipisicing"
#         },
#         "method": "et irure",
#         "noSavingResponseBody": false,
#         "numberOfPackets": 9,
#         "persistCookies": false,
#         "port": 99104800,
#         "proxy": {
#           "url": "https://example.com",
#           "headers": {
#             "ead": "i"
#           }
#         },
#         "query": {},
#         "servername": "cillum enim adipisicing",
#         "service": "Greeter",
#         "shouldTrackHops": true,
#         "timeout": -43666416.92792323,
#         "url": "https://example.com"
#       },
#       "variables": [
#         {
#           "description": "Example for the variable.",
#           "type": "string"
#         },
#         {
#           "description": "Example for the variable.",
#           "type": "string"
#         }
#       ]
#     }
#   },
#   "check_time": -61984290.348021574,
#   "check_version": -35585398,
#   "probe_dc": "Duis aute",
#   "result": {
#     "cert": {
#       "cipher": "laborum dolore elit reprehenderit",
#       "exponent": -97057115.16341409,
#       "extKeyUsage": [
#         "e",
#         "non nulla"
#       ],
#       "fingerprint": "enim",
#       "fingerprint256": "commodo Duis elit culpa",
#       "issuer": {
#         "C": "id",
#         "CN": "dolor esse",
#         "L": "Lorem magna",
#         "O": "adipisicing ullamco",
#         "OU": "nostrud labore",
#         "ST": "proident consequat ut"
#       },
#       "modulus": "ut dolore cupidatat officia",
#       "protocol": "cillum dolor commodo sit",
#       "serialNumber": "velit",
#       "subject": {
#         "C": "aliquip ad voluptate",
#         "CN": "irure",
#         "L": "elit",
#         "O": "in",
#         "OU": "cillum dolor dolor aliquip nulla",
#         "ST": "mollit velit et",
#         "altName": "veniam eu mollit irure"
#       },
#       "validFrom": "1993-10-19T21:25:09.532Z",
#       "validTo": "2015-01-05T06:21:16.689Z"
#     },
#     "eventType": "finished_with_error",
#     "failure": {
#       "code": "DECRYPTION",
#       "message": "Error during DNS resolution (ENOTFOUND)."
#     },
#     "httpStatusCode": 81890255,
#     "requestHeaders": {
#       "Ut2": {},
#       "ad_29": {}
#     },
#     "responseBody": "Excepteur laboris Ut dolor",
#     "responseHeaders": {
#       "ut19b": {
#         "description": "Returned request header."
#       },
#       "Ut_270": {
#         "description": "Returned request header."
#       }
#     },
#     "responseSize": -51226186,
#     "timings": {
#       "dns": 31944439.48881416,
#       "download": -87539924.41719314,
#       "firstByte": -96589047.25818287,
#       "handshake": 84645232.54590705,
#       "redirect": -32741896.0310553,
#       "ssl": -93300794.33204812,
#       "tcp": 65643.03422442079,
#       "total": 82914630.9958055,
#       "wait": 29723058.510239527
#     }
#   },
#   "result_id": "culpa adipisicing consectetur sit",
#   "status": 1
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

set Allow_insecure [CkJsonObject_BoolOf $jResp "check.config.request.allow_insecure"]
set Password [CkJsonObject_stringOf $jResp "check.config.request.basicAuth.password"]
set Username [CkJsonObject_stringOf $jResp "check.config.request.basicAuth.username"]
set v_Type [CkJsonObject_stringOf $jResp "check.config.request.basicAuth.type"]
set Body [CkJsonObject_stringOf $jResp "check.config.request.body"]
set BodyType [CkJsonObject_stringOf $jResp "check.config.request.bodyType"]
set CallType [CkJsonObject_stringOf $jResp "check.config.request.callType"]
set Content [CkJsonObject_stringOf $jResp "check.config.request.certificate.cert.content"]
set Filename [CkJsonObject_stringOf $jResp "check.config.request.certificate.cert.filename"]
set UpdatedAt [CkJsonObject_stringOf $jResp "check.config.request.certificate.cert.updatedAt"]
set KeyContent [CkJsonObject_stringOf $jResp "check.config.request.certificate.key.content"]
set KeyFilename [CkJsonObject_stringOf $jResp "check.config.request.certificate.key.filename"]
set KeyUpdatedAt [CkJsonObject_stringOf $jResp "check.config.request.certificate.key.updatedAt"]
set CompressedJsonDescriptor [CkJsonObject_stringOf $jResp "check.config.request.compressedJsonDescriptor"]
set DnsServer [CkJsonObject_stringOf $jResp "check.config.request.dnsServer"]
set DnsServerPort [CkJsonObject_IntOf $jResp "check.config.request.dnsServerPort"]
set Follow_redirects [CkJsonObject_BoolOf $jResp "check.config.request.follow_redirects"]
set Proident_69 [CkJsonObject_stringOf $jResp "check.config.request.headers.proident_69"]
set Host [CkJsonObject_stringOf $jResp "check.config.request.host"]
set Message [CkJsonObject_stringOf $jResp "check.config.request.message"]
set Dolor_d [CkJsonObject_stringOf $jResp "check.config.request.metadata.dolor_d"]
set Labore_7c6 [CkJsonObject_stringOf $jResp "check.config.request.metadata.labore_7c6"]
set Sed002 [CkJsonObject_stringOf $jResp "check.config.request.metadata.sed002"]
set Method [CkJsonObject_stringOf $jResp "check.config.request.method"]
set NoSavingResponseBody [CkJsonObject_BoolOf $jResp "check.config.request.noSavingResponseBody"]
set NumberOfPackets [CkJsonObject_IntOf $jResp "check.config.request.numberOfPackets"]
set PersistCookies [CkJsonObject_BoolOf $jResp "check.config.request.persistCookies"]
set Port [CkJsonObject_IntOf $jResp "check.config.request.port"]
set v_Url [CkJsonObject_stringOf $jResp "check.config.request.proxy.url"]
set Ead [CkJsonObject_stringOf $jResp "check.config.request.proxy.headers.ead"]
set Servername [CkJsonObject_stringOf $jResp "check.config.request.servername"]
set Service [CkJsonObject_stringOf $jResp "check.config.request.service"]
set ShouldTrackHops [CkJsonObject_BoolOf $jResp "check.config.request.shouldTrackHops"]
set Timeout [CkJsonObject_stringOf $jResp "check.config.request.timeout"]
set RequestUrl [CkJsonObject_stringOf $jResp "check.config.request.url"]
set check_time [CkJsonObject_stringOf $jResp "check_time"]
set check_version [CkJsonObject_IntOf $jResp "check_version"]
set probe_dc [CkJsonObject_stringOf $jResp "probe_dc"]
set Cipher [CkJsonObject_stringOf $jResp "result.cert.cipher"]
set Exponent [CkJsonObject_stringOf $jResp "result.cert.exponent"]
set Fingerprint [CkJsonObject_stringOf $jResp "result.cert.fingerprint"]
set Fingerprint256 [CkJsonObject_stringOf $jResp "result.cert.fingerprint256"]
set C [CkJsonObject_stringOf $jResp "result.cert.issuer.C"]
set CN [CkJsonObject_stringOf $jResp "result.cert.issuer.CN"]
set L [CkJsonObject_stringOf $jResp "result.cert.issuer.L"]
set O [CkJsonObject_stringOf $jResp "result.cert.issuer.O"]
set OU [CkJsonObject_stringOf $jResp "result.cert.issuer.OU"]
set ST [CkJsonObject_stringOf $jResp "result.cert.issuer.ST"]
set Modulus [CkJsonObject_stringOf $jResp "result.cert.modulus"]
set Protocol [CkJsonObject_stringOf $jResp "result.cert.protocol"]
set SerialNumber [CkJsonObject_stringOf $jResp "result.cert.serialNumber"]
set SubjectC [CkJsonObject_stringOf $jResp "result.cert.subject.C"]
set SubjectCN [CkJsonObject_stringOf $jResp "result.cert.subject.CN"]
set SubjectL [CkJsonObject_stringOf $jResp "result.cert.subject.L"]
set SubjectO [CkJsonObject_stringOf $jResp "result.cert.subject.O"]
set SubjectOU [CkJsonObject_stringOf $jResp "result.cert.subject.OU"]
set SubjectST [CkJsonObject_stringOf $jResp "result.cert.subject.ST"]
set AltName [CkJsonObject_stringOf $jResp "result.cert.subject.altName"]
set ValidFrom [CkJsonObject_stringOf $jResp "result.cert.validFrom"]
set ValidTo [CkJsonObject_stringOf $jResp "result.cert.validTo"]
set EventType [CkJsonObject_stringOf $jResp "result.eventType"]
set Code [CkJsonObject_stringOf $jResp "result.failure.code"]
set FailureMessage [CkJsonObject_stringOf $jResp "result.failure.message"]
set HttpStatusCode [CkJsonObject_IntOf $jResp "result.httpStatusCode"]
set ResponseBody [CkJsonObject_stringOf $jResp "result.responseBody"]
set Description [CkJsonObject_stringOf $jResp "result.responseHeaders.ut19b.description"]
set Ut_270Description [CkJsonObject_stringOf $jResp "result.responseHeaders.Ut_270.description"]
set ResponseSize [CkJsonObject_IntOf $jResp "result.responseSize"]
set v_Dns [CkJsonObject_stringOf $jResp "result.timings.dns"]
set Download [CkJsonObject_stringOf $jResp "result.timings.download"]
set FirstByte [CkJsonObject_stringOf $jResp "result.timings.firstByte"]
set Handshake [CkJsonObject_stringOf $jResp "result.timings.handshake"]
set Redirect [CkJsonObject_stringOf $jResp "result.timings.redirect"]
set Ssl [CkJsonObject_stringOf $jResp "result.timings.ssl"]
set Tcp [CkJsonObject_stringOf $jResp "result.timings.tcp"]
set Total [CkJsonObject_stringOf $jResp "result.timings.total"]
set Wait [CkJsonObject_stringOf $jResp "result.timings.wait"]
set result_id [CkJsonObject_stringOf $jResp "result_id"]
set status [CkJsonObject_IntOf $jResp "status"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "check.config.configVariables"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set description [CkJsonObject_stringOf $jResp "check.config.configVariables[i].description"]
    set v_type [CkJsonObject_stringOf $jResp "check.config.configVariables[i].type"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "check.config.variables"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set description [CkJsonObject_stringOf $jResp "check.config.variables[i].description"]
    set v_type [CkJsonObject_stringOf $jResp "check.config.variables[i].type"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "result.cert.extKeyUsage"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set strVal [CkJsonObject_stringOf $jResp "result.cert.extKeyUsage[i]"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -X GET
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/synthetics/tests/:public_id/results/:result_id

Postman Collection Item JSON

{
  "name": "Get an API test result",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id/results/:result_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "synthetics",
        "tests",
        ":public_id",
        "results",
        ":result_id"
      ],
      "variable": [
        {
          "key": "public_id",
          "value": "tempor Ut sed velit"
        },
        {
          "key": "result_id",
          "value": "tempor Ut sed velit"
        }
      ]
    },
    "description": "Get a specific full result from a given Synthetic API test."
  },
  "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/v1/synthetics/tests/:public_id/results/:result_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "tests",
            ":public_id",
            "results",
            ":result_id"
          ],
          "variable": [
            {
              "key": "public_id"
            },
            {
              "key": "result_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"check\": {\n    \"config\": {\n      \"configVariables\": [\n        {\n          \"description\": \"Example for the variable.\",\n          \"type\": \"string\"\n        },\n        {\n          \"description\": \"Example for the variable.\",\n          \"type\": \"string\"\n        }\n      ],\n      \"request\": {\n        \"allow_insecure\": false,\n        \"basicAuth\": {\n          \"password\": \"PaSSw0RD!\",\n          \"username\": \"my_username\",\n          \"type\": \"web\"\n        },\n        \"body\": \"proident\",\n        \"bodyType\": \"text/plain\",\n        \"callType\": \"unary\",\n        \"certificate\": {\n          \"cert\": {\n            \"content\": \"reprehenderit labore Ut sed mollit\",\n            \"filename\": \"Duis consectetur incididunt eiusmod\",\n            \"updatedAt\": \"aliquip in\"\n          },\n          \"key\": {\n            \"content\": \"consequat sint nulla aute aliquip\",\n            \"filename\": \"non nisi\",\n            \"updatedAt\": \"et\"\n          }\n        },\n        \"compressedJsonDescriptor\": \"dolore\",\n        \"dnsServer\": \"elit nostrud in adipisic\",\n        \"dnsServerPort\": 60578,\n        \"follow_redirects\": false,\n        \"headers\": {\n          \"proident_69\": \"quis dolor occaecat\"\n        },\n        \"host\": \"laborum laboris\",\n        \"message\": \"aliqua ea laborum laboris\",\n        \"metadata\": {\n          \"dolor_d\": \"veniam nostrud anim nulla\",\n          \"labore_7c6\": \"consequat eu\",\n          \"sed002\": \"Excepteur eiusmod adipisicing\"\n        },\n        \"method\": \"et irure\",\n        \"noSavingResponseBody\": false,\n        \"numberOfPackets\": 9,\n        \"persistCookies\": false,\n        \"port\": 99104800,\n        \"proxy\": {\n          \"url\": \"https://example.com\",\n          \"headers\": {\n            \"ead\": \"i\"\n          }\n        },\n        \"query\": {},\n        \"servername\": \"cillum enim adipisicing\",\n        \"service\": \"Greeter\",\n        \"shouldTrackHops\": true,\n        \"timeout\": -43666416.92792323,\n        \"url\": \"https://example.com\"\n      },\n      \"variables\": [\n        {\n          \"description\": \"Example for the variable.\",\n          \"type\": \"string\"\n        },\n        {\n          \"description\": \"Example for the variable.\",\n          \"type\": \"string\"\n        }\n      ]\n    }\n  },\n  \"check_time\": -61984290.348021574,\n  \"check_version\": -35585398,\n  \"probe_dc\": \"Duis aute\",\n  \"result\": {\n    \"cert\": {\n      \"cipher\": \"laborum dolore elit reprehenderit\",\n      \"exponent\": -97057115.16341409,\n      \"extKeyUsage\": [\n        \"e\",\n        \"non nulla\"\n      ],\n      \"fingerprint\": \"enim\",\n      \"fingerprint256\": \"commodo Duis elit culpa\",\n      \"issuer\": {\n        \"C\": \"id\",\n        \"CN\": \"dolor esse\",\n        \"L\": \"Lorem magna\",\n        \"O\": \"adipisicing ullamco\",\n        \"OU\": \"nostrud labore\",\n        \"ST\": \"proident consequat ut\"\n      },\n      \"modulus\": \"ut dolore cupidatat officia\",\n      \"protocol\": \"cillum dolor commodo sit\",\n      \"serialNumber\": \"velit\",\n      \"subject\": {\n        \"C\": \"aliquip ad voluptate\",\n        \"CN\": \"irure\",\n        \"L\": \"elit\",\n        \"O\": \"in\",\n        \"OU\": \"cillum dolor dolor aliquip nulla\",\n        \"ST\": \"mollit velit et\",\n        \"altName\": \"veniam eu mollit irure\"\n      },\n      \"validFrom\": \"1993-10-19T21:25:09.532Z\",\n      \"validTo\": \"2015-01-05T06:21:16.689Z\"\n    },\n    \"eventType\": \"finished_with_error\",\n    \"failure\": {\n      \"code\": \"DECRYPTION\",\n      \"message\": \"Error during DNS resolution (ENOTFOUND).\"\n    },\n    \"httpStatusCode\": 81890255,\n    \"requestHeaders\": {\n      \"Ut2\": {},\n      \"ad_29\": {}\n    },\n    \"responseBody\": \"Excepteur laboris Ut dolor\",\n    \"responseHeaders\": {\n      \"ut19b\": {\n        \"description\": \"Returned request header.\"\n      },\n      \"Ut_270\": {\n        \"description\": \"Returned request header.\"\n      }\n    },\n    \"responseSize\": -51226186,\n    \"timings\": {\n      \"dns\": 31944439.48881416,\n      \"download\": -87539924.41719314,\n      \"firstByte\": -96589047.25818287,\n      \"handshake\": 84645232.54590705,\n      \"redirect\": -32741896.0310553,\n      \"ssl\": -93300794.33204812,\n      \"tcp\": 65643.03422442079,\n      \"total\": 82914630.9958055,\n      \"wait\": 29723058.510239527\n    }\n  },\n  \"result_id\": \"culpa adipisicing consectetur sit\",\n  \"status\": 1\n}"
    },
    {
      "name": "Forbidden",
      "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/v1/synthetics/tests/:public_id/results/:result_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "tests",
            ":public_id",
            "results",
            ":result_id"
          ],
          "variable": [
            {
              "key": "public_id"
            },
            {
              "key": "result_id"
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    },
    {
      "name": "- Synthetic Monitoring is not activated for the user\n- Test or result is not owned by the user",
      "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/v1/synthetics/tests/:public_id/results/:result_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "tests",
            ":public_id",
            "results",
            ":result_id"
          ],
          "variable": [
            {
              "key": "public_id"
            },
            {
              "key": "result_id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\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/v1/synthetics/tests/:public_id/results/:result_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "tests",
            ":public_id",
            "results",
            ":result_id"
          ],
          "variable": [
            {
              "key": "public_id"
            },
            {
              "key": "result_id"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    }
  ]
}