https://api.nexscope.ai/seo/topSearchesEjecutar esta API
Envía una solicitud JSON para ejecutar esta API y recibir los datos de respuesta documentados.
Endpoint
| Método | POST |
| Ruta | https://api.nexscope.ai/seo/topSearches |
| Autenticación | Bearer API key |
| Content-Type | application/json |
Parámetros de la solicitud
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
language | string | opcional | Valor de Language usado por esta operación de API. Constante: en Predeterminado: en |
limit | integer | opcional | Valor de Limit usado por esta operación de API. Predeterminado: 10 Mínimo: 1 Máximo: 20 |
market | string | opcional | Valor de Market usado por esta operación de API. Constante: US Predeterminado: US |
Respuesta de ejemplo
Estructura de respuesta de ejemplo del contrato documentado de la API de SEO.
{
"code": 0,
"cost": "-1",
"data": {
"callId": "synthetic-call",
"completedAt": null,
"coverage": {
"missing": [
{
"field": "synthetic",
"reason": "UPSTREAM_FIELD_MISSING"
}
],
"status": "PARTIAL"
},
"requestedAt": "123",
"result": {
"engine": "synthetic",
"freshness": "synthetic",
"items": [
{
"cpcUsd": "synthetic",
"keyword": "synthetic",
"metricsUpdatedAt": 9007199254740992,
"missing": [
{
"field": "synthetic",
"reason": "synthetic"
}
],
"paidCompetition": 1.25,
"searchVolume": 9007199254740992
}
],
"language": "synthetic",
"market": "synthetic",
"missing": [
{
"field": "synthetic",
"reason": "synthetic"
}
],
"ordering": "synthetic",
"rankingBasis": "synthetic",
"requestedLimit": 1,
"returnedCount": 1,
"sourceProduct": "synthetic",
"truncated": false
},
"schemaVersion": "synthetic",
"source": "synthetic",
"status": "PARTIAL",
"usage": {
"billingStatus": "UNAPPROVED",
"chargedCredits": "0"
}
},
"msg": null,
"time": "2026-01-01 00:00:00",
"traceId": "synthetic-trace",
"ts": "9007199254740993"
}Campos de respuesta
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
code | integer | obligatorio | 0 indica un sobre de respuesta satisfactorio; comprueba data.status por separado. Permitidos: 0, 42008, 42009 |
cost | string | obligatorio | Milisegundos transcurridos de procesamiento; no es el precio. -1 en un contexto no web. |
data | object | obligatorio | Valor de Data usado por esta operación de API. |
data.callId | string | null | opcional | Valor de Call id usado por esta operación de API. |
data.completedAt | string | integer | null | opcional | Valor de Completed at usado por esta operación de API. |
data.coverage | object | opcional | Valor de Coverage usado por esta operación de API. |
data.coverage.missing | array | opcional | Valor de Missing usado por esta operación de API. |
data.coverage.missing[] | object | obligatorio | Elemento de data coverage missing. |
data.coverage.missing[].field | string | opcional | Valor de Field usado por esta operación de API. |
data.coverage.missing[].reason | string | opcional | Valor de Reason usado por esta operación de API. |
data.coverage.status | string | opcional | Valor de Status usado por esta operación de API. |
data.requestedAt | string | integer | null | opcional | Valor de Requested at usado por esta operación de API. |
data.result | object | null | obligatorio | Valor de Result usado por esta operación de API. |
data.result.engine | string | obligatorio | Valor de Engine usado por esta operación de API. Constante: google |
data.result.freshness | string | obligatorio | Valor de Freshness usado por esta operación de API. Constante: database_latest_available |
data.result.items | array | obligatorio | Valor de Items usado por esta operación de API. Cantidad mínima de elementos: 0 Cantidad máxima de elementos: 20 |
data.result.items[] | object | obligatorio | Elemento de data result items. |
data.result.items[].cpcUsd | string | null | obligatorio | Valor de Cpc usd usado por esta operación de API. Patrón: ^(0|[1-9][0-9]*)(\.[0-9]+)?$ |
data.result.items[].keyword | string | obligatorio | Valor de Keyword usado por esta operación de API. |
data.result.items[].metricsUpdatedAt | integer | null | obligatorio | Valor de Metrics updated at usado por esta operación de API. Mínimo: 0 |
data.result.items[].missing | array | obligatorio | Valor de Missing usado por esta operación de API. Cantidad mínima de elementos: 0 |
data.result.items[].missing[] | object | obligatorio | Elemento de data result items[] missing. |
data.result.items[].missing[].field | string | obligatorio | Valor de Field usado por esta operación de API. |
data.result.items[].missing[].reason | string | obligatorio | Valor de Reason usado por esta operación de API. Permitidos: UPSTREAM_FIELD_MISSING, UPSTREAM_FIELD_INVALID, DUPLICATE_UPSTREAM_ITEM, UPSTREAM_ITEM_MISSING |
data.result.items[].paidCompetition | number | null | obligatorio | Valor de Paid competition usado por esta operación de API. Mínimo: 0 Máximo: 1 |
data.result.items[].searchVolume | integer | null | obligatorio | Valor de Search volume usado por esta operación de API. Mínimo: 0 |
data.result.language | string | obligatorio | Valor de Language usado por esta operación de API. Constante: en |
data.result.market | string | obligatorio | Valor de Market usado por esta operación de API. Constante: US |
data.result.missing | array | obligatorio | Valor de Missing usado por esta operación de API. Cantidad mínima de elementos: 0 |
data.result.missing[] | object | obligatorio | Elemento de data result missing. |
data.result.missing[].field | string | obligatorio | Valor de Field usado por esta operación de API. |
data.result.missing[].reason | string | obligatorio | Valor de Reason usado por esta operación de API. Permitidos: UPSTREAM_FIELD_MISSING, UPSTREAM_FIELD_INVALID, DUPLICATE_UPSTREAM_ITEM, UPSTREAM_ITEM_MISSING |
data.result.ordering | string | obligatorio | Valor de Ordering usado por esta operación de API. Constante: search_volume_desc |
data.result.rankingBasis | string | obligatorio | Valor de Ranking basis usado por esta operación de API. Constante: google_ads_search_volume |
data.result.requestedLimit | integer | obligatorio | Valor de Requested limit usado por esta operación de API. Mínimo: 1 Máximo: 20 |
data.result.returnedCount | integer | obligatorio | Valor de Returned count usado por esta operación de API. Mínimo: 0 |
data.result.sourceProduct | string | obligatorio | Valor de Source product usado por esta operación de API. Constante: dataforseo_labs |
data.result.truncated | boolean | obligatorio | Valor de Truncated usado por esta operación de API. |
data.schemaVersion | string | null | opcional | Valor de Schema version usado por esta operación de API. |
data.source | string | null | opcional | Valor de Source usado por esta operación de API. |
data.status | string | opcional | Valor de Status usado por esta operación de API. Permitidos: SUCCESS, PARTIAL, EMPTY, PROCESSING, UNKNOWN, FAILED |
data.usage | object | null | opcional | Valor de Usage usado por esta operación de API. |
data.usage.billingStatus | string | null | opcional | Valor de Billing status usado por esta operación de API. |
data.usage.chargedCredits | string | integer | null | opcional | Valor de Charged credits usado por esta operación de API. |
msg | string | null | obligatorio | Para los casos satisfactorios y los fallos se prefiere el valor disponible de msg/errmsg/message del proveedor; el chino se traduce al inglés. Si falta el mensaje de éxito, su valor es null. Los errores propios de la plataforma y los estados de las tareas utilizan el inglés de la plataforma. El texto del mensaje nunca determina el éxito ni el reintento. |
time | string | obligatorio | yyyy-MM-dd HH:mm:ss |
traceId | string | null | obligatorio | Valor de Trace id usado por esta operación de API. |
ts | string | obligatorio | Milisegundos desde el inicio de la época; serializador global de enteros long. |
Respuesta de procesamiento aceptado
code 0 confirma la aceptación. Usa data.callId para consultar la misma solicitud; el procesamiento no implica finalización.
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
code | integer | obligatorio | 0 indica un sobre de respuesta satisfactorio; comprueba data.status por separado. Constante: 0 |
cost | string | obligatorio | Milisegundos transcurridos de procesamiento; no es el precio. -1 en un contexto no web. |
data | object | obligatorio | Valor de Data usado por esta operación de API. |
data.callId | string | null | obligatorio | Valor de Call id usado por esta operación de API. |
data.reason | string | obligatorio | Valor de Reason usado por esta operación de API. Constante: IN_PROGRESS |
data.retryable | boolean | opcional | Valor de Retryable usado por esta operación de API. |
data.status | string | obligatorio | Valor de Status usado por esta operación de API. Constante: PROCESSING |
data.taskId | string | null | opcional | Valor de Task id usado por esta operación de API. |
msg | string | null | obligatorio | Para los casos satisfactorios y los fallos se prefiere el valor disponible de msg/errmsg/message del proveedor; el chino se traduce al inglés. Si falta el mensaje de éxito, su valor es null. Los errores propios de la plataforma y los estados de las tareas utilizan el inglés de la plataforma. El texto del mensaje nunca determina el éxito ni el reintento. |
time | string | obligatorio | yyyy-MM-dd HH:mm:ss |
traceId | string | null | obligatorio | Valor de Trace id usado por esta operación de API. |
ts | string | obligatorio | Milisegundos desde el inicio de la época; serializador global de enteros long. |
Respuesta de error
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
code | integer | obligatorio | 0 indica un sobre de respuesta satisfactorio; comprueba data.status por separado. |
cost | string | obligatorio | Milisegundos transcurridos de procesamiento; no es el precio. -1 en un contexto no web. |
data | object | obligatorio | Valor de Data usado por esta operación de API. |
data.callId | string | null | obligatorio | Valor de Call id usado por esta operación de API. |
data.reason | string | null | obligatorio | Valor de Reason usado por esta operación de API. |
data.retryable | boolean | opcional | Valor de Retryable usado por esta operación de API. |
data.status | string | null | obligatorio | Valor de Status usado por esta operación de API. |
data.taskId | string | null | opcional | Valor de Task id usado por esta operación de API. |
msg | string | null | obligatorio | Para los casos satisfactorios y los fallos se prefiere el valor disponible de msg/errmsg/message del proveedor; el chino se traduce al inglés. Si falta el mensaje de éxito, su valor es null. Los errores propios de la plataforma y los estados de las tareas utilizan el inglés de la plataforma. El texto del mensaje nunca determina el éxito ni el reintento. |
time | string | obligatorio | yyyy-MM-dd HH:mm:ss |
traceId | string | null | obligatorio | Valor de Trace id usado por esta operación de API. |
ts | string | obligatorio | Milisegundos desde el inicio de la época; serializador global de enteros long. |
Obtener un resultado en procesamiento
Una respuesta conPROCESSING y un callIdsignifica que el resultado aún se está preparando. Usa la consulta de resultado siguiente con el identificador devuelto. Esta consulta lee el resultado guardado y no consume créditos.
curl -X GET https://api.nexscope.ai/seo/topSearches/calls/{callId} \
-H "Authorization: Bearer nk-xxxxxxxxxxxxxxxxx"Respuestas
| Código | Descripción |
|---|---|
| 200 | Respuesta HTTP predeterminada tanto para el éxito como para muchos errores de negocio. Solo el código JSON externo 0 indica éxito o aceptación asíncrona; consulta data para obtener el resultado. |
| 429 | Límite de admisión de ejecuciones; respeta Retry-After cuando esté presente. |
| 503 | La admisión de ejecuciones no está disponible temporalmente; respeta Retry-After cuando esté presente. |
| Opcional | X-Nexscope-Http-Status: semantic asigna estados HTTP a los errores de negocio gestionados por el controlador en las rutas de ejecución y tareas. Los fallos previos a la autenticación, como la ausencia de una clave API (code 11209), pueden seguir devolviendo HTTP 200 antes de esta asignación. Comprueba siempre el código JSON externo; las solicitudes malformadas y los fallos de infraestructura también pueden devolver respuestas HTTP distintas de 200. |
Fuente de datos, vigencia y limitaciones
La fuente, la vigencia, la cobertura, los límites de frecuencia y las notas de estimación no se especifican en esta definición de API salvo que aparezcan en la documentación de campos de solicitud o respuesta anterior. No supongas datos oficiales del mercado ni actualización en tiempo real cuando no estén documentados explícitamente.