aYOUne
← Configuration API

CustomerDashboards

Singular: CustomerDashboard — Base URL: https://config-api.ayoune.app — Access: CRUD

play_circle Try it now beta

Requests are proxied through the consumer-app to *.ayoune.app. Tokens stay in your browser and are forwarded per call.

Example response (recorded) sample

A real, previously recorded GET /:id response of this endpoint — not the live call above. Sensitive fields are masked.

{
  "payload": {
    "_id": "65e0b002121b7d48fe15689b",
    "iconConfig": [],
    "active": false,
    "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": [],
    "debugId": "6a62dd4430b7d778029e7d9b",
    "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/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.94.0",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "1866",
      "reset": "1784865648",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 199.342098,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

MethodPathDescriptionRight
GET /customerdashboards List with filters/pagination config.customerdashboards.view
GET /customerdashboards/:id Single record config.customerdashboards.view
POST /customerdashboards Create new record config.customerdashboards.new
PUT /customerdashboards Update record config.customerdashboards.edit
DELETE /customerdashboards/:id Delete record config.customerdashboards.delete

SDK

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

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

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

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

See also