/api/skill-api/v1/skills/seo-keyword-metrics/runRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | /api/skill-api/v1/skills/seo-keyword-metrics/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
keywords | array | required | Keywords value used by this API operation. Minimum items: 1 Maximum items: 20 |
keywords[] | string | required | Trimmed, at most ten whitespace-separated words. Minimum length: 1 Maximum length: 80 |
language | string | required | Language value used by this API operation. Allowed: en |
market | string | required | Market value used by this API operation. Allowed: US |
Request example
{
"keywords": [
"example"
],
"language": "en",
"market": "US"
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
code | integer | required | 0 is a successful envelope; inspect data.status separately. Allowed: 0, 42008, 42009 |
cost | string | required | Elapsed processing milliseconds; not price. -1 for non-web context. |
data | object | required | Data value used by this API operation. |
data.callId | string | optional | Call id value used by this API operation. Format: uuid |
data.completedAt | integer | null | optional | UTC epoch milliseconds. |
data.coverage | object | optional | Coverage value used by this API operation. |
data.coverage.missing | array | optional | Missing value used by this API operation. |
data.coverage.missing[] | object | required | Item in data coverage missing. |
data.coverage.missing[].field | string | optional | Field value used by this API operation. |
data.coverage.missing[].reason | string | optional | Reason value used by this API operation. |
data.coverage.status | string | optional | Status value used by this API operation. |
data.reason | string | optional | Stable reason on errors 42001 through 42011; accepted errors retain callId. |
data.requestedAt | integer | null | optional | UTC epoch milliseconds. |
data.result | object | null | required | Result value used by this API operation. |
data.result.items | array | optional | Items value used by this API operation. |
data.result.items[] | object | required | Item in data result items. |
data.result.items[].competition | number | null | optional | Competition value used by this API operation. |
data.result.items[].competitionLevel | string | null | optional | Competition level value used by this API operation. |
data.result.items[].cpcUsd | string | null | optional | Cpc usd value used by this API operation. |
data.result.items[].dataUpdatedAt | integer | null | optional | Data updated at value used by this API operation. |
data.result.items[].inputIndex | integer | null | optional | Input index value used by this API operation. |
data.result.items[].inputKeyword | string | null | optional | Input keyword value used by this API operation. |
data.result.items[].keywordDifficulty | number | null | optional | Keyword difficulty value used by this API operation. |
data.result.items[].missing | array | optional | Missing value used by this API operation. |
data.result.items[].missing[] | object | required | Item in data result items[] missing. |
data.result.items[].missing[].field | string | null | optional | Field value used by this API operation. |
data.result.items[].missing[].reason | string | null | optional | Reason value used by this API operation. |
data.result.items[].monthlySearches | array | optional | Monthly searches value used by this API operation. |
data.result.items[].monthlySearches[] | object | required | Item in data result items[] monthlySearches. |
data.result.items[].monthlySearches[].month | integer | null | optional | Month value used by this API operation. |
data.result.items[].monthlySearches[].searchVolume | integer | null | optional | Search volume value used by this API operation. |
data.result.items[].monthlySearches[].year | integer | null | optional | Year value used by this API operation. |
data.result.items[].normalizedKeyword | string | null | optional | Normalized keyword value used by this API operation. |
data.result.items[].searchVolume | integer | null | optional | Search volume value used by this API operation. |
data.result.items[].status | string | optional | Status value used by this API operation. Allowed: AVAILABLE, NO_COVERAGE |
data.result.language | string | null | optional | Language value used by this API operation. |
data.result.market | string | null | optional | Market value used by this API operation. |
data.retryable | boolean | optional | Retryable value used by this API operation. Constant: false |
data.schemaVersion | string | optional | Schema version value used by this API operation. Constant: 1.0 |
data.source | string | optional | Source value used by this API operation. Constant: dataforseo |
data.status | string | optional | Status value used by this API operation. Allowed: SUCCESS, PARTIAL, EMPTY, PROCESSING, UNKNOWN, FAILED |
data.usage | object | optional | Usage value used by this API operation. |
data.usage.billingStatus | string | optional | Billing status value used by this API operation. |
data.usage.chargedCredits | integer | null | optional | Charged credits value used by this API operation. |
data.usage.providerCostStatus | string | optional | Provider cost status value used by this API operation. |
data.usage.providerCostUsd | string | null | optional | Provider cost usd value used by this API operation. |
data.usage.providerRequests | integer | optional | Provider requests value used by this API operation. |
msg | string | null | required | Msg value used by this API operation. |
time | string | required | yyyy-MM-dd HH:mm:ss |
traceId | string | null | required | Trace id value used by this API operation. |
ts | string | required | Epoch milliseconds; global long serializer. |
Response example
Example response envelope from the documented SEO API contract.
{
"code": 0,
"cost": "-1",
"data": {
"callId": "synthetic-call",
"completedAt": null,
"coverage": {
"missing": [
{
"field": "synthetic",
"reason": "UPSTREAM_FIELD_MISSING"
}
],
"status": "PARTIAL"
},
"requestedAt": 123,
"result": {
"items": [
{
"competition": 9007199254740992,
"competitionLevel": "synthetic",
"cpcUsd": "synthetic",
"dataUpdatedAt": 9007199254740992,
"inputIndex": 1,
"inputKeyword": "synthetic",
"keywordDifficulty": 9007199254740992,
"missing": [
{
"field": "synthetic",
"reason": "synthetic"
}
],
"monthlySearches": [
{
"month": 1,
"searchVolume": 9007199254740992,
"year": 1
}
],
"normalizedKeyword": "synthetic",
"searchVolume": 9007199254740992,
"status": "synthetic"
}
],
"language": "synthetic",
"market": "synthetic"
},
"schemaVersion": "synthetic",
"source": "synthetic",
"status": "PARTIAL",
"usage": {
"billingStatus": "UNAPPROVED",
"chargedCredits": 0,
"providerCostStatus": "UNAPPROVED",
"providerCostUsd": null,
"providerRequests": 0
}
},
"msg": null,
"time": "2026-01-01 00:00:00",
"traceId": null,
"ts": "9007199254740993"
}Responses
| Code | Description |
|---|---|
| 200 | API executed successfully. Body is the direct response payload. |
| 400 | Request JSON or required API parameters are invalid. |
| 401 | API key is missing, invalid, or cannot be matched to a user. |
| 5xx | API execution or upstream service failed. |
Data source, freshness, and limitations
Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.