SERP

Start a SERP rank-check job

Starts an asynchronous capture and projects requested domains' first-page ranks at read time. Poll via GET /v1/serp/rank-check/{jobId}.

post/v1/serp/rank-check

Request

  • Base URL: http://localhost:9998
  • URL: http://localhost:9998/v1/serp/rank-check
  • Auth: HTTP bearer

Request body

querystring required
domainsstring[] required

Domains or URLs to locate in the results

engine'google' | 'bing'
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.