Skip to content
aYOUne
← Monitoring API

KeywordResearches

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

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": {
    "config": {
      "devices": [],
      "nextCheck": "2026-10-26T06:53:43.678Z",
      "active": true,
      "lastCheck": "2026-10-21T06:53:43.666Z"
    },
    "crawlingConfig": {
      "regions": [],
      "timeFrames": []
    },
    "meta": {
      "regionStats": [
        {
          "region": "Arnsberg",
          "crawls": 11,
          "_id": "6ad86177e15c3c7baae0788c",
          "shares": []
        },
        {
          "region": "Baden-Württemberg",
          "crawls": 10,
          "_id": "6ad86177e15c3c7baae0788d",
          "shares": []
        },
        {
          "region": "Bayern",
          "crawls": 10,
          "_id": "6ad86177e15c3c7baae0788e",
          "shares": []
        },
        {
          "region": "Berlin",
          "crawls": 10,
          "_id": "6ad86177e15c3c7baae0788f",
          "shares": []
        },
        {
          "region": "Brandenburg",
          "crawls": 10,
          "_id": "6ad86177e15c3c7baae07890",
          "shares": []
        }
      ]
    },
    "fetchSettings": {
      "provider": "ayoune",
      "withAds": false,
      "withCost": false,
      "costs": false,
      "costOnly": false,
      "synonyms": false,
      "questions": false,
      "prepositions": false,
      "comparisons": false,
      "alphabeticals": false,
      "monitorAdHijacking": false,
      "monitorBrandBidding": false,
      "manageBrandBidding": false,
      "monitorPla": false,
      "monitorKeywordInclusion": false,
      "keepResults": false,
      "takeScreenShot": false,
      "takeFullScreenShot": false,
      "checkForCampaign": false,
      "positionsToMonitor": [
        1,
        2,
        3
      ]
    },
    "brandBidderConfig": {
      "brands": [],
      "blackList": [],
      "whiteList": [],
      "partnerList": []
    },
    "adHijackingConfig": {
      "mode": "chain",
      "redirectChain": [],
      "excludes": []
    },
    "_id": "6abef15520e25ce55efccd46",
    "name": "Prüfer-Beispiel: Geschäftssoftware",
    "_user": "5a76d07e2d8b3270ff6df587",
    "_keywords": [
      "62d467ee0bd7cb072bc9e7c7",
      "63a87bca713e27eccced6e1f",
      "6a2956396fbcae00125b21a8"
    ],
    "keywords": [
      "crm software",
      "warenwirtschaft cloud",
      "ayoune"
    ],
    "market": "de_de",
    "maxCPCs": [
      1,
      2,
      4,
      6,
      8,
      10,
      12,
      14,
      16,
      18,
      20,
      22,
      24,
      26,
      28,
      30,
      32,
      34,
      36,
      38,
      40,
      42,
      44,
      46,
      48,
      50
    ],
    "scraperTier": "standard",
    "preferOwnInfra": false,
    "createdBy": "5a76d07e2d8b3270ff6df587",
    "ownDisplayUrls": [],
    "costRuns": [],
    "shares": [],
    "createdAt": "2026-10-01T23:48:37.680Z",
    "updatedAt": "2026-10-26T00:53:43.679Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://monitoring-api.ayoune.app/keywordresearches/6abef15520e25ce55efccd46",
        "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": "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"
      },
      {
        "rel": "KeywordNegativeLists",
        "title": "MODEL_KEYWORDNEGATIVELIST",
        "href": "https://api.ayoune.app/marketing/keywordnegativelists",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "marketing.keywordnegativelists"
      },
      {
        "rel": "Documents",
        "title": "MODEL_DOCUMENT",
        "href": "https://api.ayoune.app/crm/documents",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.documents"
      },
      {
        "rel": "Documents",
        "title": "MODEL_DOCUMENT",
        "href": "https://api.ayoune.app/crm/documents",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.documents"
      }
    ],
    "debugId": "6aded1af4efa212fa2db0f9c",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_KEYWORDRESEARCH",
        "href": "https://api.ayoune.app/monitoring/keywordresearches/6abef15520e25ce55efccd46/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_KEYWORDRESEARCH",
        "href": "https://api.ayoune.app/monitoring/keywordresearches/6abef15520e25ce55efccd46",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.39.1",
      "core": "2026.385.1"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "9882",
      "reset": "1792991036",
      "resetDate": "Mon Oct 26 2026"
    },
    "responseTime": 64.336168,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also