aYOUne
← Reporting API

KPIs

Singular: KPI — Base-URL: https://reporting-api.ayoune.app — Zugriff: read-only

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": "66f60aa39a8385592c0bd5db",
    "typ": "consumer:affiliate",
    "count": 0,
    "total": 0,
    "createdAt": "2024-09-27T01:30:11.066Z",
    "updatedAt": "2024-09-27T01:30:11.066Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://reporting-api.ayoune.app/kpis/66f60aa39a8385592c0bd5db",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6a6198dec5e8aca9cc093a5d",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_KPI",
        "href": "https://api.ayoune.app/reporting/kpis/66f60aa39a8385592c0bd5db/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_KPI",
        "href": "https://api.ayoune.app/reporting/kpis/66f60aa39a8385592c0bd5db/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.24.0",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2427",
      "reset": "1784784606",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 172.653675,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

MethodePathBeschreibungRight
GET /kpis Liste mit Filtern/Paginierung reporting.kpis.view
GET /kpis/:id Einzelner Datensatz via ID reporting.kpis.view

SDK

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

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

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

Weiterführend