aYOUne
← Monitoring API

Keywords

Singular: Keyword — 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": "65e0b164121b7d48fe159674",
    "suggestion": false,
    "suggestionReason": false,
    "seo": false,
    "sea": false,
    "pla": false,
    "isDraft": true,
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2024-02-29T16:31:32.988Z",
    "updatedAt": "2024-02-29T16:31:32.988Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://monitoring-api.ayoune.app/keywords/65e0b164121b7d48fe159674",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "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": "Projects",
        "title": "MODEL_PROJECT",
        "href": "https://api.ayoune.app/pm/projects",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.projects"
      },
      {
        "rel": "ContentProjects",
        "title": "MODEL_CONTENTPROJECT",
        "href": "https://api.ayoune.app/cms/contentprojects",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "cms.contentprojects"
      },
      {
        "rel": "PageStats",
        "title": "MODEL_PAGESTAT",
        "href": "https://api.ayoune.app/monitoring/pagestats",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "monitoring.pagestats"
      },
      {
        "rel": "Contents",
        "title": "MODEL_CONTENT",
        "href": "https://api.ayoune.app/cms/contents",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "cms.contents"
      },
      {
        "rel": "Publications",
        "title": "MODEL_PUBLICATION",
        "href": "https://api.ayoune.app/marketing/publications",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "marketing.publications"
      },
      {
        "rel": "Articles",
        "title": "MODEL_ARTICLE",
        "href": "https://api.ayoune.app/cms/articles",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "cms.articles"
      }
    ],
    "debugId": "6a828bd86ffbda734fddca0f",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_KEYWORD",
        "href": "https://api.ayoune.app/monitoring/keywords/65e0b164121b7d48fe159674/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_KEYWORD",
        "href": "https://api.ayoune.app/monitoring/keywords/65e0b164121b7d48fe159674/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.34.6",
      "core": "2026.299.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2495",
      "reset": "1786943973",
      "resetDate": "Mon Aug 17 2026"
    },
    "responseTime": 614.625372,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also