Chilkat Online Tools

phpExt / Datadog API Collection / Create embed

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$http = new CkHttp();

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "graph_json": "",
//   "legend": "no",
//   "size": "medium",
//   "timeframe": "1_hour",
//   "title": "Embed created through API"
// }

$json = new CkJsonObject();
$json->UpdateString('graph_json','');
$json->UpdateString('legend','no');
$json->UpdateString('size','medium');
$json->UpdateString('timeframe','1_hour');
$json->UpdateString('title','Embed created through API');

$http->SetRequestHeader('Content-Type','application/json');
$http->SetRequestHeader('Accept','application/json');

// resp is a CkHttpResponse
$resp = $http->PostJson3('https://api.app.ddog-gov.com/api/v1/graph/embed','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->get_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)

// {
//   "dash_name": "proident ut commodo",
//   "dash_url": "sint elit",
//   "embed_id": "velit",
//   "graph_title": "Excepteur ea consectetur sunt sint",
//   "html": "non cupidatat in veniam",
//   "revoked": false,
//   "shared_by": 76702863
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

$dash_name = $jResp->stringOf('dash_name');
$dash_url = $jResp->stringOf('dash_url');
$embed_id = $jResp->stringOf('embed_id');
$graph_title = $jResp->stringOf('graph_title');
$html = $jResp->stringOf('html');
$revoked = $jResp->BoolOf('revoked');
$shared_by = $jResp->IntOf('shared_by');

?>

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "graph_json": "",
  "legend": "no",
  "size": "medium",
  "timeframe": "1_hour",
  "title": "Embed created through API"
}'
https://api.app.ddog-gov.com/api/v1/graph/embed

Postman Collection Item JSON

{
  "name": "Create embed",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"graph_json\": \"\",\n  \"legend\": \"no\",\n  \"size\": \"medium\",\n  \"timeframe\": \"1_hour\",\n  \"title\": \"Embed created through API\"\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v1/graph/embed",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "graph",
        "embed"
      ]
    },
    "description": "Creates a new embeddable graph.\n\nNote: If an embed already exists for the exact same query in a given organization,\nthe older embed is returned instead of creating a new embed.\n\nIf you are interested in using template variables, see\n[Embeddable Graphs with Template Variables](https://docs.datadoghq.com/dashboards/faq/embeddable-graphs-with-template-variables)."
  },
  "response": [
    {
      "name": "Payload accepted",
      "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  \"graph_json\": \"\",\n  \"legend\": \"no\",\n  \"size\": \"medium\",\n  \"timeframe\": \"1_hour\",\n  \"title\": \"Embed created through API\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/graph/embed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "graph",
            "embed"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"dash_name\": \"proident ut commodo\",\n  \"dash_url\": \"sint elit\",\n  \"embed_id\": \"velit\",\n  \"graph_title\": \"Excepteur ea consectetur sunt sint\",\n  \"html\": \"non cupidatat in veniam\",\n  \"revoked\": false,\n  \"shared_by\": 76702863\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  \"graph_json\": \"\",\n  \"legend\": \"no\",\n  \"size\": \"medium\",\n  \"timeframe\": \"1_hour\",\n  \"title\": \"Embed created through API\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/graph/embed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "graph",
            "embed"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    },
    {
      "name": "Authentication Error",
      "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  \"graph_json\": \"\",\n  \"legend\": \"no\",\n  \"size\": \"medium\",\n  \"timeframe\": \"1_hour\",\n  \"title\": \"Embed created through API\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/graph/embed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "graph",
            "embed"
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\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  \"graph_json\": \"\",\n  \"legend\": \"no\",\n  \"size\": \"medium\",\n  \"timeframe\": \"1_hour\",\n  \"title\": \"Embed created through API\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/graph/embed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "graph",
            "embed"
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    }
  ]
}