/api/skill-api/v1/skills/seo-serp-competitors/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-serp-competitors/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 | Item in keywords. Minimum length: 1 Maximum length: 80 |
language | string | optional | Language value used by this API operation. Constant: en Default: en |
limit | integer | optional | Limit value used by this API operation. Default: 10 Minimum: 1 Maximum: 20 |
market | string | optional | Market value used by this API operation. Constant: US Default: US |
Request example
{
"keywords": [
"example"
],
"language": "en",
"limit": 10,
"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 | null | optional | Call id value used by this API operation. |
data.completedAt | integer | null | optional | Completed at value used by this API operation. |
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.requestedAt | integer | null | optional | Requested at value used by this API operation. |
data.result | object | null | required | Result value used by this API operation. |
data.result.items | array | required | Items value used by this API operation. Minimum items: 0 Maximum items: 20 |
data.result.items[] | object | required | Item in data result items. |
data.result.items[].averagePosition | number | null | required | Average position value used by this API operation. Minimum: 0 |
data.result.items[].domain | string | required | Domain value used by this API operation. Minimum length: 1 |
data.result.items[].estimatedTraffic | number | null | required | Estimated traffic value used by this API operation. Minimum: 0 |
data.result.items[].keywordCount | integer | null | required | Keyword count value used by this API operation. Minimum: 0 |
data.result.items[].medianPosition | number | null | required | Median position value used by this API operation. Minimum: 0 |
data.result.items[].missing | array | required | Missing value used by this API operation. Minimum items: 0 |
data.result.items[].missing[] | object | required | Item in data result items[] missing. |
data.result.items[].missing[].field | string | required | Field value used by this API operation. |
data.result.items[].missing[].reason | string | required | Reason value used by this API operation. Allowed: UPSTREAM_FIELD_MISSING, UPSTREAM_FIELD_INVALID, DUPLICATE_UPSTREAM_ITEM |
data.result.items[].rating | number | null | required | Rating value used by this API operation. Minimum: 0 |
data.result.language | string | required | Language value used by this API operation. Constant: en |
data.result.market | string | required | Market value used by this API operation. Constant: US |
data.result.missing | array | required | Missing value used by this API operation. Minimum items: 0 |
data.result.missing[] | object | required | Item in data result missing. |
data.result.missing[].field | string | required | Field value used by this API operation. |
data.result.missing[].reason | string | required | Reason value used by this API operation. Allowed: UPSTREAM_FIELD_MISSING, UPSTREAM_FIELD_INVALID, DUPLICATE_UPSTREAM_ITEM |
data.result.normalizedSeeds | array | required | Normalized seeds value used by this API operation. Minimum items: 1 Maximum items: 20 |
data.result.normalizedSeeds[] | string | required | Item in data result normalizedSeeds. |
data.result.ordering | string | required | Ordering value used by this API operation. Constant: rating_desc |
data.result.requestedLimit | integer | required | Requested limit value used by this API operation. Minimum: 1 Maximum: 20 |
data.result.returnedCount | integer | required | Returned count value used by this API operation. Minimum: 0 Maximum: 20 |
data.result.searchType | string | required | Search type value used by this API operation. Constant: organic |
data.result.seeds | array | required | Seeds value used by this API operation. Minimum items: 1 Maximum items: 20 |
data.result.seeds[] | string | required | Item in data result seeds. |
data.result.trafficKind | string | required | Traffic kind value used by this API operation. Constant: estimated |
data.schemaVersion | string | null | optional | Schema version value used by this API operation. |
data.source | string | null | optional | Source value used by this API operation. |
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": [
{
"averagePosition": 1.25,
"domain": "synthetic",
"estimatedTraffic": 1.25,
"keywordCount": 9007199254740992,
"medianPosition": 1.25,
"missing": [
{
"field": "synthetic",
"reason": "synthetic"
}
],
"rating": 1.25
}
],
"language": "synthetic",
"market": "synthetic",
"missing": [
{
"field": "synthetic",
"reason": "synthetic"
}
],
"normalizedSeeds": [
"synthetic"
],
"ordering": "synthetic",
"requestedLimit": 1,
"returnedCount": 1,
"searchType": "synthetic",
"seeds": [
"synthetic"
],
"trafficKind": "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.