Skip to main content
POST
/
api
/
v1
/
runtime
/
observability
/
dashboard-cards
Upsert a dashboard card (CLI metrics sync)
curl --request POST \
  --url https://api.runflow.ai/api/v1/runtime/observability/dashboard-cards \
  --header 'Content-Type: application/json' \
  --data '
{
  "agentId": "<string>",
  "title": "<string>",
  "config": {},
  "tabId": "<string>",
  "gridLayout": {
    "x": 123,
    "y": 123,
    "w": 123,
    "h": 123
  },
  "sortOrder": 123,
  "idempotencyKey": "<string>"
}
'
import requests

url = "https://api.runflow.ai/api/v1/runtime/observability/dashboard-cards"

payload = {
"agentId": "<string>",
"title": "<string>",
"config": {},
"tabId": "<string>",
"gridLayout": {
"x": 123,
"y": 123,
"w": 123,
"h": 123
},
"sortOrder": 123,
"idempotencyKey": "<string>"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
agentId: '<string>',
title: '<string>',
config: {},
tabId: '<string>',
gridLayout: {x: 123, y: 123, w: 123, h: 123},
sortOrder: 123,
idempotencyKey: '<string>'
})
};

fetch('https://api.runflow.ai/api/v1/runtime/observability/dashboard-cards', 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.runflow.ai/api/v1/runtime/observability/dashboard-cards",
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([
'agentId' => '<string>',
'title' => '<string>',
'config' => [

],
'tabId' => '<string>',
'gridLayout' => [
'x' => 123,
'y' => 123,
'w' => 123,
'h' => 123
],
'sortOrder' => 123,
'idempotencyKey' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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.runflow.ai/api/v1/runtime/observability/dashboard-cards"

payload := strings.NewReader("{\n \"agentId\": \"<string>\",\n \"title\": \"<string>\",\n \"config\": {},\n \"tabId\": \"<string>\",\n \"gridLayout\": {\n \"x\": 123,\n \"y\": 123,\n \"w\": 123,\n \"h\": 123\n },\n \"sortOrder\": 123,\n \"idempotencyKey\": \"<string>\"\n}")

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

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.runflow.ai/api/v1/runtime/observability/dashboard-cards")
.header("Content-Type", "application/json")
.body("{\n \"agentId\": \"<string>\",\n \"title\": \"<string>\",\n \"config\": {},\n \"tabId\": \"<string>\",\n \"gridLayout\": {\n \"x\": 123,\n \"y\": 123,\n \"w\": 123,\n \"h\": 123\n },\n \"sortOrder\": 123,\n \"idempotencyKey\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.runflow.ai/api/v1/runtime/observability/dashboard-cards")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"agentId\": \"<string>\",\n \"title\": \"<string>\",\n \"config\": {},\n \"tabId\": \"<string>\",\n \"gridLayout\": {\n \"x\": 123,\n \"y\": 123,\n \"w\": 123,\n \"h\": 123\n },\n \"sortOrder\": 123,\n \"idempotencyKey\": \"<string>\"\n}"

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

Body

application/json
agentId
string
required

Agent UUID

title
string
required
cardType
enum<string>
required

Card visualization type. All 8 types supported: number, rate, line, bar, pie, table, funnel, gauge.

Available options:
number,
rate,
line,
bar,
pie,
table,
funnel,
gauge
config
object
required

Card-type-specific config. Polymorphic shape — see @runflow/shared dashboard-cards types for the per-type required fields.

tabId
string

Optional dashboard tab (UUID).

gridLayout
object

Optional grid position (x, y, w, h). Stored in config.

sortOrder
number
idempotencyKey
string

Optional caller-supplied key.

Response

Card upserted successfully.