SERP

Start a SERP capture job

Starts an asynchronous search-results capture (202-plus-poll). Returns a job id to poll via GET /v1/serp/search/{jobId}.

post/v1/serp/search

Request

  • Base URL: http://localhost:9998
  • URL: http://localhost:9998/v1/serp/search
  • Auth: HTTP bearer

Request body

querystring required
engine'google' | 'bing'
numinteger
glstring
hlstring

Response

Job accepted

idstring required

Job id (format "serp-<uuid>"), used to poll the result

querystring required
status'running' | 'completed' | 'failed' required

Changes

No recorded changes to this operation across all 1 revision of this API.