https://api.nexscope.ai/sf/keywordSummaryEjecutar 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/keywordSummary |
| Autenticación | Bearer API key |
| Content-Type | application/json |
Parámetros de la solicitud
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
searchKeyword | string | obligatorio | Buscar palabras clave, longitud máxima 1000; intente utilizar el idioma del sitio objetivo |
country | string | opcional | Sitio: `US`, `UK`, `DE`, `CA`, `JP`, `FR`, `ES`, `IT`, `MX`, `AU`, `AE`, `BR`, `SA` Ejemplo: US |
asins | string | opcional | ASIN lista de filtros, separados por comas; longitud máxima 1000 |
condition | string | opcional | Sólo una condición puede ser pasada a la vez: `nfPosition`, `isSpAd`, `isVedioAd`, `isBrandAd`, `isPPCAd`, `isSearchRecommend`、`acAd`、`totalPeriod.in`、`nfKeywordCnt.total`/`.in`、`adKeywordCnt.total`/`.in`、`allSpKeywordCnt.total`/`.in`、`spKeywordCnt.total`/`.in`、`recSpKeywordCnt.total`/`.in`, `allSbKeywordCnt.total`/`.in`, `sbKeywordCnt.total`/`.in`, `sbvKeywordCnt.total`/`.in` |
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` |
sortBy | string | opcional | `totalKeywordNum`、`naturalKeywordNum`、`brandKeywordNum`、`vedioKeywordNum`、`acKeywordNum`、`erKeywordNum`、`trKeywordNum`、`sumScore`、`totalNfScore`、`totalSpSocre`、`totalBrandScore`、`totalVedioScore`、`totalAcScore`、`totalTrScore`、`totalErScore` |
pageNum | integer | opcional | Número de página Ejemplo: 1 |
pageSize | integer | opcional | Número por página, rango 10–100 Ejemplo: 100 |
desc | boolean | opcional | Es el orden descendente Ejemplo: true |
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 (55 campos)
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
code | string | opcional | código de retorno de negocios sf, `"1"` indica éxito |
msg | string | opcional | noticias |
total | integer | opcional | La cantidad real de datos devueltos esta vez |
data | array | opcional | ASIN palabra clave matriz de datos de tráfico |
columns | array | opcional | render column |
type | string | opcional | estilo de renderizado |
title | string | opcional | Título |
costTime | integer | opcional | Tiempo (ms) |
costToken | integer | opcional | Consumir token |
asin | string | opcional | ASIN código |
productTitle | string | opcional | Título del producto |
productImageUrl | string | opcional | Imagen principal URL |
productPrice | number | opcional | Precio de venta del producto |
customerRatingCount | integer | opcional | Calificaciones totales de los clientes |
productStarRating | number | opcional | Categoría de estrella del producto |
productRatingScore | number | opcional | Valor de la calificación del producto |
productUpdateTime | string | opcional | Tiempo de actualización del producto |
dataPeriodStartDate | string | opcional | Fecha de inicio del período de datos |
totalExposureScore | number | opcional | Puntuación de la exposición total |
totalExposureRatio | number | opcional | Cuota total de tráfico |
naturalSearchExposureScore | number | opcional | Puntuación de exposición a la búsqueda orgánica total |
naturalSearchExposureRatio | number | opcional | Relación de exposición a búsquedas naturales |
sponsoredProductsExposureScore | number | opcional | SP anuncio impresión puntuación total |
sponsoredProductsExposureRatio | number | opcional | Relación de exposición a la publicidad de SP |
brandAdExposureScore | number | opcional | Puntuación total de exposición a la publicidad de marca |
brandAdExposureRatio | number | opcional | Proporción de exposición a la publicidad de marcas |
videoAdExposureScore | number | opcional | Puntuación total de exposición a anuncios de vídeo |
videoAdExposureRatio | number | opcional | Relación de exposición a anuncios de vídeo |
amazonsChoiceExposureScore | number | opcional | Puntuación total de la exposición a CA |
amazonsChoiceExposureRatio | number | opcional | Relación de exposición de la CA |
editorialRecommendationsExposureScore | number | opcional | Puntuación de exposición total de urgencias |
editorialRecommendationsExposureRatio | number | opcional | Relación de exposición a ER |
topRatedExposureScore | number | opcional | Puntuación total de exposición a TR |
topRatedExposureRatio | number | opcional | Relación de exposición al TR |
recommendPositionExposureScore | number | opcional | Puntuación total de la exposición a la posición recomendada |
recommendAdExposureScore | number | opcional | Puntuación de exposición a la publicidad recomendada |
recommendAdExposureRatio | number | opcional | Recomendado cuota de tráfico de publicidad |
recommendNonadExposureScore | number | opcional | Posición recomendada Puntuación de la exposición no publicitaria |
recommendNonadExposureRatio | number | opcional | Cuota de tráfico no publicitaria recomendada |
comprehensiveNaturalExposureScore | number | opcional | Puntuación completa del tráfico orgánico |
comprehensiveNaturalExposureRatio | number | opcional | Cotización del tráfico orgánico combinado |
keywordTotalExposureScore | number | opcional | La puntuación total de esta palabra clave |
keywordNaturalExposureScore | number | opcional | Puntuación natural para esta palabra clave |
keywordSponsoredProductsExposureScore | number | opcional | Puntuación SP de esta palabra clave |
keywordBrandAdExposureScore | number | opcional | Marca de puntuación de publicidad para esta palabra clave |
keywordVideoAdExposureScore | number | opcional | Puntuación de anuncios de vídeo para esta palabra clave |
keywordAmazonsChoiceExposureScore | number | opcional | Puntuación AC de esta palabra clave |
keywordRecommendExposureScore | number | opcional | Puntuación de posición recomendada para esta palabra clave |
keywordRecommendAdExposureScore | number | opcional | Puntuación publicitaria para posiciones recomendadas para esta palabra clave |
keywordRecommendNonadExposureScore | number | opcional | Esta posición de recomendación de palabra clave no es una puntuación publicitaria |
keywordComprehensiveNaturalExposureScore | number | opcional | Puntuación natural completa para esta palabra clave |
ppcTrafficSources | array | opcional | Fuente de tráfico de PPC Etiquetas |
naturalSearchTrafficSources | array | opcional | Etiqueta de fuente de tráfico de búsqueda orgánica |
amazonRecommendationSources | array | opcional | Marca de origen recomendada por Amazon |
promotionalDealSources | array | opcional | Etiqueta de la fuente de promoción |
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.