Chilkat Online Tools

Android / Datadog API Collection / Get all dashboards

Back to Collection Items

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

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

    CkHttp http = new CkHttp();
    boolean success;

    CkJsonObject queryParams = new CkJsonObject();
    queryParams.UpdateString("filter[shared]","false");
    queryParams.UpdateString("filter[deleted]","false");

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

    CkHttpResponse resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v1/dashboard",queryParams);
    if (http.get_LastMethodSuccess() == false) {
        Log.i(TAG, http.lastErrorText());
        return;
        }

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    resp.GetBodySb(sbResponseBody);

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

    Log.i(TAG, "Response Body:");
    Log.i(TAG, jResp.emit());

    int respStatusCode = resp.get_StatusCode();
    Log.i(TAG, "Response Status Code = " + String.valueOf(respStatusCode));
    if (respStatusCode >= 400) {
        Log.i(TAG, "Response Header:");
        Log.i(TAG, resp.header());
        Log.i(TAG, "Failed.");

        return;
        }

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

    // {
    //   "dashboards": [
    //     {
    //       "author_handle": "Duis tempor ex",
    //       "created_at": "1963-12-20T01:10:02.870Z",
    //       "description": "esse cillum laboris",
    //       "id": "do Ut",
    //       "is_read_only": true,
    //       "layout_type": "ordered",
    //       "modified_at": "1958-09-05T14:28:29.291Z",
    //       "title": "nulla velit tempor",
    //       "url": "quis laboris irure id"
    //     },
    //     {
    //       "author_handle": "cup",
    //       "created_at": "1992-05-21T18:14:01.464Z",
    //       "description": "proident incididunt dolore",
    //       "id": "in deserunt irure",
    //       "is_read_only": false,
    //       "layout_type": "ordered",
    //       "modified_at": "1971-12-02T02:50:20.074Z",
    //       "title": "ut dolor in consequat fugiat",
    //       "url": "culpa Duis mollit"
    //     }
    //   ]
    // }

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

    String author_handle;
    String created_at;
    String description;
    String id;
    boolean is_read_only;
    String layout_type;
    String modified_at;
    String title;
    String url;

    int i = 0;
    int count_i = jResp.SizeOfArray("dashboards");
    while (i < count_i) {
        jResp.put_I(i);
        author_handle = jResp.stringOf("dashboards[i].author_handle");
        created_at = jResp.stringOf("dashboards[i].created_at");
        description = jResp.stringOf("dashboards[i].description");
        id = jResp.stringOf("dashboards[i].id");
        is_read_only = jResp.BoolOf("dashboards[i].is_read_only");
        layout_type = jResp.stringOf("dashboards[i].layout_type");
        modified_at = jResp.stringOf("dashboards[i].modified_at");
        title = jResp.stringOf("dashboards[i].title");
        url = jResp.stringOf("dashboards[i].url");
        i = i + 1;
        }


  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}

Curl Command

curl -G -d "filter[shared]=false"
	-d "filter[deleted]=false"
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/dashboard

Postman Collection Item JSON

{
  "name": "Get all dashboards",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/dashboard?filter[shared]=false&filter[deleted]=false",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "dashboard"
      ],
      "query": [
        {
          "key": "filter[shared]",
          "value": "false",
          "description": "When `true`, this query only returns shared custom created\nor cloned dashboards."
        },
        {
          "key": "filter[deleted]",
          "value": "false",
          "description": "When `true`, this query returns only deleted custom-created\nor cloned dashboards. This parameter is incompatible with `filter[shared]`."
        }
      ]
    },
    "description": "Get all dashboards.\n\n**Note**: This query will only return custom created or cloned dashboards.\nThis query will not return preset dashboards."
  },
  "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?filter[shared]=false&filter[deleted]=false",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "dashboard"
          ],
          "query": [
            {
              "key": "filter[shared]",
              "value": "false",
              "description": "When `true`, this query only returns shared custom created\nor cloned dashboards."
            },
            {
              "key": "filter[deleted]",
              "value": "false",
              "description": "When `true`, this query returns only deleted custom-created\nor cloned dashboards. This parameter is incompatible with `filter[shared]`."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"dashboards\": [\n    {\n      \"author_handle\": \"Duis tempor ex\",\n      \"created_at\": \"1963-12-20T01:10:02.870Z\",\n      \"description\": \"esse cillum laboris\",\n      \"id\": \"do Ut\",\n      \"is_read_only\": true,\n      \"layout_type\": \"ordered\",\n      \"modified_at\": \"1958-09-05T14:28:29.291Z\",\n      \"title\": \"nulla velit tempor\",\n      \"url\": \"quis laboris irure id\"\n    },\n    {\n      \"author_handle\": \"cup\",\n      \"created_at\": \"1992-05-21T18:14:01.464Z\",\n      \"description\": \"proident incididunt dolore\",\n      \"id\": \"in deserunt irure\",\n      \"is_read_only\": false,\n      \"layout_type\": \"ordered\",\n      \"modified_at\": \"1971-12-02T02:50:20.074Z\",\n      \"title\": \"ut dolor in consequat fugiat\",\n      \"url\": \"culpa Duis mollit\"\n    }\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/v1/dashboard?filter[shared]=false&filter[deleted]=false",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "dashboard"
          ],
          "query": [
            {
              "key": "filter[shared]",
              "value": "false",
              "description": "When `true`, this query only returns shared custom created\nor cloned dashboards."
            },
            {
              "key": "filter[deleted]",
              "value": "false",
              "description": "When `true`, this query returns only deleted custom-created\nor cloned dashboards. This parameter is incompatible with `filter[shared]`."
            }
          ]
        }
      },
      "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": "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?filter[shared]=false&filter[deleted]=false",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "dashboard"
          ],
          "query": [
            {
              "key": "filter[shared]",
              "value": "false",
              "description": "When `true`, this query only returns shared custom created\nor cloned dashboards."
            },
            {
              "key": "filter[deleted]",
              "value": "false",
              "description": "When `true`, this query returns only deleted custom-created\nor cloned dashboards. This parameter is incompatible with `filter[shared]`."
            }
          ]
        }
      },
      "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}"
    }
  ]
}