aYOUne
← Configuration API

KPITemplates

Singular: KPITemplate — 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": {
    "rawQuery": {
      "model": "consumers"
    },
    "_id": "65e0b02c121b7d48fe157566",
    "active": false,
    "execMode": "interval",
    "scheduled": false,
    "scheduledIntervalUnit": "weekly",
    "interval": 1,
    "intervalUnit": "days",
    "minuteOfHour": 1,
    "timeOfDay": "9",
    "dayOfWeek": "1",
    "dayOfMonth": "1",
    "runs": 0,
    "createdBy": "6045f4d25704710012485569",
    "kpis": [],
    "createdAt": "2024-02-29T16:26:20.097Z",
    "updatedAt": "2024-02-29T16:26:20.097Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/kpitemplates/65e0b02c121b7d48fe157566",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6a62ddc7f27d6098834acdaa",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_KPITEMPLATE",
        "href": "https://api.ayoune.app/config/kpitemplates/65e0b02c121b7d48fe157566/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_KPITEMPLATE",
        "href": "https://api.ayoune.app/config/kpitemplates/65e0b02c121b7d48fe157566/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.95.0",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "1386",
      "reset": "1784865648",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 93.072754,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also