Resumo da página de leads

Seção summary da página de leads, carregada quando o bloco entra na tela: total do filtro, com endereço, no mapa (posição que aponta a casa), aproximados (posição de bairro, CEP ou cidade), sem endereço, aniversariantes de hoje no fuso do workspace, bloqueados e janela de 24h aberta. Aceita os mesmos filtros de GET /leads. Fica em cache por 60 segundos por workspace, versão dos dados de leads, filtro e nível de acesso de quem pede; quando o limite de consultas analíticas simultâneas está ocupado, responde 503 com Retry-After. Um filtro em campo sensível sem leads:read_sensitive responde 403 (custom_field_filter_sensitive_forbidden); um filtro por CEP, precisão ou status do mapa ou área sem leads:read_addresses responde 403 (lead_filter_address_forbidden), porque bairro, cidade e UF continuam abertos mas o CEP aponta a rua; um filtro inválido responde 400 (lead_filter_invalid); um filtro de área responde como em GET /leads (area_not_found, area_too_many, area_operator_unsupported). A chave do cache leva a hora da última alteração de cada área do filtro.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Filtro crmfilter em JSON (opcionalmente codificado em base64)

string

Busca livre: cada palavra (2 caracteres ou mais, até 8, sem acento nem caixa) precisa aparecer no nome, apelido, bairro ou cidade do endereço principal ou numa memória; 4 dígitos ou mais buscam no número e nos telefones de contato. Sem palavra utilizável responde 400 lead_search_too_short

Headers
string

Workspace da requisição. Sem ele vale o workspace padrão da pessoa; um workspace do qual ela não participa responde 403 workspace_not_member.

string

Departamento que limita os dados. Quem não participa do departamento recebe 403; donos e administradores escolhem qualquer um.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json