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_9_5_0.Http")
Local $bSuccess
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "name": "Custom Metric SLO",
; "thresholds": [
; {
; "target": 95,
; "timeframe": "7d"
; },
; {
; "target": 95,
; "timeframe": "30d",
; "warning": 97
; }
; ],
; "type": "metric",
; "description": "non et",
; "groups": [
; "env:prod",
; "role:mysql"
; ],
; "monitor_ids": [
; 19441105,
; -6429790
; ],
; "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
; }
$oJson = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJson.UpdateString("name","Custom Metric SLO")
$oJson.UpdateInt("thresholds[0].target",95)
$oJson.UpdateString("thresholds[0].timeframe","7d")
$oJson.UpdateInt("thresholds[1].target",95)
$oJson.UpdateString("thresholds[1].timeframe","30d")
$oJson.UpdateInt("thresholds[1].warning",97)
$oJson.UpdateString("type","metric")
$oJson.UpdateString("description","non et")
$oJson.UpdateString("groups[0]","env:prod")
$oJson.UpdateString("groups[1]","role:mysql")
$oJson.UpdateInt("monitor_ids[0]",19441105)
$oJson.UpdateInt("monitor_ids[1]",-6429790)
$oJson.UpdateString("query.numerator","sum:my.custom.metric{type:good}.as_count()")
$oJson.UpdateString("query.denominator","sum:my.custom.metric{*}.as_count()")
$oJson.UpdateString("tags[0]","env:prod")
$oJson.UpdateString("tags[1]","app:core")
$oJson.UpdateNumber("target_threshold","99.9")
$oJson.UpdateString("timeframe","30d")
$oJson.UpdateNumber("warning_threshold","99.95")
$oHttp.SetRequestHeader "Content-Type","application/json"
$oHttp.SetRequestHeader "Accept","application/json"
Local $oResp = $oHttp.PostJson3("https://api.app.ddog-gov.com/api/v1/slo","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat_9_5_0.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)
; {
; "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
Local $sName
Local $sV_type
Local $iCreated_at
Local $sV_Email
Local $sHandle
Local $sName
Local $sDescription
Local $sId
Local $iModified_at
Local $sNumerator
Local $sDenominator
Local $sTarget_threshold
Local $sTimeframe
Local $sWarning_threshold
Local $iJ
Local $iCount_j
Local $iTarget
Local $iWarning
Local $strVal
Local $intVal
Local $iTotal_count = $oJResp.IntOf("metadata.page.total_count")
Local $iTotal_filtered_count = $oJResp.IntOf("metadata.page.total_filtered_count")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("data")
While $i < $iCount_i
$oJResp.I = $i
$sName = $oJResp.StringOf("data[i].name")
$sV_type = $oJResp.StringOf("data[i].type")
$iCreated_at = $oJResp.IntOf("data[i].created_at")
$sV_Email = $oJResp.StringOf("data[i].creator.email")
$sHandle = $oJResp.StringOf("data[i].creator.handle")
$sName = $oJResp.StringOf("data[i].creator.name")
$sDescription = $oJResp.StringOf("data[i].description")
$sId = $oJResp.StringOf("data[i].id")
$iModified_at = $oJResp.IntOf("data[i].modified_at")
$sNumerator = $oJResp.StringOf("data[i].query.numerator")
$sDenominator = $oJResp.StringOf("data[i].query.denominator")
$sTarget_threshold = $oJResp.StringOf("data[i].target_threshold")
$sTimeframe = $oJResp.StringOf("data[i].timeframe")
$sWarning_threshold = $oJResp.StringOf("data[i].warning_threshold")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("data[i].thresholds")
While $iJ < $iCount_j
$oJResp.J = $iJ
$iTarget = $oJResp.IntOf("data[i].thresholds[j].target")
$sTimeframe = $oJResp.StringOf("data[i].thresholds[j].timeframe")
$iWarning = $oJResp.IntOf("data[i].thresholds[j].warning")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("data[i].groups")
While $iJ < $iCount_j
$oJResp.J = $iJ
$strVal = $oJResp.StringOf("data[i].groups[j]")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("data[i].monitor_ids")
While $iJ < $iCount_j
$oJResp.J = $iJ
$intVal = $oJResp.IntOf("data[i].monitor_ids[j]")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("data[i].monitor_tags")
While $iJ < $iCount_j
$oJResp.J = $iJ
$strVal = $oJResp.StringOf("data[i].monitor_tags[j]")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("data[i].tags")
While $iJ < $iCount_j
$oJResp.J = $iJ
$strVal = $oJResp.StringOf("data[i].tags[j]")
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("errors")
While $i < $iCount_i
$oJResp.I = $i
$strVal = $oJResp.StringOf("errors[i]")
$i = $i + 1
Wend
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"name": "Custom Metric SLO",
"thresholds": [
{
"target": 95,
"timeframe": "7d"
},
{
"target": 95,
"timeframe": "30d",
"warning": 97
}
],
"type": "metric",
"description": "non et",
"groups": [
"env:prod",
"role:mysql"
],
"monitor_ids": [
19441105,
-6429790
],
"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
}'
https://api.app.ddog-gov.com/api/v1/slo
Postman Collection Item JSON
{
"name": "Create an SLO object",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\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 \"description\": \"non et\",\n \"groups\": [\n \"env:prod\",\n \"role:mysql\"\n ],\n \"monitor_ids\": [\n 19441105,\n -6429790\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo"
]
},
"description": "Create a service level objective object."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\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 \"description\": \"non et\",\n \"groups\": [\n \"env:prod\",\n \"role:mysql\"\n ],\n \"monitor_ids\": [\n 19441105,\n -6429790\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo"
]
}
},
"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": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\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 \"description\": \"non et\",\n \"groups\": [\n \"env:prod\",\n \"role:mysql\"\n ],\n \"monitor_ids\": [\n 19441105,\n -6429790\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo"
]
}
},
"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": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\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 \"description\": \"non et\",\n \"groups\": [\n \"env:prod\",\n \"role:mysql\"\n ],\n \"monitor_ids\": [\n 19441105,\n -6429790\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo"
]
}
},
"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": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\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 \"description\": \"non et\",\n \"groups\": [\n \"env:prod\",\n \"role:mysql\"\n ],\n \"monitor_ids\": [\n 19441105,\n -6429790\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo"
]
}
},
"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}"
}
]
}
