aYOUne
← Reporting API

KeywordResearchResults

Singular: KeywordResearchResult — Base URL: https://reporting-api.ayoune.app — Access: CRUD

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": "6a6198d6c5e8aca9cc093879",
    "maxCPC": 14,
    "clicks": 0,
    "cpc": 0,
    "cost": 0,
    "impressions": 0,
    "ctr": 0,
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2026-07-23T04:30:14.626Z",
    "updatedAt": "2026-07-23T04:30:14.626Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://reporting-api.ayoune.app/keywordresearchresults/6a6198d6c5e8aca9cc093879",
        "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": "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": "6a6198d7c5e8aca9cc0938c2",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_KEYWORDRESEARCHRESULT",
        "href": "https://api.ayoune.app/reporting/keywordresearchresults/6a6198d6c5e8aca9cc093879/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_KEYWORDRESEARCHRESULT",
        "href": "https://api.ayoune.app/reporting/keywordresearchresults/6a6198d6c5e8aca9cc093879/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.24.0",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2454",
      "reset": "1784784606",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 95.421198,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also