Chilkat Online Tools

Objective-C / Datadog API Collection / Get hourly usage for RUM sessions

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"];
[queryParams UpdateString: @"type" value: @"tempor Ut sed velit"];

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

CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://api.app.ddog-gov.com/api/v1/usage/rum_sessions" 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": [
//     {
//       "hour": "1978-09-20T13:37:51.128Z",
//       "org_name": "Excepteur culpa",
//       "public_id": "ullamco non nisi",
//       "replay_session_count": -940159,
//       "session_count": -811216,
//       "session_count_android": -81500426,
//       "session_count_flutter": -93521029,
//       "session_count_ios": 79794310,
//       "session_count_reactnative": 39931659
//     },
//     {
//       "hour": "1989-04-17T22:04:02.790Z",
//       "org_name": "do irure",
//       "public_id": "eiusmod sint",
//       "replay_session_count": 65965574,
//       "session_count": -74693981,
//       "session_count_android": -64203464,
//       "session_count_flutter": -9710282,
//       "session_count_ios": 67525220,
//       "session_count_reactnative": 73944039
//     }
//   ]
// }

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

NSString *hour = 0;
NSString *org_name = 0;
NSString *public_id = 0;
int replay_session_count;
int session_count;
int session_count_android;
int session_count_flutter;
int session_count_ios;
int session_count_reactnative;

int i = 0;
int count_i = [[jResp SizeOfArray: @"usage"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    hour = [jResp StringOf: @"usage[i].hour"];
    org_name = [jResp StringOf: @"usage[i].org_name"];
    public_id = [jResp StringOf: @"usage[i].public_id"];
    replay_session_count = [[jResp IntOf: @"usage[i].replay_session_count"] intValue];
    session_count = [[jResp IntOf: @"usage[i].session_count"] intValue];
    session_count_android = [[jResp IntOf: @"usage[i].session_count_android"] intValue];
    session_count_flutter = [[jResp IntOf: @"usage[i].session_count_flutter"] intValue];
    session_count_ios = [[jResp IntOf: @"usage[i].session_count_ios"] intValue];
    session_count_reactnative = [[jResp IntOf: @"usage[i].session_count_reactnative"] 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"
	-d "type=tempor%20Ut%20sed%20velit"
	-H "Accept: application/json;datetime-format=rfc3339"
https://api.app.ddog-gov.com/api/v1/usage/rum_sessions

Postman Collection Item JSON

{
  "name": "Get hourly usage for RUM sessions",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json;datetime-format=rfc3339"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/usage/rum_sessions?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z&type=tempor Ut sed velit",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "usage",
        "rum_sessions"
      ],
      "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 **before** this hour."
        },
        {
          "key": "type",
          "value": "tempor Ut sed velit",
          "description": "RUM type: `[browser, mobile]`. Defaults to `browser`."
        }
      ]
    },
    "description": "Get hourly usage for [RUM](https://docs.datadoghq.com/real_user_monitoring/) Sessions.\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/rum_sessions?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z&type=tempor Ut sed velit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "usage",
            "rum_sessions"
          ],
          "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 **before** this hour."
            },
            {
              "key": "type",
              "value": "tempor Ut sed velit",
              "description": "RUM type: `[browser, mobile]`. Defaults to `browser`."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json;datetime-format=rfc3339"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"usage\": [\n    {\n      \"hour\": \"1978-09-20T13:37:51.128Z\",\n      \"org_name\": \"Excepteur culpa\",\n      \"public_id\": \"ullamco non nisi\",\n      \"replay_session_count\": -940159,\n      \"session_count\": -811216,\n      \"session_count_android\": -81500426,\n      \"session_count_flutter\": -93521029,\n      \"session_count_ios\": 79794310,\n      \"session_count_reactnative\": 39931659\n    },\n    {\n      \"hour\": \"1989-04-17T22:04:02.790Z\",\n      \"org_name\": \"do irure\",\n      \"public_id\": \"eiusmod sint\",\n      \"replay_session_count\": 65965574,\n      \"session_count\": -74693981,\n      \"session_count_android\": -64203464,\n      \"session_count_flutter\": -9710282,\n      \"session_count_ios\": 67525220,\n      \"session_count_reactnative\": 73944039\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/rum_sessions?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z&type=tempor Ut sed velit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "usage",
            "rum_sessions"
          ],
          "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 **before** this hour."
            },
            {
              "key": "type",
              "value": "tempor Ut sed velit",
              "description": "RUM type: `[browser, mobile]`. Defaults to `browser`."
            }
          ]
        }
      },
      "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/rum_sessions?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z&type=tempor Ut sed velit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "usage",
            "rum_sessions"
          ],
          "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 **before** this hour."
            },
            {
              "key": "type",
              "value": "tempor Ut sed velit",
              "description": "RUM type: `[browser, mobile]`. Defaults to `browser`."
            }
          ]
        }
      },
      "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/rum_sessions?start_hr=1991-02-02T07:22:34.204Z&end_hr=1991-02-02T07:22:34.204Z&type=tempor Ut sed velit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "usage",
            "rum_sessions"
          ],
          "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 **before** this hour."
            },
            {
              "key": "type",
              "value": "tempor Ut sed velit",
              "description": "RUM type: `[browser, mobile]`. Defaults to `browser`."
            }
          ]
        }
      },
      "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}"
    }
  ]
}