aYOUne
← Reporting API

KPINewsletterTypes

Singular: KPINewsletterType — Base URL: https://reporting-api.ayoune.app — Access: read-only

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": "65e0b1c4121b7d48fe15a01f",
    "sent": 0,
    "delivered": 0,
    "bounced": 0,
    "opened": 0,
    "clicked": 0,
    "pageviews": 0,
    "clickouts": 0,
    "createdBy": "6045f4d25704710012485569",
    "date": "2024-02-29T16:33:08.079Z",
    "createdAt": "2024-02-29T16:33:08.080Z",
    "updatedAt": "2024-02-29T16:33:08.080Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://reporting-api.ayoune.app/kpinewslettertypes/65e0b1c4121b7d48fe15a01f",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "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": "6a6198ddc5e8aca9cc093a2b",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_KPINEWSLETTERTYPE",
        "href": "https://api.ayoune.app/reporting/kpinewslettertypes/65e0b1c4121b7d48fe15a01f/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_KPINEWSLETTERTYPE",
        "href": "https://api.ayoune.app/reporting/kpinewslettertypes/65e0b1c4121b7d48fe15a01f/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.24.0",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2431",
      "reset": "1784784606",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 201.336504,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

MethodPathDescriptionRight
GET /kpinewslettertypes List with filters/pagination reporting.kpinewslettertypes.view
GET /kpinewslettertypes/:id Single record by ID reporting.kpinewslettertypes.view

SDK

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

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

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

See also