https://api.nexscope.ai/amazonAds/reporting/reports/by-reportIdEjecutar 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/amazonAds/reporting/reports/by-reportId |
| Autenticación | Bearer API key |
| Content-Type | application/json |
Parámetros de la solicitud
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
connectionId | integer | obligatorio | Una conexión de Amazon Ads propiedad de la autentificada Nexscope usuario. |
reportId | string | obligatorio | ID de informe creado; creación omitida después de pasado en. |
name | string | opcional | Nombre de la pantalla del informe. |
timeUnit | string | opcional | `DAILY` o `SUMMARY`. Ejemplo: SUMMARY |
format | string | opcional | Informe de formato de archivo. Ejemplo: GZIP_JSON |
filters | array | opcional | Las enumeraciones de campo y valor se basan en el archivo de tipo informe correspondiente. |
pollInterval | integer | opcional | Intervalo de sondeo en segundos. Ejemplo: 30 |
maxAttempts | integer | opcional | Número máximo de encuestas, ventana de espera por defecto de aproximadamente 10 minutos. Ejemplo: 20 |
skipDepCheck | boolean | opcional | No verifiques la dependencia. Ejemplo: false |
serveExtractedFileHttp | boolean | opcional | Si se debe iniciar el servicio HTTP temporal nativo. Ejemplo: true |
serveHost | string | opcional | Dirección de enlace de servicio nativo. |
servePort | integer | opcional | 0 indica el puerto asignado al sistema. Ejemplo: 0 |
serveSeconds | integer | opcional | El número de segundos que el enlace local permanece vivo. Ejemplo: 300 |
includeAmazonSourceUrl | boolean | opcional | Si se debe devolver el origen prescripto de Amazon URL. Ejemplo: false |
confirmationToken | string | opcional | Para mutaciones, primero previsualice sin un token, luego confirme usando el token de uso único devuelto. |
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 (12 campos)
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
success | boolean | opcional | Si descargar y descomprimir correctamente. |
reportId | string | opcional | Identificación de la Amazonia. |
status | string | opcional | `PENDING`, `PROCESSING`, `COMPLETED` o `FAILED`. |
reportTypeId | string | opcional | El tipo de informe solicitado. |
pollAttempts | integer | opcional | Número de encuestas realizadas. |
elapsedSeconds | number | opcional | El número de segundos transcurridos. |
downloadPath | string | opcional | La ruta local de archivos descargada o descomprimida. |
extractedFileHttpUrl | string | opcional | Archivo temporal nativo URL (si está activado). |
serveExpiresAt | string | opcional | Nativo URL tiempo de caducidad (si se devuelve). |
failureReason | string | opcional | Motivo del fallo en la fase inicial `FAILED`. |
resumeHint.mode | string | opcional | `poll-only`。 |
resumeHint.params | object | opcional | Reutilizar lo mismo reportId y aumentar maxAttempts para seguir votando. |
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.