Keyword metrics overview

Score a supplied keyword list with search metrics and page-priority guidance. Costs 5 credits per 25 keywords, minimum 5.

post/keyword-metrics/overview

Request

  • Base URL: https://www.agentseo.dev/api/v1
  • URL: https://www.agentseo.dev/api/v1/keyword-metrics/overview
  • 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

keywordsstring[] required
locationstring

Human-friendly search market. If provided with location_code, location_code wins.

location_codeinteger

Optional provider location code for deterministic geo-targeting.

languagestring
min_search_volumeinteger
sort_by'priority' | 'search_volume' | 'cpc' | 'difficulty'

Response

Completed keyword metrics workflow with agent_workflow

locationobject
keyword_metricsobject
markdown_summarystring

Changes

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