SQL Server / Datadog API Collection / Get an API 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/: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": -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
DECLARE @check_time nvarchar(4000)
DECLARE @probe_dc nvarchar(4000)
DECLARE @Passed int
DECLARE @v_Dns nvarchar(4000)
DECLARE @Download nvarchar(4000)
DECLARE @FirstByte nvarchar(4000)
DECLARE @Handshake nvarchar(4000)
DECLARE @Redirect nvarchar(4000)
DECLARE @Ssl nvarchar(4000)
DECLARE @Tcp nvarchar(4000)
DECLARE @Total nvarchar(4000)
DECLARE @Wait nvarchar(4000)
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, 'BoolOf', @Passed OUT, 'results[i].result.passed'
EXEC sp_OAMethod @jResp, 'StringOf', @v_Dns OUT, 'results[i].result.timings.dns'
EXEC sp_OAMethod @jResp, 'StringOf', @Download OUT, 'results[i].result.timings.download'
EXEC sp_OAMethod @jResp, 'StringOf', @FirstByte OUT, 'results[i].result.timings.firstByte'
EXEC sp_OAMethod @jResp, 'StringOf', @Handshake OUT, 'results[i].result.timings.handshake'
EXEC sp_OAMethod @jResp, 'StringOf', @Redirect OUT, 'results[i].result.timings.redirect'
EXEC sp_OAMethod @jResp, 'StringOf', @Ssl OUT, 'results[i].result.timings.ssl'
EXEC sp_OAMethod @jResp, 'StringOf', @Tcp OUT, 'results[i].result.timings.tcp'
EXEC sp_OAMethod @jResp, 'StringOf', @Total OUT, 'results[i].result.timings.total'
EXEC sp_OAMethod @jResp, 'StringOf', @Wait OUT, 'results[i].result.timings.wait'
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/: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}"
}
]
}