Chilkat Online Tools

autoit / Datadog API Collection / Get a browser test's latest results summaries

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateInt("from_ts",-62147425)
$oQueryParams.UpdateInt("to_ts",-62147425)
$oQueryParams.UpdateString("probe_dc","dolor cillum in")
$oQueryParams.UpdateString("probe_dc","proident")

$oHttp.SetRequestHeader "Accept","application/json"

Local $oResp = $oHttp.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v1/synthetics/tests/browser/:public_id/results",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

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

; {
;   "last_timestamp_fetched": 65993172,
;   "results": [
;     {
;       "check_time": -9878780.847290918,
;       "probe_dc": "i",
;       "result": {
;         "device": {
;           "id": "laptop_large",
;           "name": "",
;           "height": 0,
;           "width": 0,
;           "isMobile": true
;         },
;         "duration": 65442267.72030264,
;         "errorCount": 64702081,
;         "stepCountCompleted": -72535032,
;         "stepCountTotal": 82995949
;       },
;       "result_id": "labore",
;       "status": 2
;     },
;     {
;       "check_time": -2600599.1306800246,
;       "probe_dc": "ex et tempor",
;       "result": {
;         "device": {
;           "id": "laptop_large",
;           "name": "",
;           "height": 0,
;           "width": 0,
;           "isMobile": false
;         },
;         "duration": 61853655.027596265,
;         "errorCount": -10809730,
;         "stepCountCompleted": 76168853,
;         "stepCountTotal": 95663724
;       },
;       "result_id": "occaecat",
;       "status": 1
;     }
;   ]
; }

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

Local $sCheck_time
Local $sProbe_dc
Local $sId
Local $sName
Local $iHeight
Local $iWidth
Local $bIsMobile
Local $sDuration
Local $iErrorCount
Local $iStepCountCompleted
Local $iStepCountTotal
Local $sResult_id
Local $iStatus

Local $iLast_timestamp_fetched = $oJResp.IntOf("last_timestamp_fetched")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("results")
While $i < $iCount_i
    $oJResp.I = $i
    $sCheck_time = $oJResp.StringOf("results[i].check_time")
    $sProbe_dc = $oJResp.StringOf("results[i].probe_dc")
    $sId = $oJResp.StringOf("results[i].result.device.id")
    $sName = $oJResp.StringOf("results[i].result.device.name")
    $iHeight = $oJResp.IntOf("results[i].result.device.height")
    $iWidth = $oJResp.IntOf("results[i].result.device.width")
    $bIsMobile = $oJResp.BoolOf("results[i].result.device.isMobile")
    $sDuration = $oJResp.StringOf("results[i].result.duration")
    $iErrorCount = $oJResp.IntOf("results[i].result.errorCount")
    $iStepCountCompleted = $oJResp.IntOf("results[i].result.stepCountCompleted")
    $iStepCountTotal = $oJResp.IntOf("results[i].result.stepCountTotal")
    $sResult_id = $oJResp.StringOf("results[i].result_id")
    $iStatus = $oJResp.IntOf("results[i].status")
    $i = $i + 1
Wend

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/browser/:public_id/results

Postman Collection Item JSON

{
  "name": "Get a browser test's latest results summaries",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/synthetics/tests/browser/:public_id/results?from_ts=-62147425&to_ts=-62147425&probe_dc=dolor cillum in&probe_dc=proident",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "synthetics",
        "tests",
        "browser",
        ":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 browser 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/browser/:public_id/results?from_ts=-62147425&to_ts=-62147425&probe_dc=proident",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "tests",
            "browser",
            ":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\": 65993172,\n  \"results\": [\n    {\n      \"check_time\": -9878780.847290918,\n      \"probe_dc\": \"i\",\n      \"result\": {\n        \"device\": {\n          \"id\": \"laptop_large\",\n          \"name\": \"\",\n          \"height\": 0,\n          \"width\": 0,\n          \"isMobile\": true\n        },\n        \"duration\": 65442267.72030264,\n        \"errorCount\": 64702081,\n        \"stepCountCompleted\": -72535032,\n        \"stepCountTotal\": 82995949\n      },\n      \"result_id\": \"labore\",\n      \"status\": 2\n    },\n    {\n      \"check_time\": -2600599.1306800246,\n      \"probe_dc\": \"ex et tempor\",\n      \"result\": {\n        \"device\": {\n          \"id\": \"laptop_large\",\n          \"name\": \"\",\n          \"height\": 0,\n          \"width\": 0,\n          \"isMobile\": false\n        },\n        \"duration\": 61853655.027596265,\n        \"errorCount\": -10809730,\n        \"stepCountCompleted\": 76168853,\n        \"stepCountTotal\": 95663724\n      },\n      \"result_id\": \"occaecat\",\n      \"status\": 1\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/browser/:public_id/results?from_ts=-62147425&to_ts=-62147425&probe_dc=proident",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "tests",
            "browser",
            ":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 Monitoring 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/browser/:public_id/results?from_ts=-62147425&to_ts=-62147425&probe_dc=proident",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "tests",
            "browser",
            ":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/browser/:public_id/results?from_ts=-62147425&to_ts=-62147425&probe_dc=proident",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "synthetics",
            "tests",
            "browser",
            ":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}"
    }
  ]
}