aYOUne
← Monitoring API

KeywordRelations

Singular: KeywordRelation — Base URL: https://monitoring-api.ayoune.app — Access: CRUD — Machine-readable spec (JSON · YAML)

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": "6a2e6e5c1ab613e8ec1aed8c",
    "_keyword": "62d962100bd7cb072b1f3258",
    "_parentKeyword": "5f2fe687b5f0ce51db1a502d",
    "kind": "related",
    "modifier": null,
    "createdAt": "2026-06-14T09:03:24.740Z",
    "isDraft": true,
    "locale": "de_de",
    "updatedAt": "2026-07-26T10:35:08.245Z",
    "shares": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://monitoring-api.ayoune.app/keywordrelations/6a2e6e5c1ab613e8ec1aed8c",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "aYOUneKeywords",
        "title": "MODEL_AYOUNEKEYWORD",
        "href": "https://api.ayoune.app/su/ayounekeywords/5f2fe687b5f0ce51db1a502d",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "su.keywords"
      },
      {
        "rel": "aYOUneKeywords",
        "title": "MODEL_AYOUNEKEYWORD",
        "href": "https://api.ayoune.app/su/ayounekeywords/62d962100bd7cb072b1f3258",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "su.keywords"
      }
    ],
    "relations": [
      {
        "rel": "aYOUneKeywords",
        "title": "MODEL_AYOUNEKEYWORD",
        "href": "https://api.ayoune.app/su/ayounekeywords",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "su.keywords"
      },
      {
        "rel": "aYOUneKeywords",
        "title": "MODEL_AYOUNEKEYWORD",
        "href": "https://api.ayoune.app/su/ayounekeywords",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "su.keywords"
      }
    ],
    "debugId": "6aa0e559c9201e8c6c39b51d",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_KEYWORDRELATION",
        "href": "https://api.ayoune.app/monitoring/keywordrelations/6a2e6e5c1ab613e8ec1aed8c/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_KEYWORDRELATION",
        "href": "https://api.ayoune.app/monitoring/keywordrelations/6a2e6e5c1ab613e8ec1aed8c",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.39.1",
      "core": "2026.332.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2045",
      "reset": "1788931338",
      "resetDate": "Wed Sep 09 2026"
    },
    "responseTime": 86.100122,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also