Skip to main content
POST
Criar uma meta

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Dados da nova meta. Campos fora desta lista são ignorados.

title
string
required

Título da meta. Até 90 caracteres.

Maximum string length: 90
type
enum<string>
required

Tipo da meta, que define como o progresso é apurado: manual (informado à mão), projects_created (projetos criados), projects_created_by_user (projetos criados por um usuário), funnel_steps_links (entradas em uma etapa de funil), funnel_steps_links_by_user (entradas em uma etapa de funil feitas por um usuário) e composite (soma do progresso das metas filhas).

Available options:
manual,
projects_created,
projects_created_by_user,
funnel_steps_links,
funnel_steps_links_by_user,
composite
start_date
string<date>
required

Data de início da apuração, no formato YYYY-MM-DD.

target
integer
required

Valor alvo da meta, na unidade indicada em unit. Mínimo 1.

Required range: x >= 1
description
string

Descrição livre da meta. Até 255 caracteres.

Maximum string length: 255
status
enum<string>

Situação da meta: active (em apuração), inactive (pausada, sem cálculo automático) ou completed (encerrada). Quando omitido na criação, a meta nasce inactive.

Available options:
active,
inactive,
completed
user_id
string<uuid>

Usuário ao qual a meta fica restrita. Obrigatório nos tipos projects_created_by_user e funnel_steps_links_by_user e proibido nos demais (envie nulo). O usuário precisa fazer parte da empresa.

funnel_step_id
integer

Etapa de funil apurada pela meta. Obrigatório nos tipos funnel_steps_links e funnel_steps_links_by_user e proibido nos demais (envie nulo).

end_date
string<date>

Data de término da apuração, no formato YYYY-MM-DD. Precisa ser posterior a start_date. Nulo deixa a meta sem prazo final.

periodicity
integer

Tamanho de cada período de apuração, em dias (0 a 365). Use 0 para apurar o intervalo inteiro de uma vez, sem quebrar em períodos.

Required range: 0 <= x <= 365
unit
enum<string>

Unidade do alvo e do progresso: count (quantidade), currency (valor monetário) ou percentage (porcentagem). Padrão count.

Available options:
count,
currency,
percentage
comparison_mode
enum<string>

Leitura do alvo: target quando a meta é atingir o valor, limit quando a meta é não ultrapassá-lo. Padrão target.

Available options:
target,
limit
progress
integer

Progresso da meta. Só é aceito (e passa a ser obrigatório) em metas do tipo manual com status active; nos demais casos é ignorado, porque o progresso é calculado pelo sistema.

Required range: x >= 0
children
string<uuid>[]

IDs das metas que compõem esta meta. Obrigatório no tipo composite e proibido nos demais (envie uma lista vazia). Não aceita IDs repetidos, nem a própria meta ou alguma de suas metas-pai, para não criar ciclo.

ID de uma meta da mesma empresa que entra na composição.

Response

Sucesso

Meta criada.

response
boolean

Indicador de sucesso da requisição. Sempre true nas respostas bem-sucedidas.

goal
object

Dados da meta. As metas filhas (children) e a contagem de resultados (results_count) não vêm nesta resposta.