Bulk Widget Operations

Bulk edit dashboard widgets

curl --request POST \
  --url https://api.cekura.ai/dashboards/dashboards/{id}/bulk_widgets/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "create": [
    {}
  ],
  "update": [
    {}
  ],
  "delete": [
    123
  ]
}
'

import requests

url = "https://api.cekura.ai/dashboards/dashboards/{id}/bulk_widgets/"

payload = {
    "create": [{}],
    "update": [{}],
    "delete": [123]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({create: [{}], update: [{}], delete: [123]})
};

fetch('https://api.cekura.ai/dashboards/dashboards/{id}/bulk_widgets/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cekura.ai/dashboards/dashboards/{id}/bulk_widgets/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'create' => [
        [
                
        ]
    ],
    'update' => [
        [
                
        ]
    ],
    'delete' => [
        123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cekura.ai/dashboards/dashboards/{id}/bulk_widgets/"

	payload := strings.NewReader("{\n  \"create\": [\n    {}\n  ],\n  \"update\": [\n    {}\n  ],\n  \"delete\": [\n    123\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.cekura.ai/dashboards/dashboards/{id}/bulk_widgets/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"create\": [\n    {}\n  ],\n  \"update\": [\n    {}\n  ],\n  \"delete\": [\n    123\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cekura.ai/dashboards/dashboards/{id}/bulk_widgets/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"create\": [\n    {}\n  ],\n  \"update\": [\n    {}\n  ],\n  \"delete\": [\n    123\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "created": [
    {
      "chart_type": "line",
      "id": 123,
      "dashboard": 123,
      "name": "<string>",
      "filters": {
        "field": "success",
        "op": "eq",
        "value": true
      },
      "effective_filters": {
        "field": "success",
        "op": "eq",
        "value": true
      },
      "data_type": "numeric",
      "field": "duration",
      "metric": 123,
      "metric_name": "<string>",
      "time_period": "hour",
      "aggregation_function": "count",
      "group_by": "<unknown>",
      "metadata": "<unknown>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "updated": [
    {
      "chart_type": "line",
      "id": 123,
      "dashboard": 123,
      "name": "<string>",
      "filters": {
        "field": "success",
        "op": "eq",
        "value": true
      },
      "effective_filters": {
        "field": "success",
        "op": "eq",
        "value": true
      },
      "data_type": "numeric",
      "field": "duration",
      "metric": 123,
      "metric_name": "<string>",
      "time_period": "hour",
      "aggregation_function": "count",
      "group_by": "<unknown>",
      "metadata": "<unknown>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "deleted": [
    123
  ],
  "errors": [
    {}
  ]
}

POST

dashboards

{id}

bulk_widgets

Bulk edit dashboard widgets

curl --request POST \
  --url https://api.cekura.ai/dashboards/dashboards/{id}/bulk_widgets/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "create": [
    {}
  ],
  "update": [
    {}
  ],
  "delete": [
    123
  ]
}
'

import requests

url = "https://api.cekura.ai/dashboards/dashboards/{id}/bulk_widgets/"

payload = {
    "create": [{}],
    "update": [{}],
    "delete": [123]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({create: [{}], update: [{}], delete: [123]})
};

fetch('https://api.cekura.ai/dashboards/dashboards/{id}/bulk_widgets/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cekura.ai/dashboards/dashboards/{id}/bulk_widgets/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'create' => [
        [
                
        ]
    ],
    'update' => [
        [
                
        ]
    ],
    'delete' => [
        123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cekura.ai/dashboards/dashboards/{id}/bulk_widgets/"

	payload := strings.NewReader("{\n  \"create\": [\n    {}\n  ],\n  \"update\": [\n    {}\n  ],\n  \"delete\": [\n    123\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.cekura.ai/dashboards/dashboards/{id}/bulk_widgets/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"create\": [\n    {}\n  ],\n  \"update\": [\n    {}\n  ],\n  \"delete\": [\n    123\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cekura.ai/dashboards/dashboards/{id}/bulk_widgets/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"create\": [\n    {}\n  ],\n  \"update\": [\n    {}\n  ],\n  \"delete\": [\n    123\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "created": [
    {
      "chart_type": "line",
      "id": 123,
      "dashboard": 123,
      "name": "<string>",
      "filters": {
        "field": "success",
        "op": "eq",
        "value": true
      },
      "effective_filters": {
        "field": "success",
        "op": "eq",
        "value": true
      },
      "data_type": "numeric",
      "field": "duration",
      "metric": 123,
      "metric_name": "<string>",
      "time_period": "hour",
      "aggregation_function": "count",
      "group_by": "<unknown>",
      "metadata": "<unknown>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "updated": [
    {
      "chart_type": "line",
      "id": 123,
      "dashboard": 123,
      "name": "<string>",
      "filters": {
        "field": "success",
        "op": "eq",
        "value": true
      },
      "effective_filters": {
        "field": "success",
        "op": "eq",
        "value": true
      },
      "data_type": "numeric",
      "field": "duration",
      "metric": 123,
      "metric_name": "<string>",
      "time_period": "hour",
      "aggregation_function": "count",
      "group_by": "<unknown>",
      "metadata": "<unknown>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "deleted": [
    123
  ],
  "errors": [
    {}
  ]
}

Authorizations

Authorization

string

header

required

OAuth access token issued by Cekura for connected apps.

Path Parameters

string

required

Body

create

object[]

List of widget data objects to create

Show child attributes

update

object[]

List of widget objects with 'id' field for updates

Show child attributes

delete

integer[]

List of widget IDs to delete

Response

200 - application/json

Response serializer for bulk widget operations.

Returns the created, updated, and deleted widgets.

created

object[]

required

List of created widgets

Show child attributes

updated

object[]

required

List of updated widgets

Show child attributes

deleted

integer[]

required

List of deleted widget IDs

errors

object[]

List of errors that occurred during operations

Show child attributes