Pular para o conteúdo

GET /v1/deal-goals/metrics

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

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

Media typeapplication/json
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
source
required
string
Allowed values: deal conversation ticket
kind
required

Acumulavel tem ritmo e projecao; taxa e tempo nao tem

string
Allowed values: cumulative ratio
direction
required

Para que lado a metrica melhora

string
Allowed values: higher lower
brings
required

O que a metrica traz, em uma frase

string
measured
required

Como a metrica e medida, com o criterio exato

string
scopes
required
Array<string>
Allowed values: general pipeline user user_pipeline channel

Example

[
{
"metric": "won_value",
"unit": "brl",
"source": "deal",
"kind": "cumulative",
"direction": "higher",
"scopes": [
"general"
]
}
]