aYOUne
← Monitoring API

KeywordResearches

Singular: KeywordResearch — Base-URL: https://monitoring-api.ayoune.app — Zugriff: CRUD

play_circle Jetzt ausprobieren beta

Requests werden über den consumer-app Proxy an *.ayoune.app weitergeleitet. Tokens bleiben im Browser und werden pro Call mitgesendet.

Beispiel-Response (aufgezeichnet) Beispiel

Eine echte, zuvor aufgezeichnete GET /:id-Antwort dieses Endpunkts — nicht der Live-Call oben. Sensible Felder sind maskiert.

{
  "payload": {
    "config": {
      "devices": []
    },
    "crawlingConfig": {
      "regions": [],
      "timeFrames": []
    },
    "meta": {
      "regionStats": []
    },
    "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": "6a61955eae831600b9317790",
    "name": "EXUBERANT_AMARANTH_BIGGS DARKLIGHTER",
    "_user": "6045f4d25704710012485569",
    "_keywords": [],
    "keywords": [],
    "maxCPCs": [],
    "scraperTier": "standard",
    "preferOwnInfra": false,
    "createdBy": "6045f4d25704710012485569",
    "ownDisplayUrls": [],
    "costRuns": [],
    "createdAt": "2026-07-23T04:15:26.958Z",
    "updatedAt": "2026-07-23T04:15:26.958Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://monitoring-api.ayoune.app/keywordresearches/6a61955eae831600b9317790",
        "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": "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": "6a61955fae831600b93177bb",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_KEYWORDRESEARCH",
        "href": "https://api.ayoune.app/monitoring/keywordresearches/6a61955eae831600b9317790/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_KEYWORDRESEARCH",
        "href": "https://api.ayoune.app/monitoring/keywordresearches/6a61955eae831600b9317790/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.18.0",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2397",
      "reset": "1784783607",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 24.104606,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

MethodePathBeschreibungRight
GET /keywordresearches Liste mit Filtern/Paginierung monitoring.keywordresearches.view
GET /keywordresearches/:id Einzelner Datensatz monitoring.keywordresearches.view
POST /keywordresearches Neuen Datensatz erstellen monitoring.keywordresearches.new
PUT /keywordresearches Datensatz aktualisieren monitoring.keywordresearches.edit
DELETE /keywordresearches/:id Datensatz löschen monitoring.keywordresearches.delete

SDK

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

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

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

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

Weiterführend