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 | news |
total | integer | opcional | Total amount of data, usually 1 |
code | string | opcional | sf business return code, `"1"` indicates success |
data | array | opcional | keyword overview array |
costTime | integer | opcional | Time consuming (ms) |
costToken | integer | opcional | Consume token |
columns | array | opcional | render column |
type | string | opcional | rendering style |
title | string | opcional | Title |
keyword | string | opcional | keywords |
keywordPopularityRank | integer | opcional | Keyword popularity ranking. The smaller the value, the greater the search volume. |
estimatedWeeklySearchVolume | integer | opcional | Estimated search volume per week |
supplyDemandRatio | number | opcional | Supply and demand ratio (number of search results products / monthly search volume), the smaller the value, the smaller the competition and the greater the opportunity. |
totalSearchResultProductCount | integer | opcional | Total number of search results items |
naturalSearchProductCount | integer | opcional | Number of natural search items |
sponsoredProductsCount | integer | opcional | SP number of advertised items |
brandAdProductCount | integer | opcional | Number of brand advertising products |
videoAdProductCount | integer | opcional | Number of video advertising products |
paidAdvertisingProductCount | integer | opcional | Total number of PPC paid advertising products |
amazonChoiceProductCount | integer | opcional | Amazon's Choice item count |
topRatedProductCount | integer | opcional | Top Rated number of items |
searchRecommendationProductCount | integer | opcional | Search the number of recommended products |
editorialRecommendationsProductCount | integer | opcional | Number of items recommended by editors |
recNonadProductCount | integer | opcional | Number of recommended non-advertising products |
recAdProductCount | integer | opcional | Number of recommended advertising products |
trackedAsinTotalCount | integer | opcional | The total number of exposed ASIN deduplication tracked by sf; the upstream field is `totalAsinNum` |
totalMarketplaceKeywordCount | integer | opcional | Total number of site keywords |
dataPeriodStartDate | string | opcional | Data period start date |
dataPeriodEndDate | string | opcional | Data period end date |
keywordDataUpdateTime | string | opcional | Keyword data update time |
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 una clave API ausente o no válida (code 11209, incluida una copia incompleta o dañada) o una sesión web caducada (code 12001), 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.