Pessoas identificadas no site

Request

Contatos identificados que passaram por este site no período.

Contatos vêm mascarados (isMasked: true, campos como **********) enquanto a empresa não tiver gasto um crédito naquela pessoa. Use o visitorId de cada item em POST /reveal/visitors/{visitor_id}/unmask/ para revelar.

Security

ApiKeyAuth

Path

site_idintegerrequired

ID do site (vem de /reveal/sites/).

Example:13

Query

startDatestring, (date)

Início do período, YYYY-MM-DD (inclusive). Sem startDate/endDate, assume-se os últimos 30 dias. O máximo é 90 dias por chamada.

Example:startDate=2026-07-01

endDatestring, (date)

Fim do período, YYYY-MM-DD (inclusive). Padrão, hoje.

Example:endDate=2026-07-31

pageinteger

Página, começando em 1.

Default:1

limitinteger, <= 100

Itens por página (máx. 100).

Default:25

onlyNewboolean

true devolve apenas quem apareceu pela primeira vez neste site dentro do período — o recorte que indica novidade, e não recorrência. A contagem total de estreantes vem em newInPeriod, independente deste filtro.

Example:onlyNew=true

searchstring

Filtra pelo nome da pessoa (busca parcial).

sourcestring

Como a pessoa foi identificada.

Enum:"form""user_input""datareveal""cookie""unification""enrichment""unknown"

enrichmentStatusstring

Situação do enriquecimento do contato.

Enum:"pending""enriched""failed""skipped""finalized"

curl -i -X GET \
  'https://docs.datastone.com.br/_mock/api/reveal/sites/13/people/?startDate=2026-07-01&endDate=2026-07-31&page=1&limit=25&onlyNew=true&search=string&source=form&enrichmentStatus=pending' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Pessoas identificadas

Bodyapplication/json

resultsArray of objects(RevealPessoa)

metaobject(RevealMeta)

newInPeriodinteger

Quantos, no período inteiro, apareceram pela primeira vez — não só nesta página.

Example:4

Response

{
  "results": [
    { … }
  ],
  "meta": {
    "currentPage": 1,
    "limit": 25,
    "totalItems": 137,
    "totalPages": 6
  },
  "newInPeriod": 4
}