Pular para o conteúdo principal
POST
Inteligência de empresas
Cada ação retorna output normalizado. A saída nativa do Provider não é repetida nele; ela permanece no Run e pode ser lida com Get Run. enrich e traffic expõem campos de nível superior fixos; tech_stack, competitors e news expõem output.items[]; funding expõe total_funding_usd mais items[]. Um valor que o Provider selecionado não relata é null; o Glasser não o preenche. Valores monetários são sempre em USD. Leia result_status separadamente de status: success, no_result, error ou pending. Uma resposta vazia, mas válida, é no_result e mantém o formato da ação: cada campo é null, ou items é []. charge_usd totaliza o runs desta resposta e é nulo até que todos os Runs sejam concluídos. Com provider: auto, o fallback pode criar vários Runs, cada um listado em runs[] com sua própria cobrança. Para uma consulta Similarweb pendente (traffic via Apify, HTTP 202), siga o result_url autenticado. Consulte Seleção de Provider e cobranças.

Saída por ação

Cada campo está presente em cada linha; um valor que o Provider não relata é null. Os campos seguem as convenções de campos.
  • employees e os campos de receita são estimativas do próprio Provider. revenue_usd é um único valor; quando um Provider fornece apenas uma faixa, ele é null e os limites da faixa estão em revenue_range_min_usd / revenue_range_max_usd. employee_range_min / employee_range_max funcionam da mesma forma. Uma faixa sem limite superior, como 10000+, tem um máximo null.
  • country é um nome de exibição em inglês e country_code é um código ISO 3166-1 alpha-2. ownership é um dos valores public, private, nonprofit, government, education, other ou null; private nunca é inferido.
  • As pontuações do próprio modelo de um Provider trazem o nome dele e são null para os demais: predictleads_similarity_score (0–1), exa_similarity_score (similaridade neural da Exa), predictleads_confidence (0–1), similarweb_global_rank (1 = mais visitado). position é a ordem baseada em 1 na resposta do Provider.
  • competitors via Exa retorna páginas da web, não registros de empresas: name é null e o título da página está em page_title. As linhas do próprio domínio da empresa e de seus subdomínios são excluídas.
  • monthly_visits é mundial (Similarweb). organic_traffic, paid_traffic e as contagens de palavras-chave referem-se à solicitação country (padrão us). bounce_rate é uma fração de 0 a 1.
  • Datas: *_date e event_date são YYYY-MM-DD, published_at é ISO 8601 UTC e date_text é o texto de exibição do Google News exatamente como retornado. As datas de financiamento do LeadMagic têm precisão mensal (dia 01).
  • industry, categories, round e category são rótulos no vocabulário próprio do Provider que responde e não são comparáveis entre Providers.

Cabeçalhos

idempotency-key
string
obrigatório

Gere um valor exclusivo para cada execução pretendida (recomenda-se um UUID). Tente novamente com a mesma chave e os mesmos parâmetros de execução para recuperar o Run original sem uma segunda cobrança. Alterar os parâmetros de execução com a mesma chave retorna 409; alterar task_id ou metadata não atualiza o Run original.

Minimum string length: 1

Corpo

application/json
action
enum<string> | null

Padrão: enrich. search exige query ou um filtro estruturado; lookup exige query (nome da empresa). Todas as outras ações exigem domain.

  • search: descoberta de empresas por setor, faixa de número de funcionários, país ou tipo de empresa; offset faz a paginação. Filtros estruturados usam o vocabulário do Hunter; use query apenas para critérios representáveis por esses filtros. Outras condições de ICP devem ser verificadas separadamente.

  • lookup: candidatos por nome de empresa com paginação por página; não faça suposições entre nomes ambíguos.

  • enrich: perfil e dados firmográficos da empresa.

  • tech_stack, traffic, funding, news: os dados correspondentes da empresa.

  • jobs: vagas abertas encontradas nas próprias páginas de carreira da empresa; limit limita as linhas (padrão e máximo de 25), portanto a quantidade de linhas não é o total da empresa.

  • ads: criativos do Google Ads Transparency Center do anunciante por trás do domínio; country os restringe a uma região; sem esse campo, todas as regiões são incluídas.

  • competitors: empresas semelhantes. Para domínios concorrentes nos resultados do Google, use pesquisa de SEO com organic_competitors.

Opções disponíveis:
search,
lookup,
enrich,
tech_stack,
traffic,
competitors,
funding,
news,
jobs,
ads
provider
enum<string> | null

Padrão auto: seleciona o primeiro provedor de dados elegível na ordem de preferência da Glasser. Um provedor de dados nomeado deve ser compatível com a solicitação e permitido pela sua Key; ele não usa fallback para outro provedor de dados. Os valores disponíveis estão listados abaixo.

Opções disponíveis:
auto,
apollo,
pdl,
hunter,
prospeo,
predictleads,
leadmagic,
builtwith,
dataforseo,
ahrefs,
apify,
exa,
serper,
scrapecreators
domain
string | null

Um domínio de site, como stripe.com. Uma URL completa é aceita e reduzida ao 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
Opções disponíveis:
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
Opções disponíveis:
educational,
educational institution,
government agency,
non profit,
partnership,
privately held,
public company,
self employed,
self owned,
sole proprietorship
offset
integer | null
Intervalo obrigatório: 0 <= x <= 10000
page
integer | null
Intervalo obrigatório: 1 <= x <= 500
country
string | null

País como código ISO de duas letras ou nome do país, por exemplo, us, gb, de, Germany. Padrão us. Códigos de país compatíveis: 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. A disponibilidade também depende da ação e do provedor de dados. Um país incompatível é recusado antes da criação de um Run. Não altere o país para contornar um erro; isso altera os dados solicitados.

Required string length: 2 - 60
query
string | null

search: um prompt de descoberta de empresas. lookup: um nome de empresa. news via Serper: nome da empresa em vez do domínio.

Required string length: 1 - 200
limit
integer | null

Linhas a retornar. Mantenha o número pequeno: a regra de cobrança do endpoint roteado pode considerá-lo. Cada capacidade impõe um limite adicional.

Intervalo obrigatório: 1 <= x <= 100
task_id
string | null

Agrupe Runs relacionados, incluindo o fallback automático, sob uma única Task. Reutilize uma string estável e filtre a lista de Runs por task para recuperá-los.

metadata

Campos opcionais de rastreamento, retornados no Run e disponíveis como filtros. Eles nunca são enviados ao provedor de dados nem afetam o roteamento, o Price ou a idempotência.

  • Até 20 chaves: letras minúsculas, dígitos e sublinhados; comece com uma letra; no máximo 40 caracteres.
  • Valores: strings de 1–500 caracteres.
  • user_id: o ID opaco do seu usuário final, nunca o endereço de e-mail ou o nome.

Entradas inválidas são descartadas por inteiro, não truncadas. A solicitação continua, e o Run retorna os campos que foram armazenados.

Resposta

Success

id
string
obrigatório
run_url
string
obrigatório

Abra este Run no console. Requer associação ao Workspace.

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

QUEUED ou RUNNING: ainda em andamento. COMPLETED: uma resposta do provedor de dados está disponível, incluindo respostas não 2xx. FAILED: consulte failure. STOPPED: interrompido antes do dispatch. Leia charge_usd separadamente de status.

Opções disponíveis:
QUEUED,
RUNNING,
COMPLETED,
FAILED,
STOPPED
failure
object | null
obrigatório

Motivo da falha do Run. Não nulo somente quando status é FAILED.

input
object
obrigatório
output
object
obrigatório

Campos normalizados por ação. A saída nativa do provedor de dados não é repetida aqui; ela permanece no Run (GET /v1/runs/:id). Os valores que um provedor de dados não informa são nulos; uma resposta vazia usa o formato da ação com todos os campos nulos ou items: [], com result_status no_result. Os valores monetários estão em USD. Employees e revenue são estimativas do próprio provedor de dados; *_range_min / *_range_max são os limites da faixa do provedor de dados. Uma pontuação do modelo próprio de um provedor de dados recebe o nome desse provedor (exa_similarity_score) e é nula para os demais. Rótulos como industry, categories, round e category seguem o vocabulário do provedor de dados que responde.

  • search: total_matches, items[]: domain e os campos do perfil da empresa; os campos não informados pelo provedor de dados são nulos
  • lookup: total_matches, items[]: domain e os campos do perfil da empresa; nomes ambíguos retornam 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
obrigatório

Não nulo somente quando o status é COMPLETED.

  • Para respostas 2xx, output contém JSON nativo do provedor de dados (qualquer formato) ou nulo para um corpo vazio.
  • Para respostas não 2xx, error contém o corpo de erro do provedor de dados e output é nulo.

Os campos confidenciais são removidos de ambos os corpos.

charge_usd
string | null
obrigatório

Cobrança total dos Runs nesta resposta de Solution. Nulo até que todos os Runs listados sejam liquidados. Cada Run mantém sua própria cobrança; falhas também podem ser cobradas.

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

Base da cobrança de um único Run ou nulo para um total de vários Runs. Leia runs[].charge_basis para cada cobrança.

stoppable
boolean
obrigatório

Indica se uma solicitação de parada pode ser aceita no momento. Isso não garante que o Run possa ser interrompido antes do dispatch.

stop_requested_at
string<date-time> | null
obrigatório

Quando uma parada foi solicitada. O Run ainda pode continuar se o dispatch já tiver começado.

created_at
string<date-time>
obrigatório

Carimbo de data e hora UTC ISO-8601

started_at
string<date-time> | null
obrigatório

Carimbo de data e hora UTC ISO-8601

completed_at
string<date-time> | null
obrigatório

Carimbo de data e hora UTC ISO-8601

task_id
string | null
obrigatório
metadata
object
obrigatório

Seus campos de rastreamento armazenados. Use-os para filtrar Runs. Eles nunca são enviados ao provedor de dados nem afetam o roteamento, o Price ou a idempotência.

  • Até 20 chaves: letras minúsculas, dígitos e sublinhados; comece com uma letra; no máximo 40 caracteres.
  • Valores: strings de 1–500 caracteres.
  • user_id: o ID opaco do seu usuário final, nunca o endereço de e-mail ou o nome dele.
action
enum<string>
obrigatório
Opções disponíveis:
search,
lookup,
enrich,
tech_stack,
traffic,
competitors,
funding,
news,
jobs,
ads
result_status
enum<string>
obrigatório

Status de entrega comercial, independente do ciclo de vida final do Run em status. no_result é uma resposta vazia, mas válida; error significa que não foi possível entregar a saída do provedor de dados.

Opções disponíveis:
success,
no_result,
error,
pending
error
object | null
obrigatório
runs
object[]
obrigatório
result_url
string
obrigatório

Caminho de URL autenticado e somente leitura para consultar este resultado normalizado e a cobrança total. Use-o com a origem da API. Não cria Runs nem retoma o fallback. GET /v1/runs/:id ainda retorna o Run individual nativo.