---
title: "Obter detalhes de uma meta"
method: GET
path: "/api/management/goals/{goal}"
tags: ["goals"]
---

# Obter detalhes de uma meta

`GET /api/management/goals/{goal}`

Retorna os dados de uma meta, com as metas filhas e a contagem de resultados já apurados. Enviar o parâmetro `refresh` recalcula e grava o progresso antes de responder.

## Query parameters

- `refresh` string

## Response `200`

Sucesso

- object — Meta solicitada.
  - `response` boolean — Indicador de sucesso da requisição. Sempre true nas respostas bem-sucedidas.
  - `goal` object — Dados da meta.
    - `id` string, uuid — ID da meta.
    - `title` string — Título da meta.
    - `description` string, nullable — Descrição livre da meta.
    - `status` 'active' | 'inactive' | 'completed' — Situação da meta: active (em apuração), inactive (pausada, sem cálculo automático) ou completed (encerrada).
    - `start_date` string, date — Data de início da apuração, no formato YYYY-MM-DD.
    - `end_date` string, date, nullable — Data de término da apuração, no formato YYYY-MM-DD. Nulo quando a meta não tem prazo final.
    - `periodicity` integer, nullable — 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.
    - `type` 'manual' | 'projects_created' | 'projects_created_by_user' | 'funnel_steps_links' | 'funnel_steps_links_by_user' | 'composite' — 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).
    - `user_id` string, uuid, nullable — Usuário ao qual a meta está restrita. Preenchido apenas nos tipos projects_created_by_user e funnel_steps_links_by_user.
    - `funnel_step_id` integer, nullable — Etapa de funil apurada pela meta. Preenchido apenas nos tipos funnel_steps_links e funnel_steps_links_by_user.
    - `target` integer, nullable — Valor alvo da meta, na unidade indicada em unit.
    - `unit` 'count' | 'currency' | 'percentage' — Unidade do alvo e do progresso: count (quantidade), currency (valor monetário) ou percentage (porcentagem).
    - `comparison_mode` 'target' | 'limit' — Leitura do alvo: target quando a meta é atingir o valor, limit quando a meta é não ultrapassá-lo.
    - `progress` integer — Progresso apurado no período corrente.
    - `progress_change_percentage` number — Variação percentual do progresso atual em relação ao último resultado apurado. Vale 0 quando não há resultado anterior carregado.
    - `percentage` integer — Percentual do alvo já alcançado, arredondado para baixo.
    - `is_past_calculable` boolean — Indica se a meta consegue recalcular períodos passados. Falso nos tipos manual e composite.
    - `created_at` string, date-time — Momento em que a meta foi criada.
    - `updated_at` string, date-time — Momento da última alteração da meta.
    - `deleted_at` string, date-time, nullable — Momento em que a meta foi removida por soft delete. Nulo enquanto a meta existir.
    - `results_count` integer — Quantidade de resultados já apurados da meta.
    - `children` object[] — Metas filhas somadas em metas do tipo composite. Vem vazio nos demais tipos.
      - `id` string, uuid — ID da meta.
      - `title` string — Título da meta.
      - `description` string, nullable — Descrição livre da meta.
      - `status` 'active' | 'inactive' | 'completed' — Situação da meta: active (em apuração), inactive (pausada, sem cálculo automático) ou completed (encerrada).
      - `start_date` string, date — Data de início da apuração, no formato YYYY-MM-DD.
      - `end_date` string, date, nullable — Data de término da apuração, no formato YYYY-MM-DD. Nulo quando a meta não tem prazo final.
      - `periodicity` integer, nullable — 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.
      - `type` 'manual' | 'projects_created' | 'projects_created_by_user' | 'funnel_steps_links' | 'funnel_steps_links_by_user' | 'composite' — 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).
      - `user_id` string, uuid, nullable — Usuário ao qual a meta está restrita. Preenchido apenas nos tipos projects_created_by_user e funnel_steps_links_by_user.
      - `funnel_step_id` integer, nullable — Etapa de funil apurada pela meta. Preenchido apenas nos tipos funnel_steps_links e funnel_steps_links_by_user.
      - `target` integer, nullable — Valor alvo da meta, na unidade indicada em unit.
      - `unit` 'count' | 'currency' | 'percentage' — Unidade do alvo e do progresso: count (quantidade), currency (valor monetário) ou percentage (porcentagem).
      - `comparison_mode` 'target' | 'limit' — Leitura do alvo: target quando a meta é atingir o valor, limit quando a meta é não ultrapassá-lo.
      - `progress` integer — Progresso apurado no período corrente.
      - `progress_change_percentage` number — Variação percentual do progresso atual em relação ao último resultado apurado. Vale 0 quando não há resultado anterior carregado.
      - `percentage` integer — Percentual do alvo já alcançado, arredondado para baixo.
      - `is_past_calculable` boolean — Indica se a meta consegue recalcular períodos passados. Falso nos tipos manual e composite.
      - `created_at` string, date-time — Momento em que a meta foi criada.
      - `updated_at` string, date-time — Momento da última alteração da meta.
      - `deleted_at` string, date-time, nullable — Momento em que a meta foi removida por soft delete. Nulo enquanto a meta existir.

## Other responses

- `404` — Meta não encontrada

## Changes

- **2026-09-22** `d71b18b1685d` — 6 breaking, 15 warning, 23 info
  - the response property `goal/description` became nullable for the status `200`
  - the response property `goal/end_date` became nullable for the status `200`
  - the response property `goal/periodicity` became nullable for the status `200`
  - the response property `goal/target` became nullable for the status `200`
  - …40 more
- **2026-09-22** `b43a04f35145` — 3 warning
  - removed the optional property `goal/deleted_at` from the response with the `200` status
  - removed the optional property `goal/funnel_step_id` from the response with the `200` status
  - removed the optional property `goal/user_id` from the response with the `200` status
- **2026-09-18** `3202abfa17f9` — 2 info
  - added the media type `application/json` for the response with the status `200`
  - added the non-success response with the status `404`
- **2026-09-18** `0abcbb399fb0` — 1 info
  - added the new optional `query` request parameter `refresh`

[Change history](https://skmtc.dev/olie-ai/apis/olie-api/changes/api/management/goals/:goal/get.md)

---

[API](https://skmtc.dev/olie-ai/apis/olie-api.md) · [All operations](https://skmtc.dev/olie-ai/apis/olie-api/llms.txt) · [OpenAPI document](https://skmtc.dev/olie-ai/apis/olie-api/revisions/d7bda7d32f67?raw)