Saltar al contenido principal
POST
Inteligencia empresarial
Cada acción devuelve output normalizado. La salida nativa del proveedor no se repite allí; permanece en el Run y puede leerse con Obtener Run. enrich y traffic exponen campos de nivel superior fijos; tech_stack, competitors y news exponen output.items[]; funding expone total_funding_usd además de items[]. Un valor que el proveedor seleccionado no informa es null; Glasser no lo completa. El dinero siempre se expresa en USD. Lee result_status por separado de status: success, no_result, error o pending. Una respuesta vacía pero válida es no_result y conserva la estructura de la acción: todos los campos son null, o items es []. charge_usd totaliza el runs de esta respuesta y es null hasta que todos los Runs se completen. Con provider: auto, el fallback puede crear varios Runs, cada uno incluido en runs[] con su propio cargo. Para una consulta de Similarweb pendiente (traffic mediante Apify, HTTP 202), sigue el result_url autenticado. Consulta Selección de proveedores y cargos.

Salida por acción

Todos los campos están presentes en cada fila; un valor que el proveedor no informa es null. Los campos siguen las convenciones de campos.
  • employees y los campos de ingresos son estimaciones propias del proveedor. revenue_usd es una cifra única; cuando un proveedor solo proporciona un intervalo, es null y los límites del intervalo se encuentran en revenue_range_min_usd / revenue_range_max_usd. employee_range_min / employee_range_max funcionan de la misma manera. Un intervalo abierto como 10000+ tiene un máximo null.
  • country es un nombre de visualización en inglés y country_code es un código ISO 3166-1 alfa-2. ownership es uno de public, private, nonprofit, government, education, other o null; private nunca se infiere.
  • Las puntuaciones del modelo propio de un proveedor llevan su nombre y son null para los demás: predictleads_similarity_score (0–1), exa_similarity_score (similitud neuronal de Exa), predictleads_confidence (0–1), similarweb_global_rank (1 = más visitado). position es el orden basado en 1 de la respuesta del proveedor.
  • competitors mediante Exa devuelve páginas web, no registros de empresas: name es null y el título de la página se encuentra en page_title. Se excluyen las filas del propio dominio de la empresa y de sus subdominios.
  • monthly_visits es mundial (Similarweb). organic_traffic, paid_traffic y los recuentos de palabras clave corresponden a la solicitud country (valor predeterminado us). bounce_rate es una fracción de 0–1.
  • Fechas: *_date y event_date son YYYY-MM-DD, published_at es ISO 8601 UTC y date_text es el texto de visualización de Google News exactamente como se devolvió. Las fechas de financiación de LeadMagic tienen precisión mensual (día 01).
  • industry, categories, round y category son etiquetas del vocabulario propio del proveedor que responde y no son comparables entre proveedores.

Encabezados

idempotency-key
string
requerido

Genera un valor único para cada ejecución prevista (se recomienda un UUID). Reintenta con la misma clave y los parámetros de ejecución para recuperar el Run original sin un segundo cargo. Cambiar los parámetros de ejecución con la misma clave devuelve 409; cambiar task_id o metadata no actualiza el Run original.

Minimum string length: 1

Cuerpo

application/json
action
enum<string> | null

Predeterminado: enrich. search requiere query o un filtro estructurado; lookup requiere query (nombre de la empresa). Todas las demás acciones requieren domain.

  • search: descubrimiento de empresas por sector, rango de empleados, país o tipo de empresa; offset permite paginar. Los filtros estructurados usan la terminología de Hunter; usa query solo para criterios representables mediante estos filtros. Las demás condiciones del ICP deben comprobarse por separado.

  • lookup: candidatos por nombre de empresa con paginación por página; no elijas entre nombres ambiguos.

  • enrich: perfil de la empresa y datos firmográficos.

  • tech_stack, traffic, funding, news: los datos de empresa correspondientes.

  • jobs: ofertas de empleo abiertas encontradas en las páginas de empleo de la propia empresa; limit limita las filas (predeterminado y máximo: 25), por lo que el número de filas no es el total de la empresa.

  • ads: creatividades del Google Ads Transparency Center del anunciante detrás del dominio; country las limita a una región; sin este campo se incluyen todas las regiones.

  • competitors: empresas similares. Para dominios competidores en los resultados de Google, usa la investigación SEO con organic_competitors.

Opciones disponibles:
search,
lookup,
enrich,
tech_stack,
traffic,
competitors,
funding,
news,
jobs,
ads
provider
enum<string> | null

Predeterminado auto: selecciona el primer proveedor de datos elegible según el orden de preferencia de Glasser. Un proveedor de datos nombrado debe admitir la solicitud y estar permitido por tu Key; no hace fallback a otro proveedor de datos. Los valores disponibles se indican a continuación.

Opciones disponibles:
auto,
apollo,
pdl,
hunter,
prospeo,
predictleads,
leadmagic,
builtwith,
dataforseo,
ahrefs,
apify,
exa,
serper,
scrapecreators
domain
string | null

Un dominio web como stripe.com. Se acepta una URL completa y se reduce a su host.

Required string length: 3 - 253
industries
string[] | null
Required array length: 1 - 20 elements
Minimum string length: 1
headcounts
enum<string>[] | null
Required array length: 1 - 8 elements
Opciones disponibles:
1-10,
11-50,
51-200,
201-500,
501-1000,
1001-5000,
5001-10000,
10001+
company_types
enum<string>[] | null
Required array length: 1 - 10 elements
Opciones disponibles:
educational,
educational institution,
government agency,
non profit,
partnership,
privately held,
public company,
self employed,
self owned,
sole proprietorship
offset
integer | null
Rango requerido: 0 <= x <= 10000
page
integer | null
Rango requerido: 1 <= x <= 500
country
string | null

País como código ISO de dos letras o nombre del país, por ejemplo, us, gb, de, Germany. Predeterminado: us. Códigos de país compatibles: us, gb, ca, au, nz, ie, in, sg, de, at, ch, fr, be, es, mx, ar, it, nl, pt, br, jp, kr, cn, hk, tw, ru, pl, se, no, dk, fi, tr, id, th, vn, ph, my, za, ae, il, sa, eg, ng, ua, cz, gr, hu, ro, co, cl, pe, lu. La disponibilidad también depende de la acción y del proveedor de datos. Un país no compatible se rechaza antes de crear un Run. No cambies el país para evitar un error; eso cambia los datos solicitados.

Required string length: 2 - 60
query
string | null

search: prompt para descubrir empresas. lookup: nombre de una empresa. news mediante Serper: nombre de la empresa en lugar del dominio.

Required string length: 1 - 200
limit
integer | null

Filas que se devolverán. Mantén un número reducido: la regla de cargo del endpoint enrutado puede leerlo. Cada capacidad aplica además su propio límite.

Rango requerido: 1 <= x <= 100
task_id
string | null

Agrupa los Runs relacionados, incluido el fallback automático, bajo un único 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 por una letra y tener como máximo 40 caracteres.
  • Valores: cadenas de 1–500 caracteres.
  • user_id: el ID opaco de su End user, nunca su dirección de correo electrónico ni su nombre.

Las entradas no válidas se descartan por completo, sin truncarlas. La solicitud continúa y el Run devuelve los campos almacenados.

Respuesta

Éxito

id
string
requerido
run_url
string
requerido

Abre este Run en la consola. Requiere pertenecer a un 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 sean 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

Campos normalizados por acción. La salida nativa del proveedor de datos no se repite aquí; permanece en el Run (GET /v1/runs/:id). Los valores que un proveedor de datos no informa son null; una respuesta vacía tiene la estructura de la acción con todos los campos en null, o items: [], con result_status no_result. El dinero está expresado en USD. Los empleados y los ingresos son estimaciones propias del proveedor de datos; *_range_min / *_range_max son los límites del intervalo del proveedor de datos. Una puntuación del modelo propio de un proveedor de datos lleva el nombre de ese proveedor (exa_similarity_score) y es null para los demás. Las etiquetas como industry, categories, round y category están en el vocabulario del proveedor de datos que responde.

  • search: total_matches, items[]: domain y los campos del perfil de la empresa; los campos que el proveedor de datos no informa son null
  • lookup: total_matches, items[]: domain y los campos del perfil de la empresa; los nombres ambiguos devuelven candidatos
  • enrich: name, website, description, industry, employees, employee_range_min, employee_range_max, founded_year, city, region, country, country_code, linkedin_url, phone, total_funding_usd, revenue_usd, revenue_range_min_usd, revenue_range_max_usd, ownership, ticker, latest_funding_date
  • tech_stack: items[]: name, categories[], detection_source, predictleads_confidence, first_detected_date, last_detected_date
  • traffic: monthly_visits, organic_traffic, paid_traffic, organic_keywords, paid_keywords, organic_traffic_value_usd, similarweb_global_rank, bounce_rate, pages_per_visit, avg_visit_duration_seconds
  • competitors: items[]: domain, name, page_title, position, predictleads_similarity_score, exa_similarity_score, reason
  • funding: total_funding_usd, items[]: round_date, round, amount_usd, investors[], source_url
  • news: items[]: title, url, source, published_at, event_date, date_text, category, snippet
  • jobs: items[]: title, url, location, seniority, categories[], contract_types[], salary_min_usd, salary_max_usd, salary_period, posted_at, first_seen_at, last_seen_at
  • ads: total_ads, items[]: creative_id, advertiser_id, advertiser_name, format, ad_url, image_url, first_shown_at, last_shown_at
provider_response
object | null
requerido

No es null únicamente cuando el estado 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 sean 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 total de los Runs en esta respuesta de Solution. Null hasta que todos los Runs enumerados se hayan liquidado. Cada Run conserva su propio cargo; los fallos también pueden generar cargos.

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 envío.

stop_requested_at
string<date-time> | null
requerido

Momento en que se solicitó la detención. El Run puede continuar si el envío 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 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.
action
enum<string>
requerido
Opciones disponibles:
search,
lookup,
enrich,
tech_stack,
traffic,
competitors,
funding,
news,
jobs,
ads
result_status
enum<string>
requerido

Estado de entrega empresarial, independiente del ciclo de vida final del Run en status. no_result es una respuesta vacía pero válida; error significa que no se pudo entregar la salida del proveedor de datos.

Opciones disponibles:
success,
no_result,
error,
pending
error
object | null
requerido
runs
object[]
requerido
result_url
string
requerido

Ruta 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 individual nativo.