CONTAGEM E SOLICITAÇÃO JOB

post

https://api.datastone.com.br/v1/persons/prospect/

Este endpoint permite duas operações, conforme o parâmetro export enviado no body:

Contagem: Se export for false, retorna a quantidade total de pessoas cadastradas conforme os filtros aplicados.

Prospecção: Se export for true, cria um job de prospecção com os filtros e quantidade informada, retornando um ID. Caso um webhook esteja cadastrado, você receberá uma notificação quando o arquivo estiver processado.

Nota: Ao enviar uma localização preenchida (cities ou states) a outra deverá ser vazia.

Body Params

name

string

required

Nome da prospecção

cities

array of strings

Lista de cidades para filtrar os resultados. Cada item deve seguir o formato “Cidade - UF”, onde “UF” é a sigla do estado.

cities

states

array of strings

Lista de siglas dos estados para filtrar os resultados.

states

age

object

Objeto que define a faixa etária para filtrar os resultados. Utilize lower para a idade mínima e upper para a idade máxima.

birthday_months

array of strings

Lista de valores que indicam os meses de nascimento para filtrar.

birthday_months

contact_channels

array of strings

required

Lista de canais de contato desejados para filtrar os resultados. Os valores válidos são: whatsapp (celular com WhatsApp ativo) sms (celular) phone (celular ou fixo) email address

contact_channels*

export

boolean

required

Defaults to false

Indica se o endpoint deve apenas retornar a contagem ou iniciar o job de prospecção. Se export for true e o parâmetro quantity for informado, inicia o job de prospecção. Se export for false, retorna apenas a quantidade total (count) conforme os filtros.

quantity

integer

Define a quantidade de registros que devem ser incluídos na prospecção quando export for true. Se não for informado ou export estiver em false, o endpoint apenas retorna a contagem sem iniciar o job.

file_formatting

string

Defaults to excel

Define o formato de saída do arquivo gerado pela prospecção. Utilize "excel" para obter um arquivo no formato Excel (.xlsx). Utilize "csv" para obter um arquivo no formato CSV (.csv).

cbo_codes

array of strings

Lista de códigos CBO (Classificação Brasileira de Ocupações) para filtrar os resultados.

cbo_codes

match_profile

array of strings

Define o perfil de correspondência para filtrar os resultados com base na segmentação do usuário. Utilize os seguintes valores: PF1: Comprador(a) De Supermercado Premium PF2: Comprador(a) Loja De Departamento PF3: Cliente Fiel Ao Banco PF4: Viciado Em Cupom De Desconto PF5: Pensando No Futuro PF6: Viciado Em Telas PF7: Cliente Fiel PF8: Cuida Da Saúde PF9: Perfil Gamer PF10: Ativo Na Internet PF11: Perfil "Passa Tudo No Cartão" PF12: Usuário De Seguros Em Geral PF13: Viajante PF14: Perfil "Vai De Busão"

match_profile

plan

string

required

Define o tipo de plano a ser aplicado na prospecção. Utilize "1" para o plano simples. Utilize "3" para o plano premium.

Responses

200

400Bad Request