Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new COM("Chilkat_9_5_0.Http");
// 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": {
// "id": "<string>",
// "type": "spans_metrics",
// "attributes": {
// "compute": {
// "aggregation_type": "count",
// "include_percentiles": "<boolean>",
// "path": "<string>"
// },
// "filter": {
// "query": "*"
// },
// "group_by": [
// {
// "path": "<string>",
// "tag_name": "<string>"
// },
// {
// "path": "<string>",
// "tag_name": "<string>"
// }
// ]
// }
// }
// }
$json = new COM("Chilkat_9_5_0.JsonObject");
$json->UpdateString('data.id','<string>');
$json->UpdateString('data.type','spans_metrics');
$json->UpdateString('data.attributes.compute.aggregation_type','count');
$json->UpdateString('data.attributes.compute.include_percentiles','<boolean>');
$json->UpdateString('data.attributes.compute.path','<string>');
$json->UpdateString('data.attributes.filter.query','*');
$json->UpdateString('data.attributes.group_by[0].path','<string>');
$json->UpdateString('data.attributes.group_by[0].tag_name','<string>');
$json->UpdateString('data.attributes.group_by[1].path','<string>');
$json->UpdateString('data.attributes.group_by[1].tag_name','<string>');
$http->SetRequestHeader('Content-Type','application/json');
$http->SetRequestHeader('Accept','application/json');
// resp is a Chilkat_9_5_0.HttpResponse
$resp = $http->PostJson3('https://api.app.ddog-gov.com/api/v2/apm/config/metrics','application/json',$json);
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
$sbResponseBody = new COM("Chilkat_9_5_0.StringBuilder");
$resp->GetBodySb($sbResponseBody);
$jResp = new COM("Chilkat_9_5_0.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->Header . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": {
// "attributes": {
// "compute": {
// "aggregation_type": "distribution",
// "include_percentiles": "<boolean>",
// "path": "<string>"
// },
// "filter": {
// "query": "<string>"
// },
// "group_by": [
// {
// "path": "<string>",
// "tag_name": "<string>"
// },
// {
// "path": "<string>",
// "tag_name": "<string>"
// }
// ]
// },
// "id": "<string>",
// "type": "spans_metrics"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$Aggregation_type = $jResp->stringOf('data.attributes.compute.aggregation_type');
$Include_percentiles = $jResp->stringOf('data.attributes.compute.include_percentiles');
$Path = $jResp->stringOf('data.attributes.compute.path');
$Query = $jResp->stringOf('data.attributes.filter.query');
$Id = $jResp->stringOf('data.id');
$v_Type = $jResp->stringOf('data.type');
$i = 0;
$count_i = $jResp->SizeOfArray('data.attributes.group_by');
while ($i < $count_i) {
$jResp->I = $i;
$path = $jResp->stringOf('data.attributes.group_by[i].path');
$tag_name = $jResp->stringOf('data.attributes.group_by[i].tag_name');
$i = $i + 1;
}
?>
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"id": "<string>",
"type": "spans_metrics",
"attributes": {
"compute": {
"aggregation_type": "count",
"include_percentiles": "<boolean>",
"path": "<string>"
},
"filter": {
"query": "*"
},
"group_by": [
{
"path": "<string>",
"tag_name": "<string>"
},
{
"path": "<string>",
"tag_name": "<string>"
}
]
}
}
}'
https://api.app.ddog-gov.com/api/v2/apm/config/metrics
Postman Collection Item JSON
{
"name": "Create a span-based metric",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"spans_metrics\",\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"count\",\n \"include_percentiles\": \"<boolean>\",\n \"path\": \"<string>\"\n },\n \"filter\": {\n \"query\": \"*\"\n },\n \"group_by\": [\n {\n \"path\": \"<string>\",\n \"tag_name\": \"<string>\"\n },\n {\n \"path\": \"<string>\",\n \"tag_name\": \"<string>\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics"
]
},
"description": "Create a metric based on your ingested spans in your organization.\nReturns the span-based metric object from the request body when the request is successful."
},
"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 \"id\": \"<string>\",\n \"type\": \"spans_metrics\",\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"count\",\n \"include_percentiles\": \"<boolean>\",\n \"path\": \"<string>\"\n },\n \"filter\": {\n \"query\": \"*\"\n },\n \"group_by\": [\n {\n \"path\": \"<string>\",\n \"tag_name\": \"<string>\"\n },\n {\n \"path\": \"<string>\",\n \"tag_name\": \"<string>\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"distribution\",\n \"include_percentiles\": \"<boolean>\",\n \"path\": \"<string>\"\n },\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"group_by\": [\n {\n \"path\": \"<string>\",\n \"tag_name\": \"<string>\"\n },\n {\n \"path\": \"<string>\",\n \"tag_name\": \"<string>\"\n }\n ]\n },\n \"id\": \"<string>\",\n \"type\": \"spans_metrics\"\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 \"id\": \"<string>\",\n \"type\": \"spans_metrics\",\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"count\",\n \"include_percentiles\": \"<boolean>\",\n \"path\": \"<string>\"\n },\n \"filter\": {\n \"query\": \"*\"\n },\n \"group_by\": [\n {\n \"path\": \"<string>\",\n \"tag_name\": \"<string>\"\n },\n {\n \"path\": \"<string>\",\n \"tag_name\": \"<string>\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics"
]
}
},
"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 \"data\": {\n \"id\": \"<string>\",\n \"type\": \"spans_metrics\",\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"count\",\n \"include_percentiles\": \"<boolean>\",\n \"path\": \"<string>\"\n },\n \"filter\": {\n \"query\": \"*\"\n },\n \"group_by\": [\n {\n \"path\": \"<string>\",\n \"tag_name\": \"<string>\"\n },\n {\n \"path\": \"<string>\",\n \"tag_name\": \"<string>\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics"
]
}
},
"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": "Conflict",
"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 \"id\": \"<string>\",\n \"type\": \"spans_metrics\",\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"count\",\n \"include_percentiles\": \"<boolean>\",\n \"path\": \"<string>\"\n },\n \"filter\": {\n \"query\": \"*\"\n },\n \"group_by\": [\n {\n \"path\": \"<string>\",\n \"tag_name\": \"<string>\"\n },\n {\n \"path\": \"<string>\",\n \"tag_name\": \"<string>\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics"
]
}
},
"status": "Conflict",
"code": 409,
"_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 \"id\": \"<string>\",\n \"type\": \"spans_metrics\",\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"count\",\n \"include_percentiles\": \"<boolean>\",\n \"path\": \"<string>\"\n },\n \"filter\": {\n \"query\": \"*\"\n },\n \"group_by\": [\n {\n \"path\": \"<string>\",\n \"tag_name\": \"<string>\"\n },\n {\n \"path\": \"<string>\",\n \"tag_name\": \"<string>\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics"
]
}
},
"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}"
}
]
}
