aYOUne
← Monitoring API

Serps

Singular: Serp — Base URL: https://monitoring-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": {
    "agent": {
      "loc": {
        "coordinates": []
      }
    },
    "captcha": {
      "captchas": [],
      "filtered": [],
      "solutions": [],
      "solved": []
    },
    "timing": {
      "optionsTime": 0,
      "browserStartTime": 0,
      "proxyLoginTime": 0,
      "metaDataTime": 0,
      "initialNavigationTime": 0,
      "cookieConsentTime": 0,
      "searchConsentTime": 0,
      "captchaTime": 0,
      "inputTime": 0,
      "navigationTime": 0,
      "processingTime": 0,
      "cleanUpTime": 0,
      "storageTime": 0,
      "scrollingTime": 0,
      "crawlingTime": 0,
      "parsingTime": 0,
      "totalTime": 0
    },
    "meta": {
      "source": "market",
      "keep": false,
      "parsed": false,
      "needsCheck": false,
      "processed": false,
      "rechecked": false,
      "hasCaptcha": false,
      "hasAds": false,
      "hasPLA": false,
      "hasSEA": false,
      "hasFlights": false,
      "hasBooking": false,
      "hasKnowledgeGraph": false,
      "hasAiOverview": false,
      "hasBooks": false,
      "hasVideos": false,
      "checkedForBrandBidder": false,
      "hasBrandBidder": false,
      "hasTrademarkViolation": false,
      "hasWhiteList": false,
      "hasErrors": false,
      "hasWarnings": false,
      "organicPosition": 0,
      "campaignSignalOn": false,
      "campaignSignalOff": false,
      "htmlSize": 0
    },
    "_id": "6a61972aae831600b9317f9a",
    "archived": false,
    "lab": false,
    "relatedQuestions": [],
    "relatedSearches": [],
    "sea": [],
    "pla": [],
    "organic": [],
    "createdBy": "6045f4d25704710012485569",
    "flights": [],
    "createdAt": "2026-07-23T04:23:06.051Z",
    "updatedAt": "2026-07-23T04:23:06.051Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://monitoring-api.ayoune.app/serps/6a61972aae831600b9317f9a",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Keywords",
        "title": "MODEL_KEYWORD",
        "href": "https://api.ayoune.app/monitoring/keywords",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "monitoring.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"
      },
      {
        "rel": "Devices",
        "title": "MODEL_DEVICE",
        "href": "https://api.ayoune.app/communication/devices",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "communication.devices"
      }
    ],
    "debugId": "6a61972aae831600b9317fc6",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_SERP",
        "href": "https://api.ayoune.app/monitoring/serps/6a61972aae831600b9317f9a/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_SERP",
        "href": "https://api.ayoune.app/monitoring/serps/6a61972aae831600b9317f9a/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.18.0",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2269",
      "reset": "1784783607",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 18.377806,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also