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: @"search" value: @"<string>"];
[queryParams UpdateString: @"tags" value: @"<string>"];
[queryParams UpdateString: @"from" value: @"<long>"];
[queryParams UpdateString: @"to" value: @"<long>"];
[queryParams UpdateInt: @"page[limit]" value: [NSNumber numberWithInt: 1000]];
[queryParams UpdateString: @"page[cursor]" value: @"<string>"];
[http SetRequestHeader: @"Accept" value: @"application/json"];
CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://api.app.ddog-gov.com/api/v2/processes" 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)
// {
// "data": [
// {
// "attributes": {
// "cmdline": "<string>",
// "host": "<string>",
// "pid": "<long>",
// "ppid": "<long>",
// "start": "<string>",
// "tags": [
// "<string>",
// "<string>"
// ],
// "timestamp": "<string>",
// "user": "<string>"
// },
// "id": "<string>",
// "type": "process"
// },
// {
// "attributes": {
// "cmdline": "<string>",
// "host": "<string>",
// "pid": "<long>",
// "ppid": "<long>",
// "start": "<string>",
// "tags": [
// "<string>",
// "<string>"
// ],
// "timestamp": "<string>",
// "user": "<string>"
// },
// "id": "<string>",
// "type": "process"
// }
// ],
// "meta": {
// "page": {
// "after": "<string>",
// "size": "<integer>"
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
NSString *Cmdline = 0;
NSString *Host = 0;
NSString *Pid = 0;
NSString *Ppid = 0;
NSString *Start = 0;
NSString *Timestamp = 0;
NSString *User = 0;
NSString *id = 0;
NSString *v_type = 0;
int j;
int count_j;
NSString *strVal = 0;
NSString *After = [jResp StringOf: @"meta.page.after"];
NSString *Size = [jResp StringOf: @"meta.page.size"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"data"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
Cmdline = [jResp StringOf: @"data[i].attributes.cmdline"];
Host = [jResp StringOf: @"data[i].attributes.host"];
Pid = [jResp StringOf: @"data[i].attributes.pid"];
Ppid = [jResp StringOf: @"data[i].attributes.ppid"];
Start = [jResp StringOf: @"data[i].attributes.start"];
Timestamp = [jResp StringOf: @"data[i].attributes.timestamp"];
User = [jResp StringOf: @"data[i].attributes.user"];
id = [jResp StringOf: @"data[i].id"];
v_type = [jResp StringOf: @"data[i].type"];
j = 0;
count_j = [[jResp SizeOfArray: @"data[i].attributes.tags"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: j];
strVal = [jResp StringOf: @"data[i].attributes.tags[j]"];
j = j + 1;
}
i = i + 1;
}
Curl Command
curl -G -d "search=%3Cstring%3E"
-d "tags=%3Cstring%3E"
-d "from=%3Clong%3E"
-d "to=%3Clong%3E"
-d "page[limit]=1000"
-d "page[cursor]=%3Cstring%3E"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/processes
Postman Collection Item JSON
{
"name": "Get all processes",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/processes?search=<string>&tags=<string>&from=<long>&to=<long>&page[limit]=1000&page[cursor]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"processes"
],
"query": [
{
"key": "search",
"value": "<string>",
"description": "String to search processes by."
},
{
"key": "tags",
"value": "<string>",
"description": "Comma-separated list of tags to filter processes by."
},
{
"key": "from",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "to",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "page[limit]",
"value": "1000",
"description": "Maximum number of results returned."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`."
}
]
},
"description": "Get all processes for your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/processes?search=<string>&tags=<string>&from=<long>&to=<long>&page[limit]=1000&page[cursor]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"processes"
],
"query": [
{
"key": "search",
"value": "<string>",
"description": "String to search processes by."
},
{
"key": "tags",
"value": "<string>",
"description": "Comma-separated list of tags to filter processes by."
},
{
"key": "from",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "to",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "page[limit]",
"value": "1000",
"description": "Maximum number of results returned."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"cmdline\": \"<string>\",\n \"host\": \"<string>\",\n \"pid\": \"<long>\",\n \"ppid\": \"<long>\",\n \"start\": \"<string>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"timestamp\": \"<string>\",\n \"user\": \"<string>\"\n },\n \"id\": \"<string>\",\n \"type\": \"process\"\n },\n {\n \"attributes\": {\n \"cmdline\": \"<string>\",\n \"host\": \"<string>\",\n \"pid\": \"<long>\",\n \"ppid\": \"<long>\",\n \"start\": \"<string>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"timestamp\": \"<string>\",\n \"user\": \"<string>\"\n },\n \"id\": \"<string>\",\n \"type\": \"process\"\n }\n ],\n \"meta\": {\n \"page\": {\n \"after\": \"<string>\",\n \"size\": \"<integer>\"\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/processes?search=<string>&tags=<string>&from=<long>&to=<long>&page[limit]=1000&page[cursor]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"processes"
],
"query": [
{
"key": "search",
"value": "<string>",
"description": "String to search processes by."
},
{
"key": "tags",
"value": "<string>",
"description": "Comma-separated list of tags to filter processes by."
},
{
"key": "from",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "to",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "page[limit]",
"value": "1000",
"description": "Maximum number of results returned."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`."
}
]
}
},
"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": "Authentication Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/processes?search=<string>&tags=<string>&from=<long>&to=<long>&page[limit]=1000&page[cursor]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"processes"
],
"query": [
{
"key": "search",
"value": "<string>",
"description": "String to search processes by."
},
{
"key": "tags",
"value": "<string>",
"description": "Comma-separated list of tags to filter processes by."
},
{
"key": "from",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "to",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "page[limit]",
"value": "1000",
"description": "Maximum number of results returned."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`."
}
]
}
},
"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": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/processes?search=<string>&tags=<string>&from=<long>&to=<long>&page[limit]=1000&page[cursor]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"processes"
],
"query": [
{
"key": "search",
"value": "<string>",
"description": "String to search processes by."
},
{
"key": "tags",
"value": "<string>",
"description": "Comma-separated list of tags to filter processes by."
},
{
"key": "from",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the start of the query window.\nIf not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "to",
"value": "<long>",
"description": "Unix timestamp (number of seconds since epoch) of the end of the query window.\nIf not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither\n`from` nor `to` are provided, the query window will be `[now - 15m, now]`."
},
{
"key": "page[limit]",
"value": "1000",
"description": "Maximum number of results returned."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "String to query the next page of results.\nThis key is provided with each valid response from the API in `meta.page.after`."
}
]
}
},
"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}"
}
]
}