aYOUne
← Konfiguration API

CustomerDashboards

Singular: CustomerDashboard — Base-URL: https://config-api.ayoune.app — Zugriff: CRUD — Maschinenlesbare Beschreibung (JSON · YAML)

play_circle Jetzt ausprobieren beta

Requests werden über den consumer-app Proxy an *.ayoune.app weitergeleitet. Tokens bleiben im Browser und werden pro Call mitgesendet.

Beispiel-Response (aufgezeichnet) Beispiel

Eine echte, zuvor aufgezeichnete GET /:id-Antwort dieses Endpunkts — nicht der Live-Call oben. Sensible Felder sind maskiert.

{
  "payload": {
    "_id": "65e0b002121b7d48fe15689b",
    "iconConfig": [],
    "active": false,
    "isDraft": true,
    "createdBy": "6045f4d25704710012485569",
    "cards": [],
    "createdAt": "2024-02-29T16:25:38.973Z",
    "updatedAt": "2024-02-29T16:25:38.973Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/customerdashboards/65e0b002121b7d48fe15689b",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "aYOUneDashboards",
        "title": "MODEL_AYOUNEDASHBOARD",
        "href": "https://api.ayoune.app/su/ayounedashboards",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "su.dashboards"
      }
    ],
    "debugId": "6a8e61bca2d283bdc92cf6ea",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_CUSTOMERDASHBOARD",
        "href": "https://api.ayoune.app/config/customerdashboards/65e0b002121b7d48fe15689b/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_CUSTOMERDASHBOARD",
        "href": "https://api.ayoune.app/config/customerdashboards/65e0b002121b7d48fe15689b",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.152.0",
      "core": "2026.319.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "1728",
      "reset": "1787716882",
      "resetDate": "Wed Aug 26 2026"
    },
    "responseTime": 105.051348,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

MethodePathBeschreibungRight
GET /customerdashboards Liste mit Filtern/Paginierung config.customerdashboards.view
GET /customerdashboards/:id Einzelner Datensatz config.customerdashboards.view
POST /customerdashboards Neuen Datensatz erstellen config.customerdashboards.new
PUT /customerdashboards Datensatz aktualisieren config.customerdashboards.edit
DELETE /customerdashboards/:id Datensatz löschen config.customerdashboards.delete

SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

// Alle abrufen
const list = await ay.config.customerDashboards.find().limit(10).exec();

// Einzelnen Datensatz
const one = await ay.config.customerDashboards.findById('OBJECT_ID').exec();

// Erstellen
const created = await ay.config.customerDashboards.create({ name: 'Foo' });

Weiterführend