Chilkat Online Tools

Ruby / Datadog API Collection / Get all SLOs

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("ids","id1, id2, id3")
queryParams.UpdateString("query","monitor")
queryParams.UpdateString("tags_query","env:prod")
queryParams.UpdateString("metrics_query","aws.elb.request_count")
queryParams.UpdateInt("limit",-62147425)
queryParams.UpdateInt("offset",-62147425)

http.SetRequestHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v1/slo",queryParams)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# 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

Total_count = jResp.IntOf("metadata.page.total_count")
Total_filtered_count = jResp.IntOf("metadata.page.total_filtered_count")
i = 0
count_i = jResp.SizeOfArray("data")
while i < count_i
    jResp.put_I(i)
    name = jResp.stringOf("data[i].name")
    v_type = jResp.stringOf("data[i].type")
    created_at = jResp.IntOf("data[i].created_at")
    v_Email = jResp.stringOf("data[i].creator.email")
    Handle = jResp.stringOf("data[i].creator.handle")
    Name = jResp.stringOf("data[i].creator.name")
    description = jResp.stringOf("data[i].description")
    id = jResp.stringOf("data[i].id")
    modified_at = jResp.IntOf("data[i].modified_at")
    Numerator = jResp.stringOf("data[i].query.numerator")
    Denominator = jResp.stringOf("data[i].query.denominator")
    target_threshold = jResp.stringOf("data[i].target_threshold")
    timeframe = jResp.stringOf("data[i].timeframe")
    warning_threshold = jResp.stringOf("data[i].warning_threshold")
    j = 0
    count_j = jResp.SizeOfArray("data[i].thresholds")
    while j < count_j
        jResp.put_J(j)
        target = jResp.IntOf("data[i].thresholds[j].target")
        timeframe = jResp.stringOf("data[i].thresholds[j].timeframe")
        warning = jResp.IntOf("data[i].thresholds[j].warning")
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("data[i].groups")
    while j < count_j
        jResp.put_J(j)
        strVal = jResp.stringOf("data[i].groups[j]")
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("data[i].monitor_ids")
    while j < count_j
        jResp.put_J(j)
        intVal = jResp.IntOf("data[i].monitor_ids[j]")
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("data[i].monitor_tags")
    while j < count_j
        jResp.put_J(j)
        strVal = jResp.stringOf("data[i].monitor_tags[j]")
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("data[i].tags")
    while j < count_j
        jResp.put_J(j)
        strVal = jResp.stringOf("data[i].tags[j]")
        j = j + 1
    end
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("errors")
while i < count_i
    jResp.put_I(i)
    strVal = jResp.stringOf("errors[i]")
    i = i + 1
end

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