Back to Collection Items
use chilkat();
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = chilkat::CkHttp->new();
$queryParams = chilkat::CkJsonObject->new();
$queryParams->UpdateInt("page[limit]",25);
$queryParams->UpdateInt("page[offset]",0);
$http->SetRequestHeader("Accept","application/json");
# resp is a HttpResponse
$resp = $http->QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/powerpacks",$queryParams);
if ($http->get_LastMethodSuccess() == 0) {
print $http->lastErrorText() . "\r\n";
exit;
}
$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);
$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);
print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";
$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
print "Response Header:" . "\r\n";
print $resp->header() . "\r\n";
print "Failed." . "\r\n";
exit;
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "data": [
# {
# "attributes": {
# "group_widget": {
# "definition": {
# "widgets": [
# {
# "definition": {
# "id4": {}
# },
# "layout": {
# "x": "<long>",
# "y": "<long>",
# "width": "<long>",
# "height": "<long>"
# }
# },
# {
# "definition": {
# "nullac41": {},
# "adipisicing9": {}
# },
# "layout": {
# "x": "<long>",
# "y": "<long>",
# "width": "<long>",
# "height": "<long>"
# }
# }
# ],
# "layout_type": "<string>",
# "type": "<string>",
# "show_title": "<boolean>",
# "title": "<string>"
# },
# "layout": {
# "x": "<long>",
# "y": "<long>",
# "width": "<long>",
# "height": "<long>"
# }
# },
# "name": "<string>",
# "description": "<string>",
# "tags": [
# "<string>",
# "<string>"
# ],
# "template_variables": [
# {
# "name": "<string>",
# "defaults": [
# "<string>",
# "<string>"
# ]
# },
# {
# "name": "<string>",
# "defaults": [
# "<string>",
# "<string>"
# ]
# }
# ]
# },
# "id": "<string>",
# "relationships": {
# "author": {
# "email": "<string>",
# "handle": "<string>",
# "name": "<string>"
# }
# },
# "type": "<string>"
# },
# {
# "attributes": {
# "group_widget": {
# "definition": {
# "widgets": [
# {
# "definition": {
# "ut9": {}
# },
# "layout": {
# "x": "<long>",
# "y": "<long>",
# "width": "<long>",
# "height": "<long>"
# }
# },
# {
# "definition": {
# "labore_391": {},
# "ullamco142": {}
# },
# "layout": {
# "x": "<long>",
# "y": "<long>",
# "width": "<long>",
# "height": "<long>"
# }
# }
# ],
# "layout_type": "<string>",
# "type": "<string>",
# "show_title": "<boolean>",
# "title": "<string>"
# },
# "layout": {
# "x": "<long>",
# "y": "<long>",
# "width": "<long>",
# "height": "<long>"
# }
# },
# "name": "<string>",
# "description": "<string>",
# "tags": [
# "<string>",
# "<string>"
# ],
# "template_variables": [
# {
# "name": "<string>",
# "defaults": [
# "<string>",
# "<string>"
# ]
# },
# {
# "name": "<string>",
# "defaults": [
# "<string>",
# "<string>"
# ]
# }
# ]
# },
# "id": "<string>",
# "relationships": {
# "author": {
# "email": "<string>",
# "handle": "<string>",
# "name": "<string>"
# }
# },
# "type": "<string>"
# }
# ],
# "included": [
# {
# "attributes": {
# "created_at": "<dateTime>",
# "disabled": "<boolean>",
# "email": "<string>",
# "handle": "<string>",
# "icon": "<string>",
# "modified_at": "<dateTime>",
# "name": "<string>",
# "service_account": "<boolean>",
# "status": "<string>",
# "title": "<string>",
# "verified": "<boolean>"
# },
# "id": "<string>",
# "relationships": {
# "org": {
# "data": {
# "id": "<string>",
# "type": "orgs"
# }
# },
# "other_orgs": {
# "data": [
# {
# "id": "<string>",
# "type": "orgs"
# },
# {
# "id": "<string>",
# "type": "orgs"
# }
# ]
# },
# "other_users": {
# "data": [
# {
# "id": "<string>",
# "type": "users"
# },
# {
# "id": "<string>",
# "type": "users"
# }
# ]
# },
# "roles": {
# "data": [
# {
# "id": "<string>",
# "type": "roles"
# },
# {
# "id": "<string>",
# "type": "roles"
# }
# ]
# }
# },
# "type": "users"
# },
# {
# "attributes": {
# "created_at": "<dateTime>",
# "disabled": "<boolean>",
# "email": "<string>",
# "handle": "<string>",
# "icon": "<string>",
# "modified_at": "<dateTime>",
# "name": "<string>",
# "service_account": "<boolean>",
# "status": "<string>",
# "title": "<string>",
# "verified": "<boolean>"
# },
# "id": "<string>",
# "relationships": {
# "org": {
# "data": {
# "id": "<string>",
# "type": "orgs"
# }
# },
# "other_orgs": {
# "data": [
# {
# "id": "<string>",
# "type": "orgs"
# },
# {
# "id": "<string>",
# "type": "orgs"
# }
# ]
# },
# "other_users": {
# "data": [
# {
# "id": "<string>",
# "type": "users"
# },
# {
# "id": "<string>",
# "type": "users"
# }
# ]
# },
# "roles": {
# "data": [
# {
# "id": "<string>",
# "type": "roles"
# },
# {
# "id": "<string>",
# "type": "roles"
# }
# ]
# }
# },
# "type": "users"
# }
# ],
# "links": {
# "first": "<string>",
# "last": "<string>",
# "next": "<string>",
# "prev": "<string>",
# "self": "<string>"
# },
# "meta": {
# "pagination": {
# "first_offset": "<long>",
# "last_offset": "<long>",
# "limit": "<long>",
# "next_offset": "<long>",
# "offset": "<long>",
# "prev_offset": "<long>",
# "total": "<long>",
# "type": "<string>"
# }
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$First = $jResp->stringOf("links.first");
$Last = $jResp->stringOf("links.last");
$v_Next = $jResp->stringOf("links.next");
$Prev = $jResp->stringOf("links.prev");
$v_Self = $jResp->stringOf("links.self");
$First_offset = $jResp->stringOf("meta.pagination.first_offset");
$Last_offset = $jResp->stringOf("meta.pagination.last_offset");
$Limit = $jResp->stringOf("meta.pagination.limit");
$Next_offset = $jResp->stringOf("meta.pagination.next_offset");
$Offset = $jResp->stringOf("meta.pagination.offset");
$Prev_offset = $jResp->stringOf("meta.pagination.prev_offset");
$Total = $jResp->stringOf("meta.pagination.total");
$v_Type = $jResp->stringOf("meta.pagination.type");
$i = 0;
$count_i = $jResp->SizeOfArray("data");
while ($i < $count_i) {
$jResp->put_I($i);
$Layout_type = $jResp->stringOf("data[i].attributes.group_widget.definition.layout_type");
$DefinitionType = $jResp->stringOf("data[i].attributes.group_widget.definition.type");
$Show_title = $jResp->stringOf("data[i].attributes.group_widget.definition.show_title");
$Title = $jResp->stringOf("data[i].attributes.group_widget.definition.title");
$X = $jResp->stringOf("data[i].attributes.group_widget.layout.x");
$Y = $jResp->stringOf("data[i].attributes.group_widget.layout.y");
$Width = $jResp->stringOf("data[i].attributes.group_widget.layout.width");
$Height = $jResp->stringOf("data[i].attributes.group_widget.layout.height");
$Name = $jResp->stringOf("data[i].attributes.name");
$Description = $jResp->stringOf("data[i].attributes.description");
$id = $jResp->stringOf("data[i].id");
$v_Email = $jResp->stringOf("data[i].relationships.author.email");
$Handle = $jResp->stringOf("data[i].relationships.author.handle");
$AuthorName = $jResp->stringOf("data[i].relationships.author.name");
$v_type = $jResp->stringOf("data[i].type");
$j = 0;
$count_j = $jResp->SizeOfArray("data[i].attributes.group_widget.definition.widgets");
while ($j < $count_j) {
$jResp->put_J($j);
$layoutX = $jResp->stringOf("data[i].attributes.group_widget.definition.widgets[j].layout.x");
$layoutY = $jResp->stringOf("data[i].attributes.group_widget.definition.widgets[j].layout.y");
$layoutWidth = $jResp->stringOf("data[i].attributes.group_widget.definition.widgets[j].layout.width");
$layoutHeight = $jResp->stringOf("data[i].attributes.group_widget.definition.widgets[j].layout.height");
$j = $j + 1;
}
$j = 0;
$count_j = $jResp->SizeOfArray("data[i].attributes.tags");
while ($j < $count_j) {
$jResp->put_J($j);
$strVal = $jResp->stringOf("data[i].attributes.tags[j]");
$j = $j + 1;
}
$j = 0;
$count_j = $jResp->SizeOfArray("data[i].attributes.template_variables");
while ($j < $count_j) {
$jResp->put_J($j);
$name = $jResp->stringOf("data[i].attributes.template_variables[j].name");
$k = 0;
$count_k = $jResp->SizeOfArray("data[i].attributes.template_variables[j].defaults");
while ($k < $count_k) {
$jResp->put_K($k);
$strVal = $jResp->stringOf("data[i].attributes.template_variables[j].defaults[k]");
$k = $k + 1;
}
$j = $j + 1;
}
$i = $i + 1;
}
$i = 0;
$count_i = $jResp->SizeOfArray("included");
while ($i < $count_i) {
$jResp->put_I($i);
$Created_at = $jResp->stringOf("included[i].attributes.created_at");
$Disabled = $jResp->stringOf("included[i].attributes.disabled");
$attributesEmail = $jResp->stringOf("included[i].attributes.email");
$attributesHandle = $jResp->stringOf("included[i].attributes.handle");
$Icon = $jResp->stringOf("included[i].attributes.icon");
$Modified_at = $jResp->stringOf("included[i].attributes.modified_at");
$attributesName = $jResp->stringOf("included[i].attributes.name");
$Service_account = $jResp->stringOf("included[i].attributes.service_account");
$Status = $jResp->stringOf("included[i].attributes.status");
$attributesTitle = $jResp->stringOf("included[i].attributes.title");
$Verified = $jResp->stringOf("included[i].attributes.verified");
$id = $jResp->stringOf("included[i].id");
$Id = $jResp->stringOf("included[i].relationships.org.data.id");
$DataType = $jResp->stringOf("included[i].relationships.org.data.type");
$v_type = $jResp->stringOf("included[i].type");
$j = 0;
$count_j = $jResp->SizeOfArray("included[i].relationships.other_orgs.data");
while ($j < $count_j) {
$jResp->put_J($j);
$id = $jResp->stringOf("included[i].relationships.other_orgs.data[j].id");
$v_type = $jResp->stringOf("included[i].relationships.other_orgs.data[j].type");
$j = $j + 1;
}
$j = 0;
$count_j = $jResp->SizeOfArray("included[i].relationships.other_users.data");
while ($j < $count_j) {
$jResp->put_J($j);
$id = $jResp->stringOf("included[i].relationships.other_users.data[j].id");
$v_type = $jResp->stringOf("included[i].relationships.other_users.data[j].type");
$j = $j + 1;
}
$j = 0;
$count_j = $jResp->SizeOfArray("included[i].relationships.roles.data");
while ($j < $count_j) {
$jResp->put_J($j);
$id = $jResp->stringOf("included[i].relationships.roles.data[j].id");
$v_type = $jResp->stringOf("included[i].relationships.roles.data[j].type");
$j = $j + 1;
}
$i = $i + 1;
}
Curl Command
curl -G -d "page[limit]=25"
-d "page[offset]=0"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/powerpacks
Postman Collection Item JSON
{
"name": "Get all powerpacks",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/powerpacks?page[limit]=25&page[offset]=0",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks"
],
"query": [
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of powerpacks in the response."
},
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page."
}
]
},
"description": "Get a list of all powerpacks."
},
"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/powerpacks?page[limit]=25&page[offset]=0",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks"
],
"query": [
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of powerpacks in the response."
},
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"group_widget\": {\n \"definition\": {\n \"widgets\": [\n {\n \"definition\": {\n \"id4\": {}\n },\n \"layout\": {\n \"x\": \"<long>\",\n \"y\": \"<long>\",\n \"width\": \"<long>\",\n \"height\": \"<long>\"\n }\n },\n {\n \"definition\": {\n \"nullac41\": {},\n \"adipisicing9\": {}\n },\n \"layout\": {\n \"x\": \"<long>\",\n \"y\": \"<long>\",\n \"width\": \"<long>\",\n \"height\": \"<long>\"\n }\n }\n ],\n \"layout_type\": \"<string>\",\n \"type\": \"<string>\",\n \"show_title\": \"<boolean>\",\n \"title\": \"<string>\"\n },\n \"layout\": {\n \"x\": \"<long>\",\n \"y\": \"<long>\",\n \"width\": \"<long>\",\n \"height\": \"<long>\"\n }\n },\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"template_variables\": [\n {\n \"name\": \"<string>\",\n \"defaults\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n {\n \"name\": \"<string>\",\n \"defaults\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n ]\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"author\": {\n \"email\": \"<string>\",\n \"handle\": \"<string>\",\n \"name\": \"<string>\"\n }\n },\n \"type\": \"<string>\"\n },\n {\n \"attributes\": {\n \"group_widget\": {\n \"definition\": {\n \"widgets\": [\n {\n \"definition\": {\n \"ut9\": {}\n },\n \"layout\": {\n \"x\": \"<long>\",\n \"y\": \"<long>\",\n \"width\": \"<long>\",\n \"height\": \"<long>\"\n }\n },\n {\n \"definition\": {\n \"labore_391\": {},\n \"ullamco142\": {}\n },\n \"layout\": {\n \"x\": \"<long>\",\n \"y\": \"<long>\",\n \"width\": \"<long>\",\n \"height\": \"<long>\"\n }\n }\n ],\n \"layout_type\": \"<string>\",\n \"type\": \"<string>\",\n \"show_title\": \"<boolean>\",\n \"title\": \"<string>\"\n },\n \"layout\": {\n \"x\": \"<long>\",\n \"y\": \"<long>\",\n \"width\": \"<long>\",\n \"height\": \"<long>\"\n }\n },\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"template_variables\": [\n {\n \"name\": \"<string>\",\n \"defaults\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n {\n \"name\": \"<string>\",\n \"defaults\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n ]\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"author\": {\n \"email\": \"<string>\",\n \"handle\": \"<string>\",\n \"name\": \"<string>\"\n }\n },\n \"type\": \"<string>\"\n }\n ],\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"<dateTime>\",\n \"disabled\": \"<boolean>\",\n \"email\": \"<string>\",\n \"handle\": \"<string>\",\n \"icon\": \"<string>\",\n \"modified_at\": \"<dateTime>\",\n \"name\": \"<string>\",\n \"service_account\": \"<boolean>\",\n \"status\": \"<string>\",\n \"title\": \"<string>\",\n \"verified\": \"<boolean>\"\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n }\n ]\n },\n \"other_users\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n ]\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"<dateTime>\",\n \"disabled\": \"<boolean>\",\n \"email\": \"<string>\",\n \"handle\": \"<string>\",\n \"icon\": \"<string>\",\n \"modified_at\": \"<dateTime>\",\n \"name\": \"<string>\",\n \"service_account\": \"<boolean>\",\n \"status\": \"<string>\",\n \"title\": \"<string>\",\n \"verified\": \"<boolean>\"\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n }\n ]\n },\n \"other_users\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n ]\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ],\n \"links\": {\n \"first\": \"<string>\",\n \"last\": \"<string>\",\n \"next\": \"<string>\",\n \"prev\": \"<string>\",\n \"self\": \"<string>\"\n },\n \"meta\": {\n \"pagination\": {\n \"first_offset\": \"<long>\",\n \"last_offset\": \"<long>\",\n \"limit\": \"<long>\",\n \"next_offset\": \"<long>\",\n \"offset\": \"<long>\",\n \"prev_offset\": \"<long>\",\n \"total\": \"<long>\",\n \"type\": \"<string>\"\n }\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/powerpacks?page[limit]=25&page[offset]=0",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks"
],
"query": [
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of powerpacks in the response."
},
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page."
}
]
}
},
"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}"
}
]
}