https://api.nexscope.ai/js/keywords/by-keywordEjecutar 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/js/keywords/by-keyword |
| Autenticación | Bearer API key |
| Content-Type | application/json |
Parámetros de la solicitud
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
marketplace | string | obligatorio | Código de mercado objetivo. Valores opcionales: `us`, `uk`, `de`, `in`, `ca`, `fr`, `it`, `es`, `mx`, `jp` Ejemplo: us |
searchTerms | string | obligatorio | Palabras clave de semillas (cadena de palabras clave) |
needCount | integer | opcional | Devuelve el número total de resultados |
sort | string | opcional | Campo de clasificación, por defecto a orden descendente por volumen de búsqueda exacto Ejemplo: -monthly_search_volume_exact |
minMonthlySearchVolumeExact | integer | opcional | Volumen de búsqueda exacto mínimo |
maxMonthlySearchVolumeExact | integer | opcional | Capuchón exacto del volumen de búsqueda |
minMonthlySearchVolumeBroad | integer | opcional | Mínimo de volumen de búsqueda |
maxMonthlySearchVolumeBroad | integer | opcional | Capuchón del volumen de búsqueda amplio |
minWordCount | integer | opcional | Número mínimo de palabras clave (utilizadas para filtrar palabras largas) |
maxWordCount | integer | opcional | Palabras clave número máximo de palabras |
minOrganicProductCount | integer | opcional | Número mínimo de productos de clasificación natural |
maxOrganicProductCount | integer | opcional | Número máximo de productos naturales de clasificación |
Respuesta de ejemplo
Estructura de respuesta de la plataforma. code 0 indica éxito o aceptación; data contiene el resultado de negocio.
No hay un ejemplo de respuesta publicado para esta API. Consulta los campos de respuesta siguientes.
Campos de respuesta
Referencia de campos de respuesta (17 campos)
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
costToken | integer | opcional | Número de fichas consumidas |
keywordInfoList | array | opcional | Lista de información de palabras clave |
name | string | opcional | Nombre de la palabra clave |
country | string | opcional | Código del mercado |
monthlySearchVolumeExact | integer | opcional | Promedio mensual de volumen de búsqueda exacta |
monthlySearchVolumeBroad | integer | opcional | Promedio mensual de búsquedas de coincidencias amplias |
monthlyTrend | number | opcional | Volumen de búsqueda mensual porcentaje de cambio |
quarterlyTrend | number | opcional | Cambio porcentual del volumen de búsqueda trimestral |
dominantCategory | string | opcional | Categoría con la mayor proporción en los resultados de búsqueda |
relevancyScore | integer | opcional | Puntuación de relevancia para palabra semilla |
easeOfRankingScore | integer | opcional | Facilidad de puntuación de ranking (cuanto mayor, más fácil es clasificar) |
organicProductCount | integer | opcional | Número de productos clasificados naturalmente |
sponsoredProductCount | integer | opcional | Cantidad de productos publicitarios |
ppcBidExact | number | opcional | Coincidencia exacta PPC recomendado puja (USD) |
ppcBidBroad | number | opcional | Paro amplio PPC recomendado puja (USD) |
spBrandAdBid | number | opcional | Anuncio de marca patrocinado Recomendado Bid (USD) |
recommendedPromotions | integer | opcional | Cantidad de regalos promocionales recomendada |
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.