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": "6a893ffbfe2f32a4c6f1de8d",
    "seedSource": "seedAbschlussquoteDashboardTemplates:v1",
    "slug": "abschlussquote-assignment-appointments",
    "active": true,
    "cards": [
      {
        "widget": "6a893ffbfe2f32a4c6f1de83",
        "x": 0,
        "y": 0,
        "cols": 4,
        "rows": 3
      },
      {
        "widget": "6a893ffbfe2f32a4c6f1de84",
        "x": 4,
        "y": 0,
        "cols": 4,
        "rows": 3
      },
      {
        "widget": "6a893ffbfe2f32a4c6f1de85",
        "x": 8,
        "y": 0,
        "cols": 4,
        "rows": 3
      },
      {
        "widget": "6a893ffbfe2f32a4c6f1de86",
        "x": 0,
        "y": 3,
        "cols": 5,
        "rows": 6
      },
      {
        "widget": "6a893ffbfe2f32a4c6f1de87",
        "x": 5,
        "y": 3,
        "cols": 7,
        "rows": 6
      }
    ],
    "createdAt": "2026-08-22T06:21:47.561Z",
    "description": "Wie viele Termine zu einem Abschluss gefuehrt haben — zwei Zaehler, die Abschlussquote, die Verteilung nach Verknuepfungs-Zustand und die Uebersicht. Nachfolger des Alt-Berichts „reporting.aggregated.assignment-appointments\".",
    "gridsterOptions": {
      "minCols": 12,
      "maxCols": 12
    },
    "licenses": [],
    "name": "Auftraege durch Termine",
    "namespace": "reporting",
    "pageFilter": {
      "timeFrame": "lastWeek",
      "dateField": "start",
      "filters": [],
      "filterValues": {}
    },
    "seedVersion": 1,
    "updatedAt": "2026-08-29T23:58:33.624Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://reporting-api.ayoune.app/customerdashboards/templates/6a893ffbfe2f32a4c6f1de8d",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6a965818d90bbec201d5f31b",
    "errors": [],
    "actions": [],
    "version": {
      "host": "2026.38.0",
      "core": "2026.325.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2272",
      "reset": "1788241353",
      "resetDate": "Tue Sep 01 2026"
    },
    "responseTime": 83.987231,
    "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