Objective-C / Datadog API Collection / Query timeseries data across multiple products
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": {
// "type": "timeseries_request",
// "attributes": {
// "to": "<long>",
// "from": "<long>",
// "queries": [
// {
// "data_source": "metrics",
// "query": "<string>",
// "name": "<string>"
// },
// {
// "data_source": "metrics",
// "query": "<string>",
// "name": "<string>"
// }
// ],
// "formulas": [
// {
// "formula": "<string>",
// "limit": {
// "count": "<integer>",
// "order": "desc"
// }
// },
// {
// "formula": "<string>",
// "limit": {
// "count": "<integer>",
// "order": "desc"
// }
// }
// ],
// "interval": "<long>"
// }
// }
// }
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"data.type" value: @"timeseries_request"];
[json UpdateString: @"data.attributes.to" value: @"<long>"];
[json UpdateString: @"data.attributes.from" value: @"<long>"];
[json UpdateString: @"data.attributes.queries[0].data_source" value: @"metrics"];
[json UpdateString: @"data.attributes.queries[0].query" value: @"<string>"];
[json UpdateString: @"data.attributes.queries[0].name" value: @"<string>"];
[json UpdateString: @"data.attributes.queries[1].data_source" value: @"metrics"];
[json UpdateString: @"data.attributes.queries[1].query" value: @"<string>"];
[json UpdateString: @"data.attributes.queries[1].name" value: @"<string>"];
[json UpdateString: @"data.attributes.formulas[0].formula" value: @"<string>"];
[json UpdateString: @"data.attributes.formulas[0].limit.count" value: @"<integer>"];
[json UpdateString: @"data.attributes.formulas[0].limit.order" value: @"desc"];
[json UpdateString: @"data.attributes.formulas[1].formula" value: @"<string>"];
[json UpdateString: @"data.attributes.formulas[1].limit.count" value: @"<integer>"];
[json UpdateString: @"data.attributes.formulas[1].limit.order" value: @"desc"];
[json UpdateString: @"data.attributes.interval" value: @"<long>"];
[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/query/timeseries" 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": {
// "series": [
// {
// "group_tags": [
// "<string>",
// "<string>"
// ],
// "query_index": "<integer>",
// "unit": [
// {
// "family": "<string>",
// "name": "<string>",
// "plural": "<string>",
// "scale_factor": "<double>",
// "short_name": "<string>"
// },
// {
// "family": "<string>",
// "name": "<string>",
// "plural": "<string>",
// "scale_factor": "<double>",
// "short_name": "<string>"
// }
// ]
// },
// {
// "group_tags": [
// "<string>",
// "<string>"
// ],
// "query_index": "<integer>",
// "unit": [
// {
// "family": "<string>",
// "name": "<string>",
// "plural": "<string>",
// "scale_factor": "<double>",
// "short_name": "<string>"
// },
// {
// "family": "<string>",
// "name": "<string>",
// "plural": "<string>",
// "scale_factor": "<double>",
// "short_name": "<string>"
// }
// ]
// }
// ],
// "times": [
// "<long>",
// "<long>"
// ],
// "values": [
// [
// "<double>",
// "<double>"
// ],
// [
// "<double>",
// "<double>"
// ]
// ]
// },
// "type": "timeseries_response"
// },
// "errors": "<string>"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
NSString *query_index = 0;
int j;
int count_j;
NSString *strVal = 0;
NSString *family = 0;
NSString *name = 0;
NSString *plural = 0;
NSString *scale_factor = 0;
NSString *short_name = 0;
NSString *v_Type = [jResp StringOf: @"data.type"];
NSString *errors = [jResp StringOf: @"errors"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"data.attributes.series"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
query_index = [jResp StringOf: @"data.attributes.series[i].query_index"];
j = 0;
count_j = [[jResp SizeOfArray: @"data.attributes.series[i].group_tags"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: j];
strVal = [jResp StringOf: @"data.attributes.series[i].group_tags[j]"];
j = j + 1;
}
j = 0;
count_j = [[jResp SizeOfArray: @"data.attributes.series[i].unit"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: j];
family = [jResp StringOf: @"data.attributes.series[i].unit[j].family"];
name = [jResp StringOf: @"data.attributes.series[i].unit[j].name"];
plural = [jResp StringOf: @"data.attributes.series[i].unit[j].plural"];
scale_factor = [jResp StringOf: @"data.attributes.series[i].unit[j].scale_factor"];
short_name = [jResp StringOf: @"data.attributes.series[i].unit[j].short_name"];
j = j + 1;
}
i = i + 1;
}
i = 0;
count_i = [[jResp SizeOfArray: @"data.attributes.times"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
strVal = [jResp StringOf: @"data.attributes.times[i]"];
i = i + 1;
}
i = 0;
count_i = [[jResp SizeOfArray: @"data.attributes.values"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
j = 0;
count_j = [[jResp SizeOfArray: @"data.attributes.values[i]"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: j];
strVal = [jResp StringOf: @"data.attributes.values[i][j]"];
j = j + 1;
}
i = i + 1;
}
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"type": "timeseries_request",
"attributes": {
"to": "<long>",
"from": "<long>",
"queries": [
{
"data_source": "metrics",
"query": "<string>",
"name": "<string>"
},
{
"data_source": "metrics",
"query": "<string>",
"name": "<string>"
}
],
"formulas": [
{
"formula": "<string>",
"limit": {
"count": "<integer>",
"order": "desc"
}
},
{
"formula": "<string>",
"limit": {
"count": "<integer>",
"order": "desc"
}
}
],
"interval": "<long>"
}
}
}'
https://api.app.ddog-gov.com/api/v2/query/timeseries
Postman Collection Item JSON
{
"name": "Query timeseries data across multiple products",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"timeseries_request\",\n \"attributes\": {\n \"to\": \"<long>\",\n \"from\": \"<long>\",\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"name\": \"<string>\"\n },\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n }\n ],\n \"interval\": \"<long>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/timeseries",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"timeseries"
]
},
"description": "Query timeseries data across various data sources and\nprocess the data by applying formulas and functions."
},
"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 \"type\": \"timeseries_request\",\n \"attributes\": {\n \"to\": \"<long>\",\n \"from\": \"<long>\",\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"name\": \"<string>\"\n },\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n }\n ],\n \"interval\": \"<long>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/timeseries",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"timeseries"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"attributes\": {\n \"series\": [\n {\n \"group_tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"query_index\": \"<integer>\",\n \"unit\": [\n {\n \"family\": \"<string>\",\n \"name\": \"<string>\",\n \"plural\": \"<string>\",\n \"scale_factor\": \"<double>\",\n \"short_name\": \"<string>\"\n },\n {\n \"family\": \"<string>\",\n \"name\": \"<string>\",\n \"plural\": \"<string>\",\n \"scale_factor\": \"<double>\",\n \"short_name\": \"<string>\"\n }\n ]\n },\n {\n \"group_tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"query_index\": \"<integer>\",\n \"unit\": [\n {\n \"family\": \"<string>\",\n \"name\": \"<string>\",\n \"plural\": \"<string>\",\n \"scale_factor\": \"<double>\",\n \"short_name\": \"<string>\"\n },\n {\n \"family\": \"<string>\",\n \"name\": \"<string>\",\n \"plural\": \"<string>\",\n \"scale_factor\": \"<double>\",\n \"short_name\": \"<string>\"\n }\n ]\n }\n ],\n \"times\": [\n \"<long>\",\n \"<long>\"\n ],\n \"values\": [\n [\n \"<double>\",\n \"<double>\"\n ],\n [\n \"<double>\",\n \"<double>\"\n ]\n ]\n },\n \"type\": \"timeseries_response\"\n },\n \"errors\": \"<string>\"\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 \"type\": \"timeseries_request\",\n \"attributes\": {\n \"to\": \"<long>\",\n \"from\": \"<long>\",\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"name\": \"<string>\"\n },\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n }\n ],\n \"interval\": \"<long>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/timeseries",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"timeseries"
]
}
},
"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": "Unauthorized",
"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 \"type\": \"timeseries_request\",\n \"attributes\": {\n \"to\": \"<long>\",\n \"from\": \"<long>\",\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"name\": \"<string>\"\n },\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n }\n ],\n \"interval\": \"<long>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/timeseries",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"timeseries"
]
}
},
"status": "Unauthorized",
"code": 401,
"_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 \"type\": \"timeseries_request\",\n \"attributes\": {\n \"to\": \"<long>\",\n \"from\": \"<long>\",\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"name\": \"<string>\"\n },\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n }\n ],\n \"interval\": \"<long>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/timeseries",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"timeseries"
]
}
},
"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 \"type\": \"timeseries_request\",\n \"attributes\": {\n \"to\": \"<long>\",\n \"from\": \"<long>\",\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"name\": \"<string>\"\n },\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n }\n ],\n \"interval\": \"<long>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/timeseries",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"timeseries"
]
}
},
"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}"
}
]
}
