Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vJson
Handle hoJson
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sName
String sV_type
Integer iCreated_at
String sV_Email
String sHandle
String sName
String sDescription
String sId
Integer iModified_at
String sNumerator
String sDenominator
String sTarget_threshold
String sTimeframe
String sWarning_threshold
Integer j
Integer iCount_j
Integer iTarget
Integer iWarning
String sStrVal
Integer iIntVal
Integer iTotal_count
Integer iTotal_filtered_count
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// 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
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "name" "Custom Metric SLO" To iSuccess
Get ComUpdateInt Of hoJson "thresholds[0].target" 95 To iSuccess
Get ComUpdateString Of hoJson "thresholds[0].timeframe" "7d" To iSuccess
Get ComUpdateInt Of hoJson "thresholds[1].target" 95 To iSuccess
Get ComUpdateString Of hoJson "thresholds[1].timeframe" "30d" To iSuccess
Get ComUpdateInt Of hoJson "thresholds[1].warning" 97 To iSuccess
Get ComUpdateString Of hoJson "type" "metric" To iSuccess
Get ComUpdateString Of hoJson "description" "non et" To iSuccess
Get ComUpdateString Of hoJson "groups[0]" "env:prod" To iSuccess
Get ComUpdateString Of hoJson "groups[1]" "role:mysql" To iSuccess
Get ComUpdateInt Of hoJson "monitor_ids[0]" 19441105 To iSuccess
Get ComUpdateInt Of hoJson "monitor_ids[1]" -6429790 To iSuccess
Get ComUpdateString Of hoJson "query.numerator" "sum:my.custom.metric{type:good}.as_count()" To iSuccess
Get ComUpdateString Of hoJson "query.denominator" "sum:my.custom.metric{*}.as_count()" To iSuccess
Get ComUpdateString Of hoJson "tags[0]" "env:prod" To iSuccess
Get ComUpdateString Of hoJson "tags[1]" "app:core" To iSuccess
Get ComUpdateNumber Of hoJson "target_threshold" "99.9" To iSuccess
Get ComUpdateString Of hoJson "timeframe" "30d" To iSuccess
Get ComUpdateNumber Of hoJson "warning_threshold" "99.95" To iSuccess
Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get pvComObject of hoJson to vJson
Get ComPostJson3 Of hoHttp "https://api.app.ddog-gov.com/api/v1/slo" "application/json" vJson To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Get ComIntOf Of hoJResp "metadata.page.total_count" To iTotal_count
Get ComIntOf Of hoJResp "metadata.page.total_filtered_count" To iTotal_filtered_count
Move 0 To i
Get ComSizeOfArray Of hoJResp "data" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "data[i].name" To sName
Get ComStringOf Of hoJResp "data[i].type" To sV_type
Get ComIntOf Of hoJResp "data[i].created_at" To iCreated_at
Get ComStringOf Of hoJResp "data[i].creator.email" To sV_Email
Get ComStringOf Of hoJResp "data[i].creator.handle" To sHandle
Get ComStringOf Of hoJResp "data[i].creator.name" To sName
Get ComStringOf Of hoJResp "data[i].description" To sDescription
Get ComStringOf Of hoJResp "data[i].id" To sId
Get ComIntOf Of hoJResp "data[i].modified_at" To iModified_at
Get ComStringOf Of hoJResp "data[i].query.numerator" To sNumerator
Get ComStringOf Of hoJResp "data[i].query.denominator" To sDenominator
Get ComStringOf Of hoJResp "data[i].target_threshold" To sTarget_threshold
Get ComStringOf Of hoJResp "data[i].timeframe" To sTimeframe
Get ComStringOf Of hoJResp "data[i].warning_threshold" To sWarning_threshold
Move 0 To j
Get ComSizeOfArray Of hoJResp "data[i].thresholds" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComIntOf Of hoJResp "data[i].thresholds[j].target" To iTarget
Get ComStringOf Of hoJResp "data[i].thresholds[j].timeframe" To sTimeframe
Get ComIntOf Of hoJResp "data[i].thresholds[j].warning" To iWarning
Move (j + 1) To j
Loop
Move 0 To j
Get ComSizeOfArray Of hoJResp "data[i].groups" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "data[i].groups[j]" To sStrVal
Move (j + 1) To j
Loop
Move 0 To j
Get ComSizeOfArray Of hoJResp "data[i].monitor_ids" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComIntOf Of hoJResp "data[i].monitor_ids[j]" To iIntVal
Move (j + 1) To j
Loop
Move 0 To j
Get ComSizeOfArray Of hoJResp "data[i].monitor_tags" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "data[i].monitor_tags[j]" To sStrVal
Move (j + 1) To j
Loop
Move 0 To j
Get ComSizeOfArray Of hoJResp "data[i].tags" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "data[i].tags[j]" To sStrVal
Move (j + 1) To j
Loop
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "errors" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "errors[i]" To sStrVal
Move (i + 1) To i
Loop
End_Procedure
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}"
}
]
}
