Sign in
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

Changes

Changed in 4 of the 79 revisions of this API.1320

  • 4a6533a9991423See the full diff
    • ●

      deleted the query request parameter filter[step_id]

      request-parameter-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ○

      added the new optional query request parameter filter[funnel_step_id]

      new-optional-request-parameter

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

  • 1641fb026e281See the full diff
    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

  • ff81bfa4170f13See the full diff
    • ▲

      the query request parameter filter[status] was restricted to a list of enum values

      request-parameter-became-enum

    • ○

      added the new enum value completed to the query request parameter filter[status]

      request-parameter-enum-value-added

    • ○

      added the new enum value inactive to the query request parameter filter[status]

      request-parameter-enum-value-added

    • ○

      added the new enum value active to the query request parameter filter[status]

      request-parameter-enum-value-added

  • 78982b5a3f6c14See the full diff
    • ○

      added the new optional query request parameter filter[comparison_mode]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter[end_date_lte]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter[periodicity]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter[start_date_gte]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter[status]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter[step_id]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter[title]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter[trashed]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter[type]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter[user_id]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter page

      new-optional-request-parameter

    • ○

      added the new optional query request parameter perPage

      new-optional-request-parameter

    • ○

      added the new optional query request parameter sort

      new-optional-request-parameter

    • ○

      added the media type application/json for the response with the status

      response-media-type-added