Yeni: Yapay zekâ güvenlik duvarı tüm platformu izliyor ve her olayı sade bir dille açıklıyor. Nasıl çalıştığını görün

Panolar API’si

Panoları listelemek, okumak, oluşturmak, değiştirmek, kopyalamak, dışa ve içe aktarmak, şablonlardan başlatmak ve ekran bağlantılarını koddan yönetmek için kullanılan rotalar.

Bu yollar bir betiğin ya da başka bir sistemin panolarla (dashboard) çalışmasına olanak tanır: listesini tutmak, bir panoyu kopyalamak, dosya olarak yedeklemek, başka bir kuruluşa taşımak veya şablonlardan pano oluşturmak. Panoların insanlar için nasıl çalıştığı Pano oluşturma ve düzenleme ve Panoları paylaşma bölümlerinde anlatılmıştır.

Yollar https://<your host>/tenant/<tenantId> altındadır. Kurallar (katı gövdeler, hatalar, hız sınırları) REST API temelleri bölümündedir.

Bir anahtarın gördüğü panolar

Bir anahtar, onu tutan üye olarak işlem yapar (bkz. Kimlik doğrulama). Panolar için bu şu anlama gelir:

  • Paylaşılan panolar (scope: "TENANT"), anahtar dashboard.boards.read iznine sahipse anahtar tarafından görülebilir. Birini değiştirmek, silmek veya oluşturmak için anahtarın kendisinde dashboard.boards.manage izni de gerekir.
  • Kişisel panolar (scope: "PRIVATE") anahtar sahibinin kendisine aittir. Başka bir üyenin kişisel panosu, var olmayan bir pano gibi 404 yanıtı verir.
  • Anahtar sahibinin görmesine izin verilmeyen widget’a sahip bir kart kopyalardan ve dosyalardan çıkarılır ve skipped içinde adı belirtilir.

Yollar

YöntemYolİzinİşlevi
GET/api/dashboard/boardsdashboard.boards.readAnahtarın açabildiği panoları listeler
POST/api/dashboard/boardsdashboard.boards.writeBoş bir pano oluşturur
GET/api/dashboard/boards/{boardId}dashboard.boards.readKartlarıyla birlikte tek bir pano
PATCH/api/dashboard/boards/{boardId}dashboard.boards.writeBaşlığı, açıklamayı, simgeyi, ızgarayı, zaman aralığını, parametreleri, sayfaları değiştirir; kişisel bir panoyu paylaşır
DELETE/api/dashboard/boards/{boardId}dashboard.boards.writePanoyu ve kartlarını siler
POST/api/dashboard/boards/{boardId}/duplicatedashboard.boards.writeBir panoyu kopyalar
GET/api/dashboard/boards/{boardId}/exportdashboard.boards.readPanoyu pano dosyası olarak verir
POST/api/dashboard/boards/importdashboard.boards.writeBir pano dosyasını denetler (deneme çalıştırması) ya da içe aktarır
GET/api/dashboard/boards/templates?for=newdashboard.boards.readYeni bir panonun başlayabileceği şablonlar
POST/api/dashboard/boards/templates/{templateKey}/applydashboard.boards.writeBir şablondan pano oluşturur
GET, POST/api/dashboard/boards/{boardId}/display-linksdashboard.boards.manageBir panonun ekran bağlantılarını listeler veya yeni bir bağlantı oluşturur
DELETE/api/dashboard/boards/{boardId}/display-links/{linkId}dashboard.boards.manageBir ekran bağlantısını iptal eder

Paylaşılan bir panoyu oluşturan veya değiştiren her yazma işlemi ayrıca dashboard.boards.manage gerektirir; bu izin yoksa yanıt 403 “Only an admin may create or change a shared dashboard” olur. Varsayılan roller: okuma ve yazma Kullanıcı izinleridir, manage ise Yönetici iznidir.

Pano düzenleyicisi ve tarayıcıdaki pano görünümü başka yollar kullanır (kartları yerleştirme ve taşıma, bir kartın sorgusunu çalıştırma, widget kütüphanesi, özelleştirirken tutulan kopya). Bunlar bu başvuru kapsamında değildir. Kartları koddan değiştirmek için panoyu dışa aktarın, dosyayı düzenleyin ve içe aktarın.

Panoları listele

GET /api/dashboard/boards sayfalama parametreleri olmadan, anahtarın açabildiği tüm panoları yanıtlar:

{
  "boards": [
    {
      "boardId": "2c7d…", "title": "Cold rooms", "description": null, "icon": null,
      "scope": "TENANT", "workspace": null, "moduleId": null, "isDefault": false,
      "gridCols": 12, "revision": 14, "createdByUserId": "u-55…",
      "createdAt": "2026-10-02T08:00:00.000Z", "updatedAt": "2026-11-12T09:30:00.000Z",
      "canWrite": true, "ownerLabel": "Ana Lima", "…": "…"
    }
  ],
  "canManage": true
}

page veya pageSize ile tek bir sayfa { "data": [...], "total": n, "canManage": true } olarak yanıtlanır. Sayfalar 0‘dan başlar; pageSize 1 ile 100 arasındadır (varsayılan 20); search en fazla 200 karakterdir; sort title, updatedAt, scope veya workspace ile sıralanır (varsayılan updatedAt:desc); filtreler scope (TENANT, PRIVATE) ve workspace (virgülle ayrılmış liste; pano menüsünde olmayan panolar için none). Anahtar dashboard.boards.manage iznine sahipse sharedQuota: { used, limit } almak için quota=1 ekleyin (limit boşsa sınır yoktur).

GET /api/dashboard/boards/{boardId}, { board, instances, widgets, pinned } yanıtı verir: panoyu, kartlarını (yer, boyut, başlık, ayarlar, veri bağlamaları, eylemler) ve kullandıkları widget’ları.

Oluşturma, değiştirme ve silme

POST /api/dashboard/boards şunları alır:

AlanKural
titleZorunlu, 1 ile 120 karakter
descriptionEn fazla 1.000 karakter
iconEn fazla 64 karakter
scopeTENANT (varsayılan) veya PRIVATE; dashboard.boards.manage izni olmayan anahtar PRIVATE göndermelidir
workspace veya moduleIdPanoyu gösteren çalışma alanı menüsü; ikisi birden olmaz
isDefaulttrue, panonun çalışma alanı menüsünde ilk açılan pano olmasını sağlar
gridCols12 (varsayılan) veya 24

Yanıt 201 { "board": {...} } olur. Slug başlıktan üretilir; siz gönderemezsiniz.

PATCH aynı alanları kabul eder (workspace ve moduleId hariç), buna ek olarak settings, timeWindow, params, filters, pages ve mainPage alanlarını alır ve yalnızca gönderdiğiniz şeyleri değiştirir. Panoyu okuduğunuzda aldığınız revision değerini expectedRevision olarak gönderin; pano sizin yüklemenizden sonra başkası tarafından değiştirilmişse, daha yeni bir değişikliğin üzerine yazmak yerine 409 “This dashboard was changed by someone else since you loaded it” yanıtıyla reddedilirsiniz. "scope": "TENANT" bir kişisel panoyu paylaşır; paylaşılan bir pano bir daha kişisel yapılamaz. DELETE { "ok": true } yanıtı verir.

Bir panoyu kopyalama

POST /api/dashboard/boards/{boardId}/duplicate, { "title": "Cold rooms (night shift)", "scope": "PRIVATE" } ile çağrılır (ikisi de isteğe bağlıdır; varsayılan başlığa ” (copy)” eklenir, varsayılan scope PRIVATE‘tır). Yanıt 201 { board, skipped, droppedCommands } olur: skipped, widget’ı kopyalanamayan kartları listeler; droppedCommands, anahtar sahibinin kurmasına izin verilmeyen komut eylemlerini sayar ve bunlar kaldırılmıştır.

Pano dosyaları: dışa ve içe aktarma

Dosya biçimi ve içeriği Pano şablonları ve pano dosyaları bölümünde açıklanmıştır.

  • GET .../export dosyanın kendisini yanıtlar (Content-Disposition: attachment). Bunun yerine JSON olarak { package, skipped } almak için report=1 ekleyin. Bu panonun eylemlerinin açtığı panoları tek bir dosyaya dahil etmek için linked=1 ekleyin (en fazla 20 pano; alınmayanları leftOut adlandırır).
  • POST /api/dashboard/boards/import, { "package": <the file>, "dryRun": true, "title": "…", "scope": "PRIVATE" } alır. dryRun varsayılan olarak true‘dur: { dryRun: true, report } yanıtı neyin içe aktarılacağını, onarılacağını veya atlanacağını bildirir ve hiçbir şey yazmaz. Panoyu oluşturmak için "dryRun": false gönderin: 201 { dryRun: false, board, report }. Birden çok pano içeren bir dosya için boards, oluşturulan her panoyu listeler; hepsi birlikte oluşturulur ya da hiçbiri oluşturulmaz.

Bir anahtar yalnızca kendi kuruluşunda çalışır; bu nedenle bir panoyu taşımak için her iki kuruluşta da birer anahtar gerekir:

curl -s 'https://<your-host>/tenant/{sourceTenantId}/api/dashboard/boards/{boardId}/export' \
  -H 'Authorization: Bearer sk_live_…source key…' > cold-rooms.board.json

jq '{package: ., dryRun: true}' cold-rooms.board.json | \
curl -X POST 'https://<your-host>/tenant/{targetTenantId}/api/dashboard/boards/import' \
  -H 'Authorization: Bearer sk_live_…target key…' \
  -H 'Content-Type: application/json' \
  -d @-

report.issues alanını okuyun, ardından aynı gövdeyi "dryRun": false ile gönderin.

Bir şablondan başlayın

GET /api/dashboard/boards/templates?for=new, yeni bir panonun başlayabileceği şablonları listeler: key, title, description, cardCount, pageCount, paramCount ve bir soru soran şablon için ask. Kuruluşunuzda kapalı olan modüllerin şablonları listelenmez.

POST /api/dashboard/boards/templates/{templateKey}/apply ile asNew birlikte çağrıldığında yeni bir pano oluşturur:

{
  "asNew": { "title": "Plant sites", "scope": "TENANT", "description": null, "workspace": null },
  "answers": { "sites": { "choose": "all" } }
}

answers yalnızca soru soran bir şablon için kullanılır: anahtar, şablonun ask.param değeridir; değer ise { "choose": "all" }, { "choose": "subtype", "subtype": "…" } veya { "choose": "under", "entityId": "…" } değerlerinden biridir. Yanıt 201 { board, created: true, skipped, droppedCommands } şeklindedir. asNew yerine { "boardId": "…" } gönderilirse şablonun kartları mevcut bir panonun kartlarının altına eklenir (200, created: false).

Ekran bağlantısı, kimsenin oturum açmadığı bir ekranda bir panoyu gösterir. { "label": "Lobby TV", "expiresInDays": 30 } ile POST .../display-links isteği 201 { link, token, url } yanıtını verir; token ve adres yalnızca bu yanıtta bulunur. Bağlantının düzenleyicisi anahtarın sahibidir ve ekran, panoyu sahibin yetkileriyle gösterir. GET bağlantıları (status değeri active, expired veya revoked) token olmadan listeler; DELETE .../display-links/{linkId} bir bağlantıyı iptal eder. Bkz. Duvar ekranları, tam ekran ve yakınlaştırma.

Hatalar

DurumMesaj
400Validation error ile birlikte issues (tanınmayan bir alan, aralık dışında bir değer)
403Paylaşılan bir panoyu yalnızca yönetici oluşturabilir veya değiştirebilir
403Planınız daha fazla paylaşılan pano izni vermez (details.reason shared_board_limit, used ve limit ile birlikte)
403Kişisel pano sınırınıza ulaştınız (personal_board_limit)
403Bu bileşeni yerleştirmenize izin verilmiyor (anahtar sahibinin kartlarını kullanamayacağı bir şablon)
404Pano bulunamadı / Bilinmeyen pano şablonu
409Bu pano, siz yükledikten sonra başka biri tarafından değiştirildi
409Bir pano parametresi hâlâ bir bileşen bağlantısında kullanılıyor ve kaldırılamaz (aynısı, hâlâ kullanımda olan bir sayfa veya filtre için de geçerlidir)
409Bu panonun izin verilen etkin ekran bağlantısı sayısı üst sınıra ulaştı
422Özel bir bileşen paylaşılan bir panoya yerleştirilemez (bu tür kartları içeren panoyu paylaşmak; details.placements bunları adlandırır)
422Paylaşılan bir panonun yerini tutan kişisel bir kopya paylaşılamaz; bunun yerine paylaşılan pano olarak çoğaltın
422Bu dosya, bu uygulamanın içe aktaramadığı bir pano paket biçimini kullanıyor / daha yeni bir sürümle dışa aktarılmış

Sınırlar

SınırDeğer
Paylaşılan panolarPlanınız tarafından belirlenir; bkz. Kullanım ve kotalar
Kişisel panolarÜye (anahtar sahibi) başına 20
Tek bir pano dosyasındaki kart sayısı200
Bağlantılı tek bir dosyadaki pano sayısı20
Ekran bağlantılarıPano başına 20 etkin; 1 ila 365 gün, varsayılan 30; etiket en fazla 80 karakter
İstek hızıHer API anahtarında olduğu gibi; bkz. Hatalar ve istek hızı sınırları