aYOUne
← Reporting API

KPIMails

Singular: KPIMail — 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": "65e0b1c2121b7d48fe159fec",
    "sent": 0,
    "delivered": 0,
    "bounced": 0,
    "opened": 0,
    "clicked": 0,
    "pageviews": 0,
    "clickouts": 0,
    "createdBy": "6045f4d25704710012485569",
    "date": "2024-02-29T16:33:06.377Z",
    "createdAt": "2024-02-29T16:33:06.378Z",
    "updatedAt": "2024-02-29T16:33:06.378Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://reporting-api.ayoune.app/kpimails/65e0b1c2121b7d48fe159fec",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Campaigns",
        "title": "MODEL_CAMPAIGN",
        "href": "https://api.ayoune.app/marketing/campaigns",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "marketing.campaigns"
      },
      {
        "rel": "Mails",
        "title": "MODEL_MAIL",
        "href": "https://api.ayoune.app/config/mails",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.mails"
      },
      {
        "rel": "Newsletters",
        "title": "MODEL_NEWSLETTER",
        "href": "https://api.ayoune.app/marketing/newsletters",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "marketing.newsletters"
      },
      {
        "rel": "SenderBrands",
        "title": "MODEL_SENDERBRAND",
        "href": "https://api.ayoune.app/config/senderbrands",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.senderbrands"
      },
      {
        "rel": "NewsletterTypes",
        "title": "MODEL_NEWSLETTERTYPE",
        "href": "https://api.ayoune.app/config/newslettertypes",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.newslettertypes"
      }
    ],
    "debugId": "6a6198dcc5e8aca9cc093a00",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_KPIMAIL",
        "href": "https://api.ayoune.app/reporting/kpimails/65e0b1c2121b7d48fe159fec/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_KPIMAIL",
        "href": "https://api.ayoune.app/reporting/kpimails/65e0b1c2121b7d48fe159fec/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.24.0",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2435",
      "reset": "1784784606",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 207.755894,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

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

SDK

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

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

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

Weiterführend