Chilkat Online Tools

Foxpro / Datadog API Collection / Get an API test's latest results summaries

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcCheck_time
LOCAL lcProbe_dc
LOCAL lnPassed
LOCAL lcV_Dns
LOCAL lcDownload
LOCAL lcFirstByte
LOCAL lcHandshake
LOCAL lcRedirect
LOCAL lcSsl
LOCAL lcTcp
LOCAL lcTotal
LOCAL lcWait
LOCAL lcResult_id
LOCAL lnStatus
LOCAL lnLast_timestamp_fetched
LOCAL i
LOCAL lnCount_i

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateInt("from_ts",-62147425)
loQueryParams.UpdateInt("to_ts",-62147425)
loQueryParams.UpdateString("probe_dc","dolor cillum in")
loQueryParams.UpdateString("probe_dc","proident")

loHttp.SetRequestHeader("Accept","application/json")

loResp = loHttp.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v1/synthetics/tests/:public_id/results",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loQueryParams
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loQueryParams
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

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

* {
*   "last_timestamp_fetched": -96513461,
*   "results": [
*     {
*       "check_time": -32755115.034457833,
*       "probe_dc": "ex aliquip elit",
*       "result": {
*         "passed": false,
*         "timings": {
*           "dns": -97211663.12516338,
*           "download": 69787304.59130791,
*           "firstByte": 7063435.657899752,
*           "handshake": 58647320.32120216,
*           "redirect": -39297333.858247004,
*           "ssl": 39645260.31412804,
*           "tcp": 20665973.93464838,
*           "total": 20845012.956068933,
*           "wait": -39822886.67901743
*         }
*       },
*       "result_id": "ipsum in",
*       "status": 0
*     },
*     {
*       "check_time": -45161819.38632564,
*       "probe_dc": "esse ipsum pariatur do et",
*       "result": {
*         "passed": true,
*         "timings": {
*           "dns": -36593755.469836965,
*           "download": 12698868.215193078,
*           "firstByte": 33271607.027867228,
*           "handshake": -31538483.54689482,
*           "redirect": -78495392.91587453,
*           "ssl": 64556481.18909925,
*           "tcp": -77981358.8267188,
*           "total": 41359471.650199294,
*           "wait": 38487717.98797688
*         }
*       },
*       "result_id": "commodo adipisicing in exercitation",
*       "status": 2
*     }
*   ]
* }

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

lnLast_timestamp_fetched = loJResp.IntOf("last_timestamp_fetched")
i = 0
lnCount_i = loJResp.SizeOfArray("results")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcCheck_time = loJResp.StringOf("results[i].check_time")
    lcProbe_dc = loJResp.StringOf("results[i].probe_dc")
    lnPassed = loJResp.BoolOf("results[i].result.passed")
    lcV_Dns = loJResp.StringOf("results[i].result.timings.dns")
    lcDownload = loJResp.StringOf("results[i].result.timings.download")
    lcFirstByte = loJResp.StringOf("results[i].result.timings.firstByte")
    lcHandshake = loJResp.StringOf("results[i].result.timings.handshake")
    lcRedirect = loJResp.StringOf("results[i].result.timings.redirect")
    lcSsl = loJResp.StringOf("results[i].result.timings.ssl")
    lcTcp = loJResp.StringOf("results[i].result.timings.tcp")
    lcTotal = loJResp.StringOf("results[i].result.timings.total")
    lcWait = loJResp.StringOf("results[i].result.timings.wait")
    lcResult_id = loJResp.StringOf("results[i].result_id")
    lnStatus = loJResp.IntOf("results[i].status")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

curl -G -d "from_ts=-62147425"
	-d "to_ts=-62147425"
	-d "probe_dc=dolor%20cillum%20in"
	-d "probe_dc=proident"
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/synthetics/tests/:public_id/results

Postman Collection Item JSON

{
  "name": "Get an API test's latest results summaries",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/synthetics/tests/:public_id/results?from_ts=-62147425&to_ts=-62147425&probe_dc=dolor cillum in&probe_dc=proident",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "synthetics",
        "tests",
        ":public_id",
        "results"
      ],
      "query": [
        {
          "key": "from_ts",
          "value": "-62147425",
          "description": "Timestamp in milliseconds from which to start querying results."
        },
        {
          "key": "to_ts",
          "value": "-62147425",
          "description": "Timestamp in milliseconds up to which to query results."
        },
        {
          "key": "probe_dc",
          "value": "dolor cillum in",
          "description": "Locations for which to query results."
        },
        {
          "key": "probe_dc",
          "value": "proident",
          "description": "Locations for which to query results."
        }
      ],
      "variable": [
        {
          "key": "public_id",
          "value": "tempor Ut sed velit"
        }
      ]
    },
    "description": "Get the last 150 test results summaries for 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?from_ts=-62147425&to_ts=-62147425&probe_dc=proident",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "tests",
            ":public_id",
            "results"
          ],
          "query": [
            {
              "key": "from_ts",
              "value": "-62147425",
              "description": "Timestamp in milliseconds from which to start querying results."
            },
            {
              "key": "to_ts",
              "value": "-62147425",
              "description": "Timestamp in milliseconds up to which to query results."
            },
            {
              "key": "probe_dc",
              "value": "proident",
              "description": "Locations for which to query results."
            }
          ],
          "variable": [
            {
              "key": "public_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"last_timestamp_fetched\": -96513461,\n  \"results\": [\n    {\n      \"check_time\": -32755115.034457833,\n      \"probe_dc\": \"ex aliquip elit\",\n      \"result\": {\n        \"passed\": false,\n        \"timings\": {\n          \"dns\": -97211663.12516338,\n          \"download\": 69787304.59130791,\n          \"firstByte\": 7063435.657899752,\n          \"handshake\": 58647320.32120216,\n          \"redirect\": -39297333.858247004,\n          \"ssl\": 39645260.31412804,\n          \"tcp\": 20665973.93464838,\n          \"total\": 20845012.956068933,\n          \"wait\": -39822886.67901743\n        }\n      },\n      \"result_id\": \"ipsum in\",\n      \"status\": 0\n    },\n    {\n      \"check_time\": -45161819.38632564,\n      \"probe_dc\": \"esse ipsum pariatur do et\",\n      \"result\": {\n        \"passed\": true,\n        \"timings\": {\n          \"dns\": -36593755.469836965,\n          \"download\": 12698868.215193078,\n          \"firstByte\": 33271607.027867228,\n          \"handshake\": -31538483.54689482,\n          \"redirect\": -78495392.91587453,\n          \"ssl\": 64556481.18909925,\n          \"tcp\": -77981358.8267188,\n          \"total\": 41359471.650199294,\n          \"wait\": 38487717.98797688\n        }\n      },\n      \"result_id\": \"commodo adipisicing in exercitation\",\n      \"status\": 2\n    }\n  ]\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?from_ts=-62147425&to_ts=-62147425&probe_dc=proident",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "tests",
            ":public_id",
            "results"
          ],
          "query": [
            {
              "key": "from_ts",
              "value": "-62147425",
              "description": "Timestamp in milliseconds from which to start querying results."
            },
            {
              "key": "to_ts",
              "value": "-62147425",
              "description": "Timestamp in milliseconds up to which to query results."
            },
            {
              "key": "probe_dc",
              "value": "proident",
              "description": "Locations for which to query results."
            }
          ],
          "variable": [
            {
              "key": "public_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 is not activated for the user\n- Test 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?from_ts=-62147425&to_ts=-62147425&probe_dc=proident",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "tests",
            ":public_id",
            "results"
          ],
          "query": [
            {
              "key": "from_ts",
              "value": "-62147425",
              "description": "Timestamp in milliseconds from which to start querying results."
            },
            {
              "key": "to_ts",
              "value": "-62147425",
              "description": "Timestamp in milliseconds up to which to query results."
            },
            {
              "key": "probe_dc",
              "value": "proident",
              "description": "Locations for which to query results."
            }
          ],
          "variable": [
            {
              "key": "public_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?from_ts=-62147425&to_ts=-62147425&probe_dc=proident",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "tests",
            ":public_id",
            "results"
          ],
          "query": [
            {
              "key": "from_ts",
              "value": "-62147425",
              "description": "Timestamp in milliseconds from which to start querying results."
            },
            {
              "key": "to_ts",
              "value": "-62147425",
              "description": "Timestamp in milliseconds up to which to query results."
            },
            {
              "key": "probe_dc",
              "value": "proident",
              "description": "Locations for which to query results."
            }
          ],
          "variable": [
            {
              "key": "public_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}"
    }
  ]
}