Zum Inhalt springen
aYOUne
← Reporting API

KeywordResearchResults

Singular: KeywordResearchResult — Base-URL: https://reporting-api.ayoune.app — Zugriff: CRUD — Maschinenlesbare Beschreibung (JSON · YAML)

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": {
    "_id": "6abef8c00a3e3f6616060f74",
    "_keyword": "63c5ec36f2c1e375a0a6532f",
    "_keywordResearch": "6abef15520e25ce55efccd46",
    "maxCPC": 14,
    "clicks": 0.005101801827549934,
    "cpc": 0.656239,
    "cost": 0.003348,
    "impressions": 7.394822120666504,
    "ctr": 0.0006899154395796359,
    "plan": {
      "campaign_forecast_metrics": {
        "impressions": 7.394822120666504,
        "_impressions": "impressions",
        "click_through_rate": 0.0006899154395796359,
        "_click_through_rate": "click_through_rate",
        "average_cpc_micros": "656239",
        "_average_cpc_micros": "average_cpc_micros",
        "clicks": 0.005101801827549934,
        "_clicks": "clicks",
        "cost_micros": "3348",
        "_cost_micros": "cost_micros",
        "conversions": 0.0032198454719036818,
        "_conversions": "conversions",
        "conversion_rate": 0.6311192512512207,
        "_conversion_rate": "conversion_rate",
        "average_cpa_micros": "1039801",
        "_average_cpa_micros": "average_cpa_micros"
      },
      "_campaign_forecast_metrics": "campaign_forecast_metrics"
    },
    "cpa": 1039801,
    "conversions": 0.0032198454719036818,
    "conversion_rate": 0.6311192512512207,
    "shares": [],
    "createdAt": "2026-10-02T00:20:16.619Z",
    "updatedAt": "2026-10-02T00:20:16.619Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://reporting-api.ayoune.app/keywordresearchresults/6abef8c00a3e3f6616060f74",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "aYOUneKeywords",
        "title": "MODEL_AYOUNEKEYWORD",
        "href": "https://api.ayoune.app/su/ayounekeywords/63c5ec36f2c1e375a0a6532f",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "su.keywords"
      },
      {
        "rel": "KeywordResearches",
        "title": "MODEL_KEYWORDRESEARCH",
        "href": "https://api.ayoune.app/monitoring/keywordresearches/6abef15520e25ce55efccd46",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "monitoring.keywordresearches"
      }
    ],
    "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": "KeywordResearches",
        "title": "MODEL_KEYWORDRESEARCH",
        "href": "https://api.ayoune.app/monitoring/keywordresearches",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "monitoring.keywordresearches"
      },
      {
        "rel": "MarketResearches",
        "title": "MODEL_MARKETRESEARCH",
        "href": "https://api.ayoune.app/monitoring/marketresearches",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "monitoring.marketresearches"
      },
      {
        "rel": "MarketResearchKeywordSets",
        "title": "MODEL_MARKETRESEARCHKEYWORDSET",
        "href": "https://api.ayoune.app/monitoring/marketresearchkeywordsets",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "monitoring.marketresearchkeywordsets"
      }
    ],
    "debugId": "6ac9c439d74347957c1f852e",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_KEYWORDRESEARCHRESULT",
        "href": "https://api.ayoune.app/reporting/keywordresearchresults/6abef8c00a3e3f6616060f74/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_KEYWORDRESEARCHRESULT",
        "href": "https://api.ayoune.app/reporting/keywordresearchresults/6abef8c00a3e3f6616060f74",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.40.0",
      "core": "2026.368.0"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "9751",
      "reset": "1791611240",
      "resetDate": "Sat Oct 10 2026"
    },
    "responseTime": 2005.180274,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

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

SDK

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

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

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

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

Weiterführend