aYOUne
← Marketing API

Ratings

Singular: Rating — Base URL: https://marketing-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": {
    "_id": "65e0b145121b7d48fe1593a0",
    "interestchannels": [],
    "done": false,
    "approved": false,
    "rejected": false,
    "web": false,
    "image": "https://cdn1.iconfinder.com/data/icons/user-pictures/100/unknown-64.png",
    "displayName": "",
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2024-02-29T16:31:01.389Z",
    "updatedAt": "2024-02-29T16:31:01.389Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://marketing-api.ayoune.app/ratings/65e0b145121b7d48fe1593a0",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Consumers",
        "title": "MODEL_CONSUMER",
        "href": "https://api.ayoune.app/crm/consumers",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.consumers"
      },
      {
        "rel": "Products",
        "title": "MODEL_PRODUCT",
        "href": "https://api.ayoune.app/pim/products",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pim.products"
      }
    ],
    "debugId": "6a6194b9f78ad61f1990f99c",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_RATING",
        "href": "https://api.ayoune.app/marketing/ratings/65e0b145121b7d48fe1593a0/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_RATING",
        "href": "https://api.ayoune.app/marketing/ratings/65e0b145121b7d48fe1593a0/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.24.4",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "1827",
      "reset": "1784783437",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 54.78152,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also