GET /v1/deal-goals
GET
/v1/deal-goals
const url = 'https://seu-endereco-da-api/v1/deal-goals?periodStart=example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Query Parameters
Seção intitulada “Query Parameters”periodStart
required
string
Responses
Seção intitulada “Responses”Media typeapplication/json
object
goals
required
Array<object>
object
id
required
string
scope
required
string
pipelineId
required
string
userId
required
string
channelId
required
string
metric
required
string
periodStart
required
string
targetValue
required
number
achieved
required
Sem numero quando a metrica e de taxa e nao houve o que dividir
number
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
status
required
string
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
previousMonth
required
object
achieved
required
number
targetValue
required
number
met
required
boolean
coverage
required
object
openValue
required
number
ratio
required
number
createdLostAtStart
required
number
distribution
required
Array<object>
object
metric
required
string
generalTarget
required
number
userTargetSum
required
number
difference
required
number
Example
{ "goals": [ { "scope": "general", "metric": "won_value", "pace": { "status": "sem_julgamento" } } ], "distribution": [ { "metric": "won_value" } ]}