Analyze SERP

post/analyze/serp

Request

  • Base URL: https://www.agentseo.dev/api/v1
  • URL: https://www.agentseo.dev/api/v1/analyze/serp
  • Auth: API key in header x-api-key

Query parameters

syncboolean

Open a short inline processing window when supported by the endpoint. If the result is not ready yet, the endpoint may still return 202 with a queued payload that includes poll_url, events_url, and retry_after_seconds.

Headers

x-project-idstring

Optional attribution label for grouping usage and jobs by project.

x-workflow-idstring

Optional attribution label for grouping usage and jobs by workflow or agent run.

Request body

keywordstring required
locationstring
location_codeinteger

Optional search location code for deterministic geo-targeting.

device'desktop' | 'mobile'
languagestring

Response

Completed SERP analysis primitive with serp_opportunity

itemsobject[]
search_parametersobject
serp_featuresobject[]
keyword_metricsobject nullable
markdown_summarystring

Changes

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