v61

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-011950982.7 KB
goals

Listar metas

Retorna a lista paginada de metas, ordenada por status (ativas primeiro) e por data de criação decrescente. Cada meta inclui suas metas filhas, a contagem de resultados e a variação percentual de progresso em relação ao último resultado registrado.

get/api/management/goals

Query parameters

filter[title]string

Filtra por título (correspondência parcial).

filter[status]'active' | ' inactive' | ' completed'

Filtra pelo status exato: active, inactive ou completed.

filter[type]string

Filtra pelo tipo exato: manual, projects_created, projects_created_by_user, funnel_steps_links, funnel_steps_links_by_user ou composite.

filter[comparison_mode]string

Filtra pelo modo de comparação: target (atingir a meta) ou limit (não ultrapassar).

filter[periodicity]string

Filtra pela periodicidade exata, em dias.

filter[user_id]string

Filtra metas cujo user_id corresponde ao ID do usuário informado.

filter[funnel_step_id]string

Filtra metas cujo funnel_step_id corresponde ao ID da etapa de funil informada.

filter[start_date_gte]string

Retorna metas com data de início maior ou igual à data informada (YYYY-MM-DD).

filter[end_date_lte]string

Retorna metas com data de término menor ou igual à data informada (YYYY-MM-DD).

filter[trashed]string

Controla metas removidas (soft delete): with inclui removidas, only retorna apenas removidas, without (padrão) as ignora.

sortstring

Ordenação. Nome do campo para ascendente ou prefixado com '-' para descendente; múltiplos separados por vírgula. Campos: title, status, created_at, updated_at, start_date, end_date, target, progress, periodicity. Padrão: status,-created_at.

pagestring

Número da página. Padrão 1.

perPagestring

Itens por página. Padrão 30, máximo 100.

Response

Sucesso

responseboolean