Pular para o conteúdo

GET /v1/analytics/fields

GET
/v1/analytics/fields
curl --request GET \
--url 'https://seu-endereco-da-api/v1/analytics/fields?period=7' \
--header 'Authorization: Bearer <token>'

Para cada campo sim/nao ou de lista do contato, quantos contatos tem cada valor (com sem resposta) e quantos negocios desses contatos foram ganhos e perdidos no periodo. Campo sigiloso e campo que quem pede nao ve ficam fora; os negocios seguem o alcance de relatorios de quem pede. Base acima de CONTACT_BASE_CEILING mede uma amostra (sampled).

Permissão que a Chave de acesso precisa: Relatórios de vendas (analytics:sales).

period
string
Allowed values: 7 30 90
Media typeapplication/json
object
period
required
string
Allowed values: 7 30 90
records
required

Contatos medidos

number
sampled
required

True quando a base passou do teto e foi medida uma amostra do tamanho do teto

boolean
fields
required

Campos sim/nao e de lista do contato que quem pediu ve, sem os sigilosos, na ordem da tela

Array<object>
object
key
required
string
label
required
string
type
required
string
Allowed values: BOOLEAN SELECT MULTISELECT
buckets
required
Array<object>
object
value
required

Opcao da lista, “true”/“false” no sim/nao, ou null para sem resposta

string
nullable
contacts
required

Contatos com esse valor (no campo de varias opcoes o contato conta em cada opcao marcada)

number
won
required

Negocios desses contatos ganhos no periodo

number
lost
required

Negocios desses contatos perdidos no periodo

number

Example

{
"period": "7",
"fields": [
{
"type": "BOOLEAN"
}
]
}