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]
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateString $queryParams "ids" "id1, id2, id3"
CkJsonObject_UpdateString $queryParams "query" "monitor"
CkJsonObject_UpdateString $queryParams "tags_query" "env:prod"
CkJsonObject_UpdateString $queryParams "metrics_query" "aws.elb.request_count"
CkJsonObject_UpdateInt $queryParams "limit" -62147425
CkJsonObject_UpdateInt $queryParams "offset" -62147425
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://api.app.ddog-gov.com/api/v1/slo" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "data": [
# {
# "name": "Custom Metric SLO",
# "thresholds": [
# {
# "target": 95,
# "timeframe": "7d"
# },
# {
# "target": 95,
# "timeframe": "30d",
# "warning": 97
# }
# ],
# "type": "metric",
# "created_at": -94400396,
# "creator": {
# "email": "esse ullamco",
# "handle": "pariatur irure sit non",
# "name": "in proident laborum"
# },
# "description": "est proident magna reprehenderit",
# "groups": [
# "env:prod",
# "role:mysql"
# ],
# "id": "ipsum laboris consequat",
# "modified_at": -34908193,
# "monitor_ids": [
# 35412081,
# -51315393
# ],
# "monitor_tags": [
# "voluptate adipisicing fugiat elit",
# "reprehenderit et nostrud pariatur Excepteur"
# ],
# "query": {
# "numerator": "sum:my.custom.metric{type:good}.as_count()",
# "denominator": "sum:my.custom.metric{*}.as_count()"
# },
# "tags": [
# "env:prod",
# "app:core"
# ],
# "target_threshold": 99.9,
# "timeframe": "30d",
# "warning_threshold": 99.95
# },
# {
# "name": "Custom Metric SLO",
# "thresholds": [
# {
# "target": 95,
# "timeframe": "7d"
# },
# {
# "target": 95,
# "timeframe": "30d",
# "warning": 97
# }
# ],
# "type": "metric",
# "created_at": -83055437,
# "creator": {
# "email": "exercitation",
# "handle": "commodo aute incididunt ut",
# "name": "Lorem dolor irure"
# },
# "description": "do nostrud ex sit",
# "groups": [
# "env:prod",
# "role:mysql"
# ],
# "id": "ut elit commodo",
# "modified_at": -65512371,
# "monitor_ids": [
# 70922825,
# -10561601
# ],
# "monitor_tags": [
# "laborum aliqua proident",
# "ullamco cillum ea consectetur"
# ],
# "query": {
# "numerator": "sum:my.custom.metric{type:good}.as_count()",
# "denominator": "sum:my.custom.metric{*}.as_count()"
# },
# "tags": [
# "env:prod",
# "app:core"
# ],
# "target_threshold": 99.9,
# "timeframe": "30d",
# "warning_threshold": 99.95
# }
# ],
# "errors": [
# "deserunt in fugiat",
# "proident"
# ],
# "metadata": {
# "page": {
# "total_count": 69715777,
# "total_filtered_count": -16033264
# }
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set Total_count [CkJsonObject_IntOf $jResp "metadata.page.total_count"]
set Total_filtered_count [CkJsonObject_IntOf $jResp "metadata.page.total_filtered_count"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "data"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set name [CkJsonObject_stringOf $jResp "data[i].name"]
set v_type [CkJsonObject_stringOf $jResp "data[i].type"]
set created_at [CkJsonObject_IntOf $jResp "data[i].created_at"]
set v_Email [CkJsonObject_stringOf $jResp "data[i].creator.email"]
set Handle [CkJsonObject_stringOf $jResp "data[i].creator.handle"]
set Name [CkJsonObject_stringOf $jResp "data[i].creator.name"]
set description [CkJsonObject_stringOf $jResp "data[i].description"]
set id [CkJsonObject_stringOf $jResp "data[i].id"]
set modified_at [CkJsonObject_IntOf $jResp "data[i].modified_at"]
set Numerator [CkJsonObject_stringOf $jResp "data[i].query.numerator"]
set Denominator [CkJsonObject_stringOf $jResp "data[i].query.denominator"]
set target_threshold [CkJsonObject_stringOf $jResp "data[i].target_threshold"]
set timeframe [CkJsonObject_stringOf $jResp "data[i].timeframe"]
set warning_threshold [CkJsonObject_stringOf $jResp "data[i].warning_threshold"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "data[i].thresholds"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set target [CkJsonObject_IntOf $jResp "data[i].thresholds[j].target"]
set timeframe [CkJsonObject_stringOf $jResp "data[i].thresholds[j].timeframe"]
set warning [CkJsonObject_IntOf $jResp "data[i].thresholds[j].warning"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "data[i].groups"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set strVal [CkJsonObject_stringOf $jResp "data[i].groups[j]"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "data[i].monitor_ids"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set intVal [CkJsonObject_IntOf $jResp "data[i].monitor_ids[j]"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "data[i].monitor_tags"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set strVal [CkJsonObject_stringOf $jResp "data[i].monitor_tags[j]"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "data[i].tags"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set strVal [CkJsonObject_stringOf $jResp "data[i].tags[j]"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "errors"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set strVal [CkJsonObject_stringOf $jResp "errors[i]"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -G -d "ids=id1,%20id2,%20id3"
-d "query=monitor"
-d "tags_query=env%3Aprod"
-d "metrics_query=aws.elb.request_count"
-d "limit=-62147425"
-d "offset=-62147425"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/slo
Postman Collection Item JSON
{
"name": "Get all SLOs",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/slo?ids=id1, id2, id3&query=monitor&tags_query=env:prod&metrics_query=aws.elb.request_count&limit=-62147425&offset=-62147425",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo"
],
"query": [
{
"key": "ids",
"value": "id1, id2, id3",
"description": "A comma separated list of the IDs of the service level objectives objects."
},
{
"key": "query",
"value": "monitor",
"description": "The query string to filter results based on SLO names."
},
{
"key": "tags_query",
"value": "env:prod",
"description": "The query string to filter results based on a single SLO tag."
},
{
"key": "metrics_query",
"value": "aws.elb.request_count",
"description": "The query string to filter results based on SLO numerator and denominator."
},
{
"key": "limit",
"value": "-62147425",
"description": "The number of SLOs to return in the response."
},
{
"key": "offset",
"value": "-62147425",
"description": "The specific offset to use as the beginning of the returned response."
}
]
},
"description": "Get a list of service level objective objects for your organization."
},
"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/slo?ids=id1, id2, id3&query=monitor&tags_query=env:prod&metrics_query=aws.elb.request_count&limit=-62147425&offset=-62147425",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo"
],
"query": [
{
"key": "ids",
"value": "id1, id2, id3",
"description": "A comma separated list of the IDs of the service level objectives objects."
},
{
"key": "query",
"value": "monitor",
"description": "The query string to filter results based on SLO names."
},
{
"key": "tags_query",
"value": "env:prod",
"description": "The query string to filter results based on a single SLO tag."
},
{
"key": "metrics_query",
"value": "aws.elb.request_count",
"description": "The query string to filter results based on SLO numerator and denominator."
},
{
"key": "limit",
"value": "-62147425",
"description": "The number of SLOs to return in the response."
},
{
"key": "offset",
"value": "-62147425",
"description": "The specific offset to use as the beginning of the returned response."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"name\": \"Custom Metric SLO\",\n \"thresholds\": [\n {\n \"target\": 95,\n \"timeframe\": \"7d\"\n },\n {\n \"target\": 95,\n \"timeframe\": \"30d\",\n \"warning\": 97\n }\n ],\n \"type\": \"metric\",\n \"created_at\": -94400396,\n \"creator\": {\n \"email\": \"esse ullamco\",\n \"handle\": \"pariatur irure sit non\",\n \"name\": \"in proident laborum\"\n },\n \"description\": \"est proident magna reprehenderit\",\n \"groups\": [\n \"env:prod\",\n \"role:mysql\"\n ],\n \"id\": \"ipsum laboris consequat\",\n \"modified_at\": -34908193,\n \"monitor_ids\": [\n 35412081,\n -51315393\n ],\n \"monitor_tags\": [\n \"voluptate adipisicing fugiat elit\",\n \"reprehenderit et nostrud pariatur Excepteur\"\n ],\n \"query\": {\n \"numerator\": \"sum:my.custom.metric{type:good}.as_count()\",\n \"denominator\": \"sum:my.custom.metric{*}.as_count()\"\n },\n \"tags\": [\n \"env:prod\",\n \"app:core\"\n ],\n \"target_threshold\": 99.9,\n \"timeframe\": \"30d\",\n \"warning_threshold\": 99.95\n },\n {\n \"name\": \"Custom Metric SLO\",\n \"thresholds\": [\n {\n \"target\": 95,\n \"timeframe\": \"7d\"\n },\n {\n \"target\": 95,\n \"timeframe\": \"30d\",\n \"warning\": 97\n }\n ],\n \"type\": \"metric\",\n \"created_at\": -83055437,\n \"creator\": {\n \"email\": \"exercitation\",\n \"handle\": \"commodo aute incididunt ut\",\n \"name\": \"Lorem dolor irure\"\n },\n \"description\": \"do nostrud ex sit\",\n \"groups\": [\n \"env:prod\",\n \"role:mysql\"\n ],\n \"id\": \"ut elit commodo\",\n \"modified_at\": -65512371,\n \"monitor_ids\": [\n 70922825,\n -10561601\n ],\n \"monitor_tags\": [\n \"laborum aliqua proident\",\n \"ullamco cillum ea consectetur\"\n ],\n \"query\": {\n \"numerator\": \"sum:my.custom.metric{type:good}.as_count()\",\n \"denominator\": \"sum:my.custom.metric{*}.as_count()\"\n },\n \"tags\": [\n \"env:prod\",\n \"app:core\"\n ],\n \"target_threshold\": 99.9,\n \"timeframe\": \"30d\",\n \"warning_threshold\": 99.95\n }\n ],\n \"errors\": [\n \"deserunt in fugiat\",\n \"proident\"\n ],\n \"metadata\": {\n \"page\": {\n \"total_count\": 69715777,\n \"total_filtered_count\": -16033264\n }\n }\n}"
},
{
"name": "Bad Request",
"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/slo?ids=id1, id2, id3&query=monitor&tags_query=env:prod&metrics_query=aws.elb.request_count&limit=-62147425&offset=-62147425",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo"
],
"query": [
{
"key": "ids",
"value": "id1, id2, id3",
"description": "A comma separated list of the IDs of the service level objectives objects."
},
{
"key": "query",
"value": "monitor",
"description": "The query string to filter results based on SLO names."
},
{
"key": "tags_query",
"value": "env:prod",
"description": "The query string to filter results based on a single SLO tag."
},
{
"key": "metrics_query",
"value": "aws.elb.request_count",
"description": "The query string to filter results based on SLO numerator and denominator."
},
{
"key": "limit",
"value": "-62147425",
"description": "The number of SLOs to return in the response."
},
{
"key": "offset",
"value": "-62147425",
"description": "The specific offset to use as the beginning of the returned response."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\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/slo?ids=id1, id2, id3&query=monitor&tags_query=env:prod&metrics_query=aws.elb.request_count&limit=-62147425&offset=-62147425",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo"
],
"query": [
{
"key": "ids",
"value": "id1, id2, id3",
"description": "A comma separated list of the IDs of the service level objectives objects."
},
{
"key": "query",
"value": "monitor",
"description": "The query string to filter results based on SLO names."
},
{
"key": "tags_query",
"value": "env:prod",
"description": "The query string to filter results based on a single SLO tag."
},
{
"key": "metrics_query",
"value": "aws.elb.request_count",
"description": "The query string to filter results based on SLO numerator and denominator."
},
{
"key": "limit",
"value": "-62147425",
"description": "The number of SLOs to return in the response."
},
{
"key": "offset",
"value": "-62147425",
"description": "The specific offset to use as the beginning of the returned response."
}
]
}
},
"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": "Not Found",
"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/slo?ids=id1, id2, id3&query=monitor&tags_query=env:prod&metrics_query=aws.elb.request_count&limit=-62147425&offset=-62147425",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo"
],
"query": [
{
"key": "ids",
"value": "id1, id2, id3",
"description": "A comma separated list of the IDs of the service level objectives objects."
},
{
"key": "query",
"value": "monitor",
"description": "The query string to filter results based on SLO names."
},
{
"key": "tags_query",
"value": "env:prod",
"description": "The query string to filter results based on a single SLO tag."
},
{
"key": "metrics_query",
"value": "aws.elb.request_count",
"description": "The query string to filter results based on SLO numerator and denominator."
},
{
"key": "limit",
"value": "-62147425",
"description": "The number of SLOs to return in the response."
},
{
"key": "offset",
"value": "-62147425",
"description": "The specific offset to use as the beginning of the returned response."
}
]
}
},
"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/slo?ids=id1, id2, id3&query=monitor&tags_query=env:prod&metrics_query=aws.elb.request_count&limit=-62147425&offset=-62147425",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo"
],
"query": [
{
"key": "ids",
"value": "id1, id2, id3",
"description": "A comma separated list of the IDs of the service level objectives objects."
},
{
"key": "query",
"value": "monitor",
"description": "The query string to filter results based on SLO names."
},
{
"key": "tags_query",
"value": "env:prod",
"description": "The query string to filter results based on a single SLO tag."
},
{
"key": "metrics_query",
"value": "aws.elb.request_count",
"description": "The query string to filter results based on SLO numerator and denominator."
},
{
"key": "limit",
"value": "-62147425",
"description": "The number of SLOs to return in the response."
},
{
"key": "offset",
"value": "-62147425",
"description": "The specific offset to use as the beginning of the returned response."
}
]
}
},
"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}"
}
]
}
