Chilkat Online Tools

Ruby / Datadog API Collection / Aggregate RUM events

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()

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "compute": [
#     {
#       "aggregation": "pc98",
#       "interval": "<string>",
#       "metric": "<string>",
#       "type": "total"
#     },
#     {
#       "aggregation": "cardinality",
#       "interval": "<string>",
#       "metric": "<string>",
#       "type": "total"
#     }
#   ],
#   "filter": {
#     "from": "now-15m",
#     "query": "*",
#     "to": "now"
#   },
#   "group_by": [
#     {
#       "facet": "<string>",
#       "histogram": {
#         "interval": "<double>",
#         "min": "<double>",
#         "max": "<double>"
#       },
#       "limit": 10,
#       "missing": "<string>",
#       "sort": {
#         "aggregation": "sum",
#         "metric": "<string>",
#         "order": "asc",
#         "type": "alphabetical"
#       },
#       "total": "<boolean>"
#     },
#     {
#       "facet": "<string>",
#       "histogram": {
#         "interval": "<double>",
#         "min": "<double>",
#         "max": "<double>"
#       },
#       "limit": 10,
#       "missing": "<string>",
#       "sort": {
#         "aggregation": "pc99",
#         "metric": "<string>",
#         "order": "asc",
#         "type": "alphabetical"
#       },
#       "total": "<boolean>"
#     }
#   ],
#   "options": {
#     "time_offset": "<long>",
#     "timezone": "UTC"
#   },
#   "page": {
#     "cursor": "<string>",
#     "limit": 10
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("compute[0].aggregation","pc98")
json.UpdateString("compute[0].interval","<string>")
json.UpdateString("compute[0].metric","<string>")
json.UpdateString("compute[0].type","total")
json.UpdateString("compute[1].aggregation","cardinality")
json.UpdateString("compute[1].interval","<string>")
json.UpdateString("compute[1].metric","<string>")
json.UpdateString("compute[1].type","total")
json.UpdateString("filter.from","now-15m")
json.UpdateString("filter.query","*")
json.UpdateString("filter.to","now")
json.UpdateString("group_by[0].facet","<string>")
json.UpdateString("group_by[0].histogram.interval","<double>")
json.UpdateString("group_by[0].histogram.min","<double>")
json.UpdateString("group_by[0].histogram.max","<double>")
json.UpdateInt("group_by[0].limit",10)
json.UpdateString("group_by[0].missing","<string>")
json.UpdateString("group_by[0].sort.aggregation","sum")
json.UpdateString("group_by[0].sort.metric","<string>")
json.UpdateString("group_by[0].sort.order","asc")
json.UpdateString("group_by[0].sort.type","alphabetical")
json.UpdateString("group_by[0].total","<boolean>")
json.UpdateString("group_by[1].facet","<string>")
json.UpdateString("group_by[1].histogram.interval","<double>")
json.UpdateString("group_by[1].histogram.min","<double>")
json.UpdateString("group_by[1].histogram.max","<double>")
json.UpdateInt("group_by[1].limit",10)
json.UpdateString("group_by[1].missing","<string>")
json.UpdateString("group_by[1].sort.aggregation","pc99")
json.UpdateString("group_by[1].sort.metric","<string>")
json.UpdateString("group_by[1].sort.order","asc")
json.UpdateString("group_by[1].sort.type","alphabetical")
json.UpdateString("group_by[1].total","<boolean>")
json.UpdateString("options.time_offset","<long>")
json.UpdateString("options.timezone","UTC")
json.UpdateString("page.cursor","<string>")
json.UpdateInt("page.limit",10)

http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.PostJson3("https://api.app.ddog-gov.com/api/v2/rum/analytics/aggregate","application/json",json)
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": {
#     "buckets": [
#       {
#         "by": {
#           "inc4": "<string>"
#         },
#         "computes": {
#           "nostrud_0c_": "<string>"
#         }
#       },
#       {
#         "by": {
#           "dolore__": "<string>",
#           "aliqua_8a4": "<string>",
#           "fugiatd": "<string>",
#           "culpa9_a": "<string>"
#         },
#         "computes": {
#           "aliqua_237": "<string>"
#         }
#       }
#     ]
#   },
#   "links": {
#     "next": "<string>"
#   },
#   "meta": {
#     "elapsed": "<long>",
#     "page": {
#       "after": "<string>"
#     },
#     "request_id": "<string>",
#     "status": "done",
#     "warnings": [
#       {
#         "code": "<string>",
#         "detail": "<string>",
#         "title": "<string>"
#       },
#       {
#         "code": "<string>",
#         "detail": "<string>",
#         "title": "<string>"
#       }
#     ]
#   }
# }

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

v_Next = jResp.stringOf("links.next")
Elapsed = jResp.stringOf("meta.elapsed")
After = jResp.stringOf("meta.page.after")
Request_id = jResp.stringOf("meta.request_id")
Status = jResp.stringOf("meta.status")
i = 0
count_i = jResp.SizeOfArray("data.buckets")
while i < count_i
    jResp.put_I(i)
    Inc4 = jResp.stringOf("data.buckets[i].by.inc4")
    Nostrud_0c_ = jResp.stringOf("data.buckets[i].computes.nostrud_0c_")
    Dolore__ = jResp.stringOf("data.buckets[i].by.dolore__")
    Aliqua_8a4 = jResp.stringOf("data.buckets[i].by.aliqua_8a4")
    Fugiatd = jResp.stringOf("data.buckets[i].by.fugiatd")
    Culpa9_a = jResp.stringOf("data.buckets[i].by.culpa9_a")
    Aliqua_237 = jResp.stringOf("data.buckets[i].computes.aliqua_237")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("meta.warnings")
while i < count_i
    jResp.put_I(i)
    code = jResp.stringOf("meta.warnings[i].code")
    detail = jResp.stringOf("meta.warnings[i].detail")
    title = jResp.stringOf("meta.warnings[i].title")
    i = i + 1
end

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "compute": [
    {
      "aggregation": "pc98",
      "interval": "<string>",
      "metric": "<string>",
      "type": "total"
    },
    {
      "aggregation": "cardinality",
      "interval": "<string>",
      "metric": "<string>",
      "type": "total"
    }
  ],
  "filter": {
    "from": "now-15m",
    "query": "*",
    "to": "now"
  },
  "group_by": [
    {
      "facet": "<string>",
      "histogram": {
        "interval": "<double>",
        "min": "<double>",
        "max": "<double>"
      },
      "limit": 10,
      "missing": "<string>",
      "sort": {
        "aggregation": "sum",
        "metric": "<string>",
        "order": "asc",
        "type": "alphabetical"
      },
      "total": "<boolean>"
    },
    {
      "facet": "<string>",
      "histogram": {
        "interval": "<double>",
        "min": "<double>",
        "max": "<double>"
      },
      "limit": 10,
      "missing": "<string>",
      "sort": {
        "aggregation": "pc99",
        "metric": "<string>",
        "order": "asc",
        "type": "alphabetical"
      },
      "total": "<boolean>"
    }
  ],
  "options": {
    "time_offset": "<long>",
    "timezone": "UTC"
  },
  "page": {
    "cursor": "<string>",
    "limit": 10
  }
}'
https://api.app.ddog-gov.com/api/v2/rum/analytics/aggregate

Postman Collection Item JSON

{
  "name": "Aggregate RUM events",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"compute\": [\n    {\n      \"aggregation\": \"pc98\",\n      \"interval\": \"<string>\",\n      \"metric\": \"<string>\",\n      \"type\": \"total\"\n    },\n    {\n      \"aggregation\": \"cardinality\",\n      \"interval\": \"<string>\",\n      \"metric\": \"<string>\",\n      \"type\": \"total\"\n    }\n  ],\n  \"filter\": {\n    \"from\": \"now-15m\",\n    \"query\": \"*\",\n    \"to\": \"now\"\n  },\n  \"group_by\": [\n    {\n      \"facet\": \"<string>\",\n      \"histogram\": {\n        \"interval\": \"<double>\",\n        \"min\": \"<double>\",\n        \"max\": \"<double>\"\n      },\n      \"limit\": 10,\n      \"missing\": \"<string>\",\n      \"sort\": {\n        \"aggregation\": \"sum\",\n        \"metric\": \"<string>\",\n        \"order\": \"asc\",\n        \"type\": \"alphabetical\"\n      },\n      \"total\": \"<boolean>\"\n    },\n    {\n      \"facet\": \"<string>\",\n      \"histogram\": {\n        \"interval\": \"<double>\",\n        \"min\": \"<double>\",\n        \"max\": \"<double>\"\n      },\n      \"limit\": 10,\n      \"missing\": \"<string>\",\n      \"sort\": {\n        \"aggregation\": \"pc99\",\n        \"metric\": \"<string>\",\n        \"order\": \"asc\",\n        \"type\": \"alphabetical\"\n      },\n      \"total\": \"<boolean>\"\n    }\n  ],\n  \"options\": {\n    \"time_offset\": \"<long>\",\n    \"timezone\": \"UTC\"\n  },\n  \"page\": {\n    \"cursor\": \"<string>\",\n    \"limit\": 10\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v2/rum/analytics/aggregate",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "rum",
        "analytics",
        "aggregate"
      ]
    },
    "description": "The API endpoint to aggregate RUM events into buckets of computed metrics and timeseries."
  },
  "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  \"compute\": [\n    {\n      \"aggregation\": \"pc98\",\n      \"interval\": \"<string>\",\n      \"metric\": \"<string>\",\n      \"type\": \"total\"\n    },\n    {\n      \"aggregation\": \"cardinality\",\n      \"interval\": \"<string>\",\n      \"metric\": \"<string>\",\n      \"type\": \"total\"\n    }\n  ],\n  \"filter\": {\n    \"from\": \"now-15m\",\n    \"query\": \"*\",\n    \"to\": \"now\"\n  },\n  \"group_by\": [\n    {\n      \"facet\": \"<string>\",\n      \"histogram\": {\n        \"interval\": \"<double>\",\n        \"min\": \"<double>\",\n        \"max\": \"<double>\"\n      },\n      \"limit\": 10,\n      \"missing\": \"<string>\",\n      \"sort\": {\n        \"aggregation\": \"sum\",\n        \"metric\": \"<string>\",\n        \"order\": \"asc\",\n        \"type\": \"alphabetical\"\n      },\n      \"total\": \"<boolean>\"\n    },\n    {\n      \"facet\": \"<string>\",\n      \"histogram\": {\n        \"interval\": \"<double>\",\n        \"min\": \"<double>\",\n        \"max\": \"<double>\"\n      },\n      \"limit\": 10,\n      \"missing\": \"<string>\",\n      \"sort\": {\n        \"aggregation\": \"pc99\",\n        \"metric\": \"<string>\",\n        \"order\": \"asc\",\n        \"type\": \"alphabetical\"\n      },\n      \"total\": \"<boolean>\"\n    }\n  ],\n  \"options\": {\n    \"time_offset\": \"<long>\",\n    \"timezone\": \"UTC\"\n  },\n  \"page\": {\n    \"cursor\": \"<string>\",\n    \"limit\": 10\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/rum/analytics/aggregate",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "rum",
            "analytics",
            "aggregate"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"buckets\": [\n      {\n        \"by\": {\n          \"inc4\": \"<string>\"\n        },\n        \"computes\": {\n          \"nostrud_0c_\": \"<string>\"\n        }\n      },\n      {\n        \"by\": {\n          \"dolore__\": \"<string>\",\n          \"aliqua_8a4\": \"<string>\",\n          \"fugiatd\": \"<string>\",\n          \"culpa9_a\": \"<string>\"\n        },\n        \"computes\": {\n          \"aliqua_237\": \"<string>\"\n        }\n      }\n    ]\n  },\n  \"links\": {\n    \"next\": \"<string>\"\n  },\n  \"meta\": {\n    \"elapsed\": \"<long>\",\n    \"page\": {\n      \"after\": \"<string>\"\n    },\n    \"request_id\": \"<string>\",\n    \"status\": \"done\",\n    \"warnings\": [\n      {\n        \"code\": \"<string>\",\n        \"detail\": \"<string>\",\n        \"title\": \"<string>\"\n      },\n      {\n        \"code\": \"<string>\",\n        \"detail\": \"<string>\",\n        \"title\": \"<string>\"\n      }\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  \"compute\": [\n    {\n      \"aggregation\": \"pc98\",\n      \"interval\": \"<string>\",\n      \"metric\": \"<string>\",\n      \"type\": \"total\"\n    },\n    {\n      \"aggregation\": \"cardinality\",\n      \"interval\": \"<string>\",\n      \"metric\": \"<string>\",\n      \"type\": \"total\"\n    }\n  ],\n  \"filter\": {\n    \"from\": \"now-15m\",\n    \"query\": \"*\",\n    \"to\": \"now\"\n  },\n  \"group_by\": [\n    {\n      \"facet\": \"<string>\",\n      \"histogram\": {\n        \"interval\": \"<double>\",\n        \"min\": \"<double>\",\n        \"max\": \"<double>\"\n      },\n      \"limit\": 10,\n      \"missing\": \"<string>\",\n      \"sort\": {\n        \"aggregation\": \"sum\",\n        \"metric\": \"<string>\",\n        \"order\": \"asc\",\n        \"type\": \"alphabetical\"\n      },\n      \"total\": \"<boolean>\"\n    },\n    {\n      \"facet\": \"<string>\",\n      \"histogram\": {\n        \"interval\": \"<double>\",\n        \"min\": \"<double>\",\n        \"max\": \"<double>\"\n      },\n      \"limit\": 10,\n      \"missing\": \"<string>\",\n      \"sort\": {\n        \"aggregation\": \"pc99\",\n        \"metric\": \"<string>\",\n        \"order\": \"asc\",\n        \"type\": \"alphabetical\"\n      },\n      \"total\": \"<boolean>\"\n    }\n  ],\n  \"options\": {\n    \"time_offset\": \"<long>\",\n    \"timezone\": \"UTC\"\n  },\n  \"page\": {\n    \"cursor\": \"<string>\",\n    \"limit\": 10\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/rum/analytics/aggregate",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "rum",
            "analytics",
            "aggregate"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    },
    {
      "name": "Not Authorized",
      "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  \"compute\": [\n    {\n      \"aggregation\": \"pc98\",\n      \"interval\": \"<string>\",\n      \"metric\": \"<string>\",\n      \"type\": \"total\"\n    },\n    {\n      \"aggregation\": \"cardinality\",\n      \"interval\": \"<string>\",\n      \"metric\": \"<string>\",\n      \"type\": \"total\"\n    }\n  ],\n  \"filter\": {\n    \"from\": \"now-15m\",\n    \"query\": \"*\",\n    \"to\": \"now\"\n  },\n  \"group_by\": [\n    {\n      \"facet\": \"<string>\",\n      \"histogram\": {\n        \"interval\": \"<double>\",\n        \"min\": \"<double>\",\n        \"max\": \"<double>\"\n      },\n      \"limit\": 10,\n      \"missing\": \"<string>\",\n      \"sort\": {\n        \"aggregation\": \"sum\",\n        \"metric\": \"<string>\",\n        \"order\": \"asc\",\n        \"type\": \"alphabetical\"\n      },\n      \"total\": \"<boolean>\"\n    },\n    {\n      \"facet\": \"<string>\",\n      \"histogram\": {\n        \"interval\": \"<double>\",\n        \"min\": \"<double>\",\n        \"max\": \"<double>\"\n      },\n      \"limit\": 10,\n      \"missing\": \"<string>\",\n      \"sort\": {\n        \"aggregation\": \"pc99\",\n        \"metric\": \"<string>\",\n        \"order\": \"asc\",\n        \"type\": \"alphabetical\"\n      },\n      \"total\": \"<boolean>\"\n    }\n  ],\n  \"options\": {\n    \"time_offset\": \"<long>\",\n    \"timezone\": \"UTC\"\n  },\n  \"page\": {\n    \"cursor\": \"<string>\",\n    \"limit\": 10\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/rum/analytics/aggregate",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "rum",
            "analytics",
            "aggregate"
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\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  \"compute\": [\n    {\n      \"aggregation\": \"pc98\",\n      \"interval\": \"<string>\",\n      \"metric\": \"<string>\",\n      \"type\": \"total\"\n    },\n    {\n      \"aggregation\": \"cardinality\",\n      \"interval\": \"<string>\",\n      \"metric\": \"<string>\",\n      \"type\": \"total\"\n    }\n  ],\n  \"filter\": {\n    \"from\": \"now-15m\",\n    \"query\": \"*\",\n    \"to\": \"now\"\n  },\n  \"group_by\": [\n    {\n      \"facet\": \"<string>\",\n      \"histogram\": {\n        \"interval\": \"<double>\",\n        \"min\": \"<double>\",\n        \"max\": \"<double>\"\n      },\n      \"limit\": 10,\n      \"missing\": \"<string>\",\n      \"sort\": {\n        \"aggregation\": \"sum\",\n        \"metric\": \"<string>\",\n        \"order\": \"asc\",\n        \"type\": \"alphabetical\"\n      },\n      \"total\": \"<boolean>\"\n    },\n    {\n      \"facet\": \"<string>\",\n      \"histogram\": {\n        \"interval\": \"<double>\",\n        \"min\": \"<double>\",\n        \"max\": \"<double>\"\n      },\n      \"limit\": 10,\n      \"missing\": \"<string>\",\n      \"sort\": {\n        \"aggregation\": \"pc99\",\n        \"metric\": \"<string>\",\n        \"order\": \"asc\",\n        \"type\": \"alphabetical\"\n      },\n      \"total\": \"<boolean>\"\n    }\n  ],\n  \"options\": {\n    \"time_offset\": \"<long>\",\n    \"timezone\": \"UTC\"\n  },\n  \"page\": {\n    \"cursor\": \"<string>\",\n    \"limit\": 10\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/rum/analytics/aggregate",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "rum",
            "analytics",
            "aggregate"
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    }
  ]
}