Chilkat Online Tools

Objective-C / Datadog API Collection / Get hourly usage for sensitive data scanner

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: @"start_hr" value: @"1991-02-02T07:22:34.204Z"];
[queryParams UpdateString: @"end_hr" value: @"1991-02-02T07:22:34.204Z"];

[http SetRequestHeader: @"Accept" value: @"application/json;datetime-format=rfc3339"];

CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://api.app.ddog-gov.com/api/v1/usage/sds" 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)

// {
//   "usage": [
//     {
//       "apm_scanned_bytes": -76522392,
//       "events_scanned_bytes": 63869395,
//       "hour": "1980-07-02T07:13:19.943Z",
//       "logs_scanned_bytes": 63884791,
//       "org_name": "adipisicing sunt ea consectetur",
//       "public_id": "velit sed laboris dolore",
//       "rum_scanned_bytes": -45588793,
//       "total_scanned_bytes": -72952707
//     },
//     {
//       "apm_scanned_bytes": 65125022,
//       "events_scanned_bytes": 55684538,
//       "hour": "1987-06-03T12:26:07.332Z",
//       "logs_scanned_bytes": -75701054,
//       "org_name": "exercitation incididunt adipisicing",
//       "public_id": "adipisicing sun",
//       "rum_scanned_bytes": 48012670,
//       "total_scanned_bytes": -29371626
//     }
//   ]
// }

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

int apm_scanned_bytes;
int events_scanned_bytes;
NSString *hour = 0;
int logs_scanned_bytes;
NSString *org_name = 0;
NSString *public_id = 0;
int rum_scanned_bytes;
int total_scanned_bytes;

int i = 0;
int count_i = [[jResp SizeOfArray: @"usage"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    apm_scanned = [[jResp IntOf: @"usage[i].apm_scanned_bytes"] intValue];
    events_scanned = [[jResp IntOf: @"usage[i].events_scanned_bytes"] intValue];
    hour = [jResp StringOf: @"usage[i].hour"];
    logs_scanned = [[jResp IntOf: @"usage[i].logs_scanned_bytes"] intValue];
    org_name = [jResp StringOf: @"usage[i].org_name"];
    public_id = [jResp StringOf: @"usage[i].public_id"];
    rum_scanned = [[jResp IntOf: @"usage[i].rum_scanned_bytes"] intValue];
    total_scanned = [[jResp IntOf: @"usage[i].total_scanned_bytes"] intValue];
    i = i + 1;
}

Curl Command

curl -G -d "start_hr=1991-02-02T07%3A22%3A34.204Z"
	-d "end_hr=1991-02-02T07%3A22%3A34.204Z"
	-H "Accept: application/json;datetime-format=rfc3339"
https://api.app.ddog-gov.com/api/v1/usage/sds

Postman Collection Item JSON

{
  "name": "Get hourly usage for sensitive data scanner",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json;datetime-format=rfc3339"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/usage/sds?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "usage",
        "sds"
      ],
      "query": [
        {
          "key": "start_hr",
          "value": "1991-02-02T07:22:34.204Z",
          "description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour."
        },
        {
          "key": "end_hr",
          "value": "1991-02-02T07:22:34.204Z",
          "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending\n**before** this hour."
        }
      ]
    },
    "description": "Get hourly usage for sensitive data scanner.\n**Note:** hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json;datetime-format=rfc3339"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v1/usage/sds?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "usage",
            "sds"
          ],
          "query": [
            {
              "key": "start_hr",
              "value": "1991-02-02T07:22:34.204Z",
              "description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour."
            },
            {
              "key": "end_hr",
              "value": "1991-02-02T07:22:34.204Z",
              "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending\n**before** this hour."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json;datetime-format=rfc3339"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"usage\": [\n    {\n      \"apm_scanned_bytes\": -76522392,\n      \"events_scanned_bytes\": 63869395,\n      \"hour\": \"1980-07-02T07:13:19.943Z\",\n      \"logs_scanned_bytes\": 63884791,\n      \"org_name\": \"adipisicing sunt ea consectetur\",\n      \"public_id\": \"velit sed laboris dolore\",\n      \"rum_scanned_bytes\": -45588793,\n      \"total_scanned_bytes\": -72952707\n    },\n    {\n      \"apm_scanned_bytes\": 65125022,\n      \"events_scanned_bytes\": 55684538,\n      \"hour\": \"1987-06-03T12:26:07.332Z\",\n      \"logs_scanned_bytes\": -75701054,\n      \"org_name\": \"exercitation incididunt adipisicing\",\n      \"public_id\": \"adipisicing sun\",\n      \"rum_scanned_bytes\": 48012670,\n      \"total_scanned_bytes\": -29371626\n    }\n  ]\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json;datetime-format=rfc3339"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v1/usage/sds?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "usage",
            "sds"
          ],
          "query": [
            {
              "key": "start_hr",
              "value": "1991-02-02T07:22:34.204Z",
              "description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour."
            },
            {
              "key": "end_hr",
              "value": "1991-02-02T07:22:34.204Z",
              "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending\n**before** this hour."
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json;datetime-format=rfc3339"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    },
    {
      "name": "Forbidden - User is not authorized",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json;datetime-format=rfc3339"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v1/usage/sds?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "usage",
            "sds"
          ],
          "query": [
            {
              "key": "start_hr",
              "value": "1991-02-02T07:22:34.204Z",
              "description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour."
            },
            {
              "key": "end_hr",
              "value": "1991-02-02T07:22:34.204Z",
              "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending\n**before** this hour."
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json;datetime-format=rfc3339"
        }
      ],
      "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;datetime-format=rfc3339"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v1/usage/sds?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "usage",
            "sds"
          ],
          "query": [
            {
              "key": "start_hr",
              "value": "1991-02-02T07:22:34.204Z",
              "description": "(Required) Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour."
            },
            {
              "key": "end_hr",
              "value": "1991-02-02T07:22:34.204Z",
              "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending\n**before** this hour."
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json;datetime-format=rfc3339"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    }
  ]
}