POST
https://api.nexscope.ai/js/keywords/historical-search-volumeEjecutar 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/historical-search-volume |
| 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 |
keyword | string | obligatorio | Palabras clave que se buscarán |
startDate | string | obligatorio | Fecha de inicio (formato: AAAA-MM-DD) |
endDate | string | obligatorio | Fecha de finalización (formato: AAAA-MM-DD); máximo 366 días con excepción de `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 (6 campos)
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
costToken | integer | opcional | Número de fichas consumidas |
historicalSearchVolumeList | array | opcional | Lista de períodos históricos de volumen de búsqueda |
id | string | opcional | Identificación del período de datos (mercado/keyword/date (alcance) |
estimateStartDate | string | opcional | Fecha de inicio del período (AAAA-MM-DD, punto de inicio del período estadístico de 7 días) |
estimateEndDate | string | opcional | Fecha de finalización del período (AAAA-MM-DD, final del período estadístico de 7 días) |
type | string | opcional | Tipo de recurso, valor fijo `historical_keyword_search_volume` |
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.