Pular para o conteúdo

GET /v1/deal-goals

GET
/v1/deal-goals
curl --request GET \
--url 'https://seu-endereco-da-api/v1/deal-goals?periodStart=example' \
--header 'Authorization: Bearer <token>'

Permissão que a Chave de acesso precisa: Ler metas (goals:read).

periodStart
required
string
Media typeapplication/json
object
goals
required
Array<object>
object
id
required
string
scope
required
string
Allowed values: general pipeline user user_pipeline channel
pipelineId
required
string
nullable
userId
required
string
nullable
channelId
required
string
nullable
metric
required
string
Allowed values: won_value won_count created_count service_volume conversion first_response
periodStart
required
string
targetValue
required
number
achieved
required

Sem numero quando a metrica e de taxa e nao houve o que dividir

number
nullable
pace
required

So existe em metrica acumulavel

object
businessDays
required
number
businessDaysElapsed
required
number
businessDaysRemaining
required
number
proportionalTarget
required
number
attainmentPct
required
number
dailyPace
required
number
projection
required
number
missing
required
number
neededPerBusinessDay
required
number
nullable
status
required
string
Allowed values: sem_julgamento no_ritmo atencao fora_do_ritmo
partial
required
boolean
ratio
required

So existe em metrica de taxa ou tempo

object
numerator
required

O de cima da divisao: ganhos, ou a soma dos segundos de espera

number
denominator
required

O de baixo da divisao: criados, ou os atendimentos respondidos

number
met
required
boolean
nullable
previousMonth
required
object
achieved
required
number
nullable
targetValue
required
number
nullable
met
required
boolean
nullable
coverage
required
object
openValue
required
number
ratio
required
number
nullable
createdLostAtStart
required
number
nullable
distribution
required
Array<object>
object
metric
required
string
Allowed values: won_value won_count created_count service_volume conversion first_response
generalTarget
required
number
nullable
userTargetSum
required
number
difference
required
number
nullable

Example

{
"goals": [
{
"scope": "general",
"metric": "won_value",
"pace": {
"status": "sem_julgamento"
}
}
],
"distribution": [
{
"metric": "won_value"
}
]
}