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;
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "data": {
// "attributes": {
// "compute": [
// {
// "aggregation": "avg",
// "interval": "<string>",
// "metric": "<string>",
// "type": "total"
// },
// {
// "aggregation": "pc98",
// "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": "count",
// "metric": "<string>",
// "order": "desc",
// "type": "alphabetical"
// },
// "total": "<boolean>"
// },
// {
// "facet": "<string>",
// "histogram": {
// "interval": "<double>",
// "min": "<double>",
// "max": "<double>"
// },
// "limit": 10,
// "missing": "<string>",
// "sort": {
// "aggregation": "pc99",
// "metric": "<string>",
// "order": "desc",
// "type": "alphabetical"
// },
// "total": "<boolean>"
// }
// ],
// "options": {
// "timeOffset": "<long>",
// "timezone": "UTC"
// }
// },
// "type": "aggregate_request"
// }
// }
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"data.attributes.compute[0].aggregation" value: @"avg"];
[json UpdateString: @"data.attributes.compute[0].interval" value: @"<string>"];
[json UpdateString: @"data.attributes.compute[0].metric" value: @"<string>"];
[json UpdateString: @"data.attributes.compute[0].type" value: @"total"];
[json UpdateString: @"data.attributes.compute[1].aggregation" value: @"pc98"];
[json UpdateString: @"data.attributes.compute[1].interval" value: @"<string>"];
[json UpdateString: @"data.attributes.compute[1].metric" value: @"<string>"];
[json UpdateString: @"data.attributes.compute[1].type" value: @"total"];
[json UpdateString: @"data.attributes.filter.from" value: @"now-15m"];
[json UpdateString: @"data.attributes.filter.query" value: @"*"];
[json UpdateString: @"data.attributes.filter.to" value: @"now"];
[json UpdateString: @"data.attributes.group_by[0].facet" value: @"<string>"];
[json UpdateString: @"data.attributes.group_by[0].histogram.interval" value: @"<double>"];
[json UpdateString: @"data.attributes.group_by[0].histogram.min" value: @"<double>"];
[json UpdateString: @"data.attributes.group_by[0].histogram.max" value: @"<double>"];
[json UpdateInt: @"data.attributes.group_by[0].limit" value: [NSNumber numberWithInt: 10]];
[json UpdateString: @"data.attributes.group_by[0].missing" value: @"<string>"];
[json UpdateString: @"data.attributes.group_by[0].sort.aggregation" value: @"count"];
[json UpdateString: @"data.attributes.group_by[0].sort.metric" value: @"<string>"];
[json UpdateString: @"data.attributes.group_by[0].sort.order" value: @"desc"];
[json UpdateString: @"data.attributes.group_by[0].sort.type" value: @"alphabetical"];
[json UpdateString: @"data.attributes.group_by[0].total" value: @"<boolean>"];
[json UpdateString: @"data.attributes.group_by[1].facet" value: @"<string>"];
[json UpdateString: @"data.attributes.group_by[1].histogram.interval" value: @"<double>"];
[json UpdateString: @"data.attributes.group_by[1].histogram.min" value: @"<double>"];
[json UpdateString: @"data.attributes.group_by[1].histogram.max" value: @"<double>"];
[json UpdateInt: @"data.attributes.group_by[1].limit" value: [NSNumber numberWithInt: 10]];
[json UpdateString: @"data.attributes.group_by[1].missing" value: @"<string>"];
[json UpdateString: @"data.attributes.group_by[1].sort.aggregation" value: @"pc99"];
[json UpdateString: @"data.attributes.group_by[1].sort.metric" value: @"<string>"];
[json UpdateString: @"data.attributes.group_by[1].sort.order" value: @"desc"];
[json UpdateString: @"data.attributes.group_by[1].sort.type" value: @"alphabetical"];
[json UpdateString: @"data.attributes.group_by[1].total" value: @"<boolean>"];
[json UpdateString: @"data.attributes.options.timeOffset" value: @"<long>"];
[json UpdateString: @"data.attributes.options.timezone" value: @"UTC"];
[json UpdateString: @"data.type" value: @"aggregate_request"];
[http SetRequestHeader: @"Content-Type" value: @"application/json"];
[http SetRequestHeader: @"Accept" value: @"application/json"];
CkoHttpResponse *resp = [http PostJson3: @"https://api.app.ddog-gov.com/api/v2/spans/analytics/aggregate" contentType: @"application/json" json: json];
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": [
// {
// "attributes": {
// "by": {
// "ea3": {
// "description": "The values for each group by."
// },
// "nulla_7fe": {
// "description": "The values for each group by."
// }
// },
// "compute": {},
// "computes": {
// "ullamco_2f": "<string>",
// "do_fc0": "<string>"
// }
// },
// "id": "<string>",
// "type": "bucket"
// },
// {
// "attributes": {
// "by": {
// "nisi9a": {
// "description": "The values for each group by."
// }
// },
// "compute": {},
// "computes": {
// "sunt_d": "<string>",
// "elit_d4": "<string>"
// }
// },
// "id": "<string>",
// "type": "bucket"
// }
// ],
// "meta": {
// "elapsed": "<long>",
// "request_id": "<string>",
// "status": "timeout",
// "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
NSString *Description = 0;
NSString *Nulla_7feDescription = 0;
NSString *Ullamco_2f = 0;
NSString *Do_fc0 = 0;
NSString *id = 0;
NSString *v_type = 0;
NSString *Nisi9aDescription = 0;
NSString *Sunt_d = 0;
NSString *Elit_d4 = 0;
NSString *code = 0;
NSString *detail = 0;
NSString *title = 0;
NSString *Elapsed = [jResp StringOf: @"meta.elapsed"];
NSString *Request_id = [jResp StringOf: @"meta.request_id"];
NSString *Status = [jResp StringOf: @"meta.status"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"data"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
Description = [jResp StringOf: @"data[i].attributes.by.ea3.description"];
Nulla_7feDescription = [jResp StringOf: @"data[i].attributes.by.nulla_7fe.description"];
Ullamco_2f = [jResp StringOf: @"data[i].attributes.computes.ullamco_2f"];
Do_fc0 = [jResp StringOf: @"data[i].attributes.computes.do_fc0"];
id = [jResp StringOf: @"data[i].id"];
v_type = [jResp StringOf: @"data[i].type"];
Nisi9aDescription = [jResp StringOf: @"data[i].attributes.by.nisi9a.description"];
Sunt_d = [jResp StringOf: @"data[i].attributes.computes.sunt_d"];
Elit_d4 = [jResp StringOf: @"data[i].attributes.computes.elit_d4"];
i = i + 1;
}
i = 0;
count_i = [[jResp SizeOfArray: @"meta.warnings"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: 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;
}
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"attributes": {
"compute": [
{
"aggregation": "avg",
"interval": "<string>",
"metric": "<string>",
"type": "total"
},
{
"aggregation": "pc98",
"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": "count",
"metric": "<string>",
"order": "desc",
"type": "alphabetical"
},
"total": "<boolean>"
},
{
"facet": "<string>",
"histogram": {
"interval": "<double>",
"min": "<double>",
"max": "<double>"
},
"limit": 10,
"missing": "<string>",
"sort": {
"aggregation": "pc99",
"metric": "<string>",
"order": "desc",
"type": "alphabetical"
},
"total": "<boolean>"
}
],
"options": {
"timeOffset": "<long>",
"timezone": "UTC"
}
},
"type": "aggregate_request"
}
}'
https://api.app.ddog-gov.com/api/v2/spans/analytics/aggregate
Postman Collection Item JSON
{
"name": "Aggregate spans",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"compute\": [\n {\n \"aggregation\": \"avg\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc98\",\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\": \"count\",\n \"metric\": \"<string>\",\n \"order\": \"desc\",\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\": \"desc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n }\n ],\n \"options\": {\n \"timeOffset\": \"<long>\",\n \"timezone\": \"UTC\"\n }\n },\n \"type\": \"aggregate_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/spans/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"analytics",
"aggregate"
]
},
"description": "The API endpoint to aggregate spans into buckets and compute metrics and timeseries.\nThis endpoint is rate limited to `300` requests per hour."
},
"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 \"data\": {\n \"attributes\": {\n \"compute\": [\n {\n \"aggregation\": \"avg\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc98\",\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\": \"count\",\n \"metric\": \"<string>\",\n \"order\": \"desc\",\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\": \"desc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n }\n ],\n \"options\": {\n \"timeOffset\": \"<long>\",\n \"timezone\": \"UTC\"\n }\n },\n \"type\": \"aggregate_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/spans/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"analytics",
"aggregate"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"by\": {\n \"ea3\": {\n \"description\": \"The values for each group by.\"\n },\n \"nulla_7fe\": {\n \"description\": \"The values for each group by.\"\n }\n },\n \"compute\": {},\n \"computes\": {\n \"ullamco_2f\": \"<string>\",\n \"do_fc0\": \"<string>\"\n }\n },\n \"id\": \"<string>\",\n \"type\": \"bucket\"\n },\n {\n \"attributes\": {\n \"by\": {\n \"nisi9a\": {\n \"description\": \"The values for each group by.\"\n }\n },\n \"compute\": {},\n \"computes\": {\n \"sunt_d\": \"<string>\",\n \"elit_d4\": \"<string>\"\n }\n },\n \"id\": \"<string>\",\n \"type\": \"bucket\"\n }\n ],\n \"meta\": {\n \"elapsed\": \"<long>\",\n \"request_id\": \"<string>\",\n \"status\": \"timeout\",\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 \"data\": {\n \"attributes\": {\n \"compute\": [\n {\n \"aggregation\": \"avg\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc98\",\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\": \"count\",\n \"metric\": \"<string>\",\n \"order\": \"desc\",\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\": \"desc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n }\n ],\n \"options\": {\n \"timeOffset\": \"<long>\",\n \"timezone\": \"UTC\"\n }\n },\n \"type\": \"aggregate_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/spans/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"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": "Forbidden",
"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 \"data\": {\n \"attributes\": {\n \"compute\": [\n {\n \"aggregation\": \"avg\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc98\",\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\": \"count\",\n \"metric\": \"<string>\",\n \"order\": \"desc\",\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\": \"desc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n }\n ],\n \"options\": {\n \"timeOffset\": \"<long>\",\n \"timezone\": \"UTC\"\n }\n },\n \"type\": \"aggregate_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/spans/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"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 \"data\": {\n \"attributes\": {\n \"compute\": [\n {\n \"aggregation\": \"avg\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc98\",\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\": \"count\",\n \"metric\": \"<string>\",\n \"order\": \"desc\",\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\": \"desc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n }\n ],\n \"options\": {\n \"timeOffset\": \"<long>\",\n \"timezone\": \"UTC\"\n }\n },\n \"type\": \"aggregate_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/spans/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"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}"
}
]
}
