POST /v1/deal-goals/search
POST
/v1/deal-goals/search
const url = 'https://seu-endereco-da-api/v1/deal-goals/search';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"month":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://seu-endereco-da-api/v1/deal-goals/search \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "month": "example" }'Permissão que a Chave de acesso precisa: Ler metas (goals:read).
Authorizations
Seção intitulada “Authorizations”Request Bodyrequired
Seção intitulada “Request Bodyrequired”Media typeapplication/json
object
month
string
Example generated
{ "month": "example"}Responses
Seção intitulada “Responses”Media typeapplication/json
object
periodStart
required
string
goals
required
Array<object>
object
metric
required
string
label
required
string
unit
required
string
kind
required
string
direction
required
Higher quando passar do alvo é bom; lower no tempo de resposta
string
scopeName
required
Nome de quem ou do que a meta mede; null quando é a empresa toda
string
achieved
required
number
targetValue
required
number
missing
required
Quanto falta; null em meta de taxa
number
Example
{ "goals": [ { "metric": "won_value", "unit": "brl", "kind": "cumulative", "direction": "higher" } ]}Month_not_started: the month asked has not started yet