aYOUne
← Reporting API

KPICampaignMails

Singular: KPICampaignMail — 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": "66e8cd8f2d69c9d599e9cef4",
    "campaign": "65e074f17631a977e1babdb6",
    "date": "2024-09-16T00:00:00.000Z",
    "bounced": 0,
    "clicked": 0,
    "clickouts": 0,
    "createdAt": "2024-09-17T00:30:07.895Z",
    "delivered": 0,
    "opened": 0,
    "pageviews": 0,
    "sent": 0,
    "updatedAt": "2024-09-17T00:30:07.895Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://reporting-api.ayoune.app/kpicampaignmails/66e8cd8f2d69c9d599e9cef4",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "Campaigns",
        "title": "MODEL_CAMPAIGN",
        "href": "https://api.ayoune.app/marketing/campaigns/65e074f17631a977e1babdb6",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "marketing.campaigns"
      }
    ],
    "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"
      }
    ],
    "debugId": "6a6198dcc5e8aca9cc0939c5",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_KPICAMPAIGNMAIL",
        "href": "https://api.ayoune.app/reporting/kpicampaignmails/66e8cd8f2d69c9d599e9cef4/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_KPICAMPAIGNMAIL",
        "href": "https://api.ayoune.app/reporting/kpicampaignmails/66e8cd8f2d69c9d599e9cef4/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.24.0",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2439",
      "reset": "1784784606",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 201.258214,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

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

SDK

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

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

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

Weiterführend