https://api.nexscope.ai/sf/keywordOverviewEjecutar 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/sf/keywordOverview |
| Autenticación | Bearer API key |
| Content-Type | application/json |
Parámetros de la solicitud
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
keyword | string | obligatorio | Palabras clave, longitud máxima 1000; tratar de utilizar el idioma del sitio de destino |
country | string | opcional | Sitio: `US`, `UK`, `DE`, `CA`, `JP`, `FR`, `ES`, `IT`, `MX`, `AU`, `AE`, `BR`, `SA` Ejemplo: US |
last7d | boolean | opcional | Si tomar los últimos 7 días; cuando es `false`, utilice el rango de fechas Ejemplo: true |
startDate | string | opcional | `yyyy-MM-dd`; surte efecto cuando `last7d=false` |
endDate | string | opcional | `yyyy-MM-dd`; trabaja con `startDate` |
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 (30 campos)
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
msg | string | opcional | noticias |
total | integer | opcional | Cantidad total de datos, generalmente 1 |
code | string | opcional | código de retorno de negocios sf, `"1"` indica éxito |
data | array | opcional | matriz de vista general de palabras clave |
costTime | integer | opcional | Tiempo (ms) |
costToken | integer | opcional | Consumir token |
columns | array | opcional | render column |
type | string | opcional | estilo de renderizado |
title | string | opcional | Título |
keyword | string | opcional | palabras clave |
keywordPopularityRank | integer | opcional | Clasificación de popularidad de palabras clave. Cuanto más pequeño es el valor, mayor es el volumen de búsqueda. |
estimatedWeeklySearchVolume | integer | opcional | Volumen estimado de búsqueda por semana |
supplyDemandRatio | number | opcional | Relación oferta y demanda (número de productos de resultados de búsqueda / volumen de búsqueda mensual), cuanto menor es el valor, menor es la competencia y mayor es la oportunidad. |
totalSearchResultProductCount | integer | opcional | Número total de resultados de búsqueda |
naturalSearchProductCount | integer | opcional | Número de artículos de búsqueda natural |
sponsoredProductsCount | integer | opcional | Número de artículos anunciados |
brandAdProductCount | integer | opcional | Número de productos publicitarios de marca |
videoAdProductCount | integer | opcional | Número de productos de publicidad de vídeo |
paidAdvertisingProductCount | integer | opcional | Número total de productos publicitarios pagados por PPC |
amazonChoiceProductCount | integer | opcional | Conteo de elementos de la opción de Amazon |
topRatedProductCount | integer | opcional | Número de artículos más valorado |
searchRecommendationProductCount | integer | opcional | Buscar el número de productos recomendados |
editorialRecommendationsProductCount | integer | opcional | Número de artículos recomendados por los editores |
recNonadProductCount | integer | opcional | Número de productos no publicitarios recomendados |
recAdProductCount | integer | opcional | Número de productos de publicidad recomendados |
trackedAsinTotalCount | integer | opcional | Número total de personas expuestas ASIN deduplicación seguida por sf; el campo aguas arriba es `totalAsinNum` |
totalMarketplaceKeywordCount | integer | opcional | Número total de palabras clave del sitio |
dataPeriodStartDate | string | opcional | Fecha de inicio del período de datos |
dataPeriodEndDate | string | opcional | Fecha de finalización del período de datos |
keywordDataUpdateTime | string | opcional | Tiempo de actualización de datos de palabras clave |
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.