Chilkat Online Tools

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

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    DECLARE @queryParams int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @queryParams OUT

    EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'from_ts', -62147425
    EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'to_ts', -62147425
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'probe_dc', 'dolor cillum in'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'probe_dc', 'proident'

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://api.app.ddog-gov.com/api/v1/synthetics/tests/browser/:public_id/results', @queryParams
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @queryParams
        RETURN
      END

    DECLARE @sbResponseBody int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT

    EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody

    DECLARE @jResp int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT

    EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
    EXEC sp_OASetProperty @jResp, 'EmitCompact', 0


    PRINT 'Response Body:'
    EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    DECLARE @respStatusCode int
    EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT

    PRINT 'Response Status Code = ' + @respStatusCode
    IF @respStatusCode >= 400
      BEGIN

        PRINT 'Response Header:'
        EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Failed.'
        EXEC @hr = sp_OADestroy @resp

        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @queryParams
        EXEC @hr = sp_OADestroy @sbResponseBody
        EXEC @hr = sp_OADestroy @jResp
        RETURN
      END
    EXEC @hr = sp_OADestroy @resp

    -- 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

    DECLARE @check_time nvarchar(4000)

    DECLARE @probe_dc nvarchar(4000)

    DECLARE @Id nvarchar(4000)

    DECLARE @Name nvarchar(4000)

    DECLARE @Height int

    DECLARE @Width int

    DECLARE @IsMobile int

    DECLARE @Duration nvarchar(4000)

    DECLARE @ErrorCount int

    DECLARE @StepCountCompleted int

    DECLARE @StepCountTotal int

    DECLARE @result_id nvarchar(4000)

    DECLARE @status int

    DECLARE @last_timestamp_fetched int
    EXEC sp_OAMethod @jResp, 'IntOf', @last_timestamp_fetched OUT, 'last_timestamp_fetched'
    DECLARE @i int
    SELECT @i = 0
    DECLARE @count_i int
    EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'results'
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OASetProperty @jResp, 'I', @i
        EXEC sp_OAMethod @jResp, 'StringOf', @check_time OUT, 'results[i].check_time'
        EXEC sp_OAMethod @jResp, 'StringOf', @probe_dc OUT, 'results[i].probe_dc'
        EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'results[i].result.device.id'
        EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'results[i].result.device.name'
        EXEC sp_OAMethod @jResp, 'IntOf', @Height OUT, 'results[i].result.device.height'
        EXEC sp_OAMethod @jResp, 'IntOf', @Width OUT, 'results[i].result.device.width'
        EXEC sp_OAMethod @jResp, 'BoolOf', @IsMobile OUT, 'results[i].result.device.isMobile'
        EXEC sp_OAMethod @jResp, 'StringOf', @Duration OUT, 'results[i].result.duration'
        EXEC sp_OAMethod @jResp, 'IntOf', @ErrorCount OUT, 'results[i].result.errorCount'
        EXEC sp_OAMethod @jResp, 'IntOf', @StepCountCompleted OUT, 'results[i].result.stepCountCompleted'
        EXEC sp_OAMethod @jResp, 'IntOf', @StepCountTotal OUT, 'results[i].result.stepCountTotal'
        EXEC sp_OAMethod @jResp, 'StringOf', @result_id OUT, 'results[i].result_id'
        EXEC sp_OAMethod @jResp, 'IntOf', @status OUT, 'results[i].status'
        SELECT @i = @i + 1
      END

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @queryParams
    EXEC @hr = sp_OADestroy @sbResponseBody
    EXEC @hr = sp_OADestroy @jResp


END
GO

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}"
    }
  ]
}