Saltar al contenido principal
POST
Investigación de Amazon
Indica el mercado. Acciones: search, product, keywords, keyword_volume, reviews, price_history, offers, merchant_search y merchant_page. Cotiza primero; max_charge_usd rechaza solicitudes que superan el presupuesto antes de crear el Run. Los valores desconocidos son null. Registra páginas y filtros observados sin afirmar prevalencia poblacional. Conserva serie, moneda y fecha de precios. Las ofertas en caché no son precios de compra verificados. Lee result_url con autenticación para resultados pendientes; los datos nativos permanecen en el Run.

Encabezados

idempotency-key
string
requerido

Genere un valor único nuevo (preferiblemente un UUID aleatorio) para cada consulta independiente, incluso con los mismos parámetros el mismo día. Recupere la misma ejecución con su clave y parámetros originales para obtener el Run original sin otro cargo. Cambiar los parámetros de ejecución con la misma clave devuelve 409; cambiar task_id o metadata no inicia un Run nuevo. Las claves opacas existentes siguen siendo válidas para recuperación.

Minimum string length: 1

Cuerpo

application/json

merchant_search: query e idioma opcional; merchant_page: url pública. search: query y page opcional; product/reviews/offers: asin exacto. reviews admite review_pages, review_rating, review_sort, verified_only y review_keyword. keywords: query y language/limit/offset opcionales, solo us/en. keyword_volume: keywords e idioma. max_charge_usd limita el cargo antes del Run. price_history: asin y days opcional, 180 por defecto. Los campos incompatibles se rechazan antes de cobrar. Sin cambios de productos, estimaciones de tarifas ni supervisión automática.

action
enum<string>
requerido
Opciones disponibles:
search,
product,
keywords,
keyword_volume,
reviews,
price_history,
offers,
merchant_search,
merchant_page
country
string
requerido

Mercado de Amazon explícito. Las consultas generales admiten us, gb, de, fr, it, es, ca, jp, in y au; términos relacionados solo us/en. keyword_volume admite sus propios pares de región e idioma.

Minimum string length: 1
provider
enum<string> | null

Auto predeterminado: selecciona el primer proveedor de datos elegible según el orden de preferencia de Glasser. Un proveedor de datos especificado debe admitir la solicitud y estar permitido por tu API Key; no recurre a otro proveedor de datos. Los valores disponibles se muestran a continuación.

Opciones disponibles:
auto,
serpapi,
dataforseo,
apify,
keepa,
serper
max_charge_usd
string | null

Cadena decimal exacta en USD (mínimo 2 y máximo 6 decimales, con una única representación canónica). Suma con aritmética decimal o escala por 10^6; nunca uses números de coma flotante.

Maximum string length: 20
Pattern: ^(0|[1-9]\d*)\.(\d{2}|\d{2}\d{0,3}[1-9])$
review_pages
integer | null
Rango requerido: 1 <= x <= 10
review_rating
integer | null
Rango requerido: 1 <= x <= 5
review_sort
enum<string> | null
Opciones disponibles:
recent,
helpful
verified_only
boolean | null
review_keyword
string | null
Required string length: 1 - 200
url
string | null
Required string length: 1 - 2048
Pattern: ^https?:\/\/
query
string | null
Required string length: 1 - 200
keywords
string[] | null
Required array length: 1 - 1000 elements
Minimum string length: 1
asin
string | null
Pattern: ^[A-Z0-9]{10}$
page
integer | null
Rango requerido: 1 <= x <= 20
limit
integer | null
Rango requerido: 1 <= x <= 100
offset
integer | null
Rango requerido: 0 <= x <= 10000
language
string | null
Minimum string length: 1
days
integer | null
Rango requerido: x >= 1
task_id
string | null

Agrupa los Runs relacionados, incluido el fallback automático, en un solo Task. Reutiliza una cadena estable y filtra la lista de Runs por task para recuperarlos.

metadata

Campos de seguimiento opcionales, devueltos en el Run y disponibles como filtros. Nunca se envían al proveedor de datos ni afectan al enrutamiento, Price o la idempotencia.

  • Hasta 20 claves: letras minúsculas, dígitos y guiones bajos; deben comenzar con una letra y tener como máximo 40 caracteres.
  • Valores: cadenas de 1–500 caracteres.
  • user_id: el ID opaco de tu usuario final, nunca su dirección de correo electrónico ni su nombre.

Las entradas no válidas se descartan por completo, no se truncan. La solicitud continúa y el Run devuelve los campos que se almacenaron.

Respuesta

Éxito

id
string
requerido
run_url
string
requerido

Abre este Run en la consola. Requiere pertenecer al Workspace.

provider
string
requerido
Pattern: ^[a-z0-9][a-z0-9-]*$
endpoint
string
requerido
Pattern: ^\/.+$
endpoint_version
integer
requerido
status
enum<string>
requerido

QUEUED o RUNNING: todavía está en curso. COMPLETED: hay una respuesta del proveedor de datos disponible, incluidas las respuestas que no son 2xx. FAILED: consulta failure. STOPPED: detenido antes del dispatch. Consulta charge_usd por separado de status.

Opciones disponibles:
QUEUED,
RUNNING,
COMPLETED,
FAILED,
STOPPED
failure
object | null
requerido

Motivo por el que falló el Run. Solo es distinto de null cuando status es FAILED.

input
object
requerido
output
object
requerido
provider_response
object | null
requerido

Solo es distinto de null cuando status es COMPLETED.

  • Para respuestas 2xx, output contiene JSON nativo del proveedor de datos (con cualquier estructura) o null si el cuerpo está vacío.
  • Para respuestas que no son 2xx, error contiene el cuerpo del error del proveedor de datos y output es null.

Los campos sensibles se eliminan de ambos cuerpos.

charge_usd
string | null
requerido

Cargo histórico total de los Runs enumerados, incluidos los repetidos o leídos. Es null hasta que todos se liquiden. No es gasto nuevo de la solicitud actual; request_charge lo informa por separado. Los fallos también pueden tener cargo.

Pattern: ^(0|[1-9]\d*)\.(\d{2}|\d{2}\d{0,3}[1-9])$
charge_basis
object | null
requerido

Base del cargo de un único Run, o null para un total de varios Runs. Consulta runs[].charge_basis para cada cargo.

stoppable
boolean
requerido

Indica si actualmente se puede aceptar una solicitud de detención. Esto no garantiza que el Run pueda detenerse antes del dispatch.

stop_requested_at
string<date-time> | null
requerido

Momento en que se solicitó la detención. El Run puede continuar si el dispatch ya había comenzado.

created_at
string<date-time>
requerido

Marca de tiempo UTC ISO-8601

started_at
string<date-time> | null
requerido

Marca de tiempo UTC ISO-8601

completed_at
string<date-time> | null
requerido

Marca de tiempo UTC ISO-8601

task_id
string | null
requerido
metadata
object
requerido

Tus campos de seguimiento almacenados. Úsalos para filtrar Runs. Nunca se envían al proveedor de datos ni afectan al enrutamiento, Price o la idempotencia.

  • Hasta 20 claves: letras minúsculas, dígitos y guiones bajos; deben comenzar por una letra; como máximo 40 caracteres.
  • Valores: cadenas de 1–500 caracteres.
  • user_id: el ID opaco de tu usuario final, nunca su dirección de correo electrónico ni su nombre.
action
enum<string>
requerido
Opciones disponibles:
search,
product,
keywords,
keyword_volume,
reviews,
price_history,
offers,
merchant_search,
merchant_page
result_status
enum<string>
requerido
Opciones disponibles:
success,
no_result,
error,
pending
error
object | null
requerido
runs
object[]
requerido
result_url
string
requerido

Ruta de URL autenticada y de solo lectura para consultar este resultado normalizado y el cargo total. Úsala con el origen de la API. No crea Runs ni reanuda el fallback. GET /v1/runs/:id sigue devolviendo el Run nativo e individual.

response_file
object

Cuerpo completo de gran tamaño del proveedor de datos, entregado como archivo JSON. Glasser aplica un límite de recursos de 32 MiB al cuerpo capturado y al archivo serializado. body_field identifica el campo sustituido; output es null o se omite provider_response.error. Los enlaces de descarga caducan como máximo en una hora. Get Run con autenticación renueva la URL mientras el archivo esté disponible, durante 7 días. Las lecturas y descargas no ejecutan ni cobran otro Run. Si state es link_pending, consulta el mismo Run para preparar el enlace sin otra ejecución ni otro cargo. La URL concede acceso temporal de lectura: compártela solo con los destinatarios previstos.

review_invitation
object

Aparece como máximo una vez por Run, en la primera entrega de algunos Runs completados. Después de usar este resultado en la tarea, envía una reseña como indica instruction y continúa. Es opcional; nunca afecta al Run ni a su cargo.

request_charge
object

Evidencia de admisión y cargo de la solicitud actual. Conserve created_run_ids durante el trabajo del usuario y cuente cada Run liquidado una sola vez. Cambiar task_id no convierte una repetición idempotente en un Run nuevo. Leer un resultado tiene cargo cero y listas de admisión vacías.