Chilkat Online Tools

C++ / Datadog API Collection / Get all invitations for a shared dashboard

Back to Collection Items

#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkHttpResponse.h>
#include <CkStringBuilder.h>

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

    CkHttp http;
    bool success;

    CkJsonObject queryParams;
    queryParams.UpdateInt("page_size",-62147425);
    queryParams.UpdateInt("page_number",-62147425);

    http.SetRequestHeader("Accept","application/json");

    CkHttpResponse *resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v1/dashboard/public/:token/invitation",queryParams);
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkStringBuilder sbResponseBody;
    resp->GetBodySb(sbResponseBody);

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = resp->get_StatusCode();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << resp->header() << "\r\n";
        std::cout << "Failed." << "\r\n";
        delete resp;
        return;
    }

    delete resp;

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "data": [
    //     {
    //       "attributes": {
    //         "email": "test@datadoghq.com"
    //       },
    //       "type": "public_dashboard_invitation"
    //     }
    //   ]
    // }

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const char *v_Email = 0;
    const char *v_type = 0;

    int i = 0;
    int count_i = jResp.SizeOfArray("data");
    while (i < count_i) {
        jResp.put_I(i);
        v_Email = jResp.stringOf("data[i].attributes.email");
        v_type = jResp.stringOf("data[i].type");
        i = i + 1;
    }
    }

Curl Command

curl -G -d "page_size=-62147425"
	-d "page_number=-62147425"
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/dashboard/public/:token/invitation

Postman Collection Item JSON

{
  "name": "Get all invitations for a shared dashboard",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/dashboard/public/:token/invitation?page_size=-62147425&page_number=-62147425",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "dashboard",
        "public",
        ":token",
        "invitation"
      ],
      "query": [
        {
          "key": "page_size",
          "value": "-62147425",
          "description": "The number of records to return in a single request."
        },
        {
          "key": "page_number",
          "value": "-62147425",
          "description": "The page to access (base 0)."
        }
      ],
      "variable": [
        {
          "key": "token",
          "value": "tempor Ut sed velit"
        }
      ]
    },
    "description": "Describe the invitations that exist for the given shared dashboard (paginated)."
  },
  "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/v1/dashboard/public/:token/invitation?page_size=-62147425&page_number=-62147425",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "dashboard",
            "public",
            ":token",
            "invitation"
          ],
          "query": [
            {
              "key": "page_size",
              "value": "-62147425",
              "description": "The number of records to return in a single request."
            },
            {
              "key": "page_number",
              "value": "-62147425",
              "description": "The page to access (base 0)."
            }
          ],
          "variable": [
            {
              "key": "token"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": [\n    {\n      \"attributes\": {\n        \"email\": \"test@datadoghq.com\"\n      },\n      \"type\": \"public_dashboard_invitation\"\n    }\n  ]\n}"
    },
    {
      "name": "Forbidden",
      "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/v1/dashboard/public/:token/invitation?page_size=-62147425&page_number=-62147425",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "dashboard",
            "public",
            ":token",
            "invitation"
          ],
          "query": [
            {
              "key": "page_size",
              "value": "-62147425",
              "description": "The number of records to return in a single request."
            },
            {
              "key": "page_number",
              "value": "-62147425",
              "description": "The page to access (base 0)."
            }
          ],
          "variable": [
            {
              "key": "token"
            }
          ]
        }
      },
      "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": "Not Found",
      "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/v1/dashboard/public/:token/invitation?page_size=-62147425&page_number=-62147425",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "dashboard",
            "public",
            ":token",
            "invitation"
          ],
          "query": [
            {
              "key": "page_size",
              "value": "-62147425",
              "description": "The number of records to return in a single request."
            },
            {
              "key": "page_number",
              "value": "-62147425",
              "description": "The page to access (base 0)."
            }
          ],
          "variable": [
            {
              "key": "token"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_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": "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/v1/dashboard/public/:token/invitation?page_size=-62147425&page_number=-62147425",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "dashboard",
            "public",
            ":token",
            "invitation"
          ],
          "query": [
            {
              "key": "page_size",
              "value": "-62147425",
              "description": "The number of records to return in a single request."
            },
            {
              "key": "page_number",
              "value": "-62147425",
              "description": "The page to access (base 0)."
            }
          ],
          "variable": [
            {
              "key": "token"
            }
          ]
        }
      },
      "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}"
    }
  ]
}