Pular para o conteúdo

POST /v1/deal-goals/search

POST
/v1/deal-goals/search
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).

Media typeapplication/json
object
month
string

Example generated

{
"month": "example"
}
Media typeapplication/json
object
periodStart
required
string
goals
required
Array<object>
object
metric
required
string
Allowed values: won_value won_count created_count service_volume conversion first_response
label
required
string
unit
required
string
Allowed values: brl count pct seconds
kind
required
string
Allowed values: cumulative ratio
direction
required

Higher quando passar do alvo é bom; lower no tempo de resposta

string
Allowed values: higher lower
scopeName
required

Nome de quem ou do que a meta mede; null quando é a empresa toda

string
nullable
achieved
required
number
nullable
targetValue
required
number
missing
required

Quanto falta; null em meta de taxa

number
nullable

Example

{
"goals": [
{
"metric": "won_value",
"unit": "brl",
"kind": "cumulative",
"direction": "higher"
}
]
}

Month_not_started: the month asked has not started yet