Chilkat Online Tools

Objective-C / Datadog API Collection / Get an SLO's details

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateString: @"with_configured_alert_ids" value: @"true"];

[http SetRequestHeader: @"Accept" value: @"application/json"];

CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://api.app.ddog-gov.com/api/v1/slo/:slo_id" json: queryParams];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"Failed.");

    return;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "data": {
//     "configured_alert_ids": [
//       123,
//       456,
//       789
//     ],
//     "created_at": 17466638,
//     "creator": {
//       "email": "proident ex ullamco",
//       "handle": "laborum ad ex non",
//       "name": "officia dolor consectetur nisi"
//     },
//     "description": "est id",
//     "groups": [
//       "env:prod",
//       "role:mysql"
//     ],
//     "id": "esse cillum anim ",
//     "modified_at": -26273532,
//     "monitor_ids": [
//       -91642399,
//       93741
//     ],
//     "monitor_tags": [
//       "aliquip nulla Lorem ut",
//       "reprehenderit velit"
//     ],
//     "name": "Custom Metric SLO",
//     "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,
//     "thresholds": [
//       {
//         "target": 95,
//         "timeframe": "7d"
//       },
//       {
//         "target": 95,
//         "timeframe": "30d",
//         "warning": 97
//       }
//     ],
//     "timeframe": "30d",
//     "type": "metric",
//     "warning_threshold": 99.95
//   },
//   "errors": [
//     "consectetur velit",
//     "elit in"
//   ]
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

int intVal;
NSString *strVal = 0;
int target;
NSString *timeframe = 0;
int warning;

int Created_at = [[jResp IntOf: @"data.created_at"] intValue];
NSString *v_Email = [jResp StringOf: @"data.creator.email"];
NSString *Handle = [jResp StringOf: @"data.creator.handle"];
NSString *Name = [jResp StringOf: @"data.creator.name"];
NSString *Description = [jResp StringOf: @"data.description"];
NSString *Id = [jResp StringOf: @"data.id"];
int Modified_at = [[jResp IntOf: @"data.modified_at"] intValue];
NSString *dataName = [jResp StringOf: @"data.name"];
NSString *Numerator = [jResp StringOf: @"data.query.numerator"];
NSString *Denominator = [jResp StringOf: @"data.query.denominator"];
NSString *Target_threshold = [jResp StringOf: @"data.target_threshold"];
NSString *Timeframe = [jResp StringOf: @"data.timeframe"];
NSString *v_Type = [jResp StringOf: @"data.type"];
NSString *Warning_threshold = [jResp StringOf: @"data.warning_threshold"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"data.configured_alert_ids"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    intVal = [[jResp IntOf: @"data.configured_alert_ids[i]"] intValue];
    i = i + 1;
}

i = 0;
count_i = [[jResp SizeOfArray: @"data.groups"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    strVal = [jResp StringOf: @"data.groups[i]"];
    i = i + 1;
}

i = 0;
count_i = [[jResp SizeOfArray: @"data.monitor_ids"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    intVal = [[jResp IntOf: @"data.monitor_ids[i]"] intValue];
    i = i + 1;
}

i = 0;
count_i = [[jResp SizeOfArray: @"data.monitor_tags"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    strVal = [jResp StringOf: @"data.monitor_tags[i]"];
    i = i + 1;
}

i = 0;
count_i = [[jResp SizeOfArray: @"data.tags"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    strVal = [jResp StringOf: @"data.tags[i]"];
    i = i + 1;
}

i = 0;
count_i = [[jResp SizeOfArray: @"data.thresholds"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    target = [[jResp IntOf: @"data.thresholds[i].target"] intValue];
    timeframe = [jResp StringOf: @"data.thresholds[i].timeframe"];
    warning = [[jResp IntOf: @"data.thresholds[i].warning"] intValue];
    i = i + 1;
}

i = 0;
count_i = [[jResp SizeOfArray: @"errors"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    strVal = [jResp StringOf: @"errors[i]"];
    i = i + 1;
}

Curl Command

curl -G -d "with_configured_alert_ids=true"
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/slo/:slo_id

Postman Collection Item JSON

{
  "name": "Get an SLO's details",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/slo/:slo_id?with_configured_alert_ids=true",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "slo",
        ":slo_id"
      ],
      "query": [
        {
          "key": "with_configured_alert_ids",
          "value": "true",
          "description": "Get the IDs of SLO monitors that reference this SLO."
        }
      ],
      "variable": [
        {
          "key": "slo_id",
          "value": "tempor Ut sed velit"
        }
      ]
    },
    "description": "Get a service level objective object."
  },
  "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/:slo_id?with_configured_alert_ids=true",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "slo",
            ":slo_id"
          ],
          "query": [
            {
              "key": "with_configured_alert_ids",
              "value": "true",
              "description": "Get the IDs of SLO monitors that reference this SLO."
            }
          ],
          "variable": [
            {
              "key": "slo_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"configured_alert_ids\": [\n      123,\n      456,\n      789\n    ],\n    \"created_at\": 17466638,\n    \"creator\": {\n      \"email\": \"proident ex ullamco\",\n      \"handle\": \"laborum ad ex non\",\n      \"name\": \"officia dolor consectetur nisi\"\n    },\n    \"description\": \"est id\",\n    \"groups\": [\n      \"env:prod\",\n      \"role:mysql\"\n    ],\n    \"id\": \"esse cillum anim \",\n    \"modified_at\": -26273532,\n    \"monitor_ids\": [\n      -91642399,\n      93741\n    ],\n    \"monitor_tags\": [\n      \"aliquip nulla Lorem ut\",\n      \"reprehenderit velit\"\n    ],\n    \"name\": \"Custom Metric SLO\",\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    \"thresholds\": [\n      {\n        \"target\": 95,\n        \"timeframe\": \"7d\"\n      },\n      {\n        \"target\": 95,\n        \"timeframe\": \"30d\",\n        \"warning\": 97\n      }\n    ],\n    \"timeframe\": \"30d\",\n    \"type\": \"metric\",\n    \"warning_threshold\": 99.95\n  },\n  \"errors\": [\n    \"consectetur velit\",\n    \"elit in\"\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/:slo_id?with_configured_alert_ids=true",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "slo",
            ":slo_id"
          ],
          "query": [
            {
              "key": "with_configured_alert_ids",
              "value": "true",
              "description": "Get the IDs of SLO monitors that reference this SLO."
            }
          ],
          "variable": [
            {
              "key": "slo_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": "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/:slo_id?with_configured_alert_ids=true",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "slo",
            ":slo_id"
          ],
          "query": [
            {
              "key": "with_configured_alert_ids",
              "value": "true",
              "description": "Get the IDs of SLO monitors that reference this SLO."
            }
          ],
          "variable": [
            {
              "key": "slo_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/slo/:slo_id?with_configured_alert_ids=true",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "slo",
            ":slo_id"
          ],
          "query": [
            {
              "key": "with_configured_alert_ids",
              "value": "true",
              "description": "Get the IDs of SLO monitors that reference this SLO."
            }
          ],
          "variable": [
            {
              "key": "slo_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}"
    }
  ]
}