Sign in
goals

Listar metas

Retorna a lista paginada de metas, ordenada por status (ativas primeiro) e, dentro de cada status, da mais recente para a mais antiga. Cada meta traz suas metas filhas, a contagem de resultados já apurados e a variação percentual do progresso em relação ao último resultado. Aceita paginação e filtros básicos.

get/api/management/goals

Query parameters

filter[title]string

Filtra pelo título da meta (correspondência parcial, sem diferenciar maiúsculas).

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

Filtra pelo status exato. Valores aceitos: active, inactive, completed.

filter[type]string

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

filter[comparison_mode]string

Filtra pelo modo de comparação exato. Valores aceitos: target (atingir o alvo), limit (não ultrapassar o alvo).

filter[periodicity]string

Filtra pela periodicidade exata, em dias. Use 0 para as metas que apuram o intervalo inteiro de uma vez.

filter[user_id]string

Filtra as metas restritas ao usuário informado (ID UUID). Só retorna metas dos tipos projects_created_by_user e funnel_steps_links_by_user.

filter[funnel_step_id]string

Filtra as metas que apuram a etapa de funil informada (ID numérico). Só retorna metas dos tipos funnel_steps_links e funnel_steps_links_by_user.

filter[start_date_gte]string

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

filter[end_date_lte]string

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

filter[trashed]string

Controla as metas removidas. Valores aceitos: with (inclui as removidas), only (apenas as removidas). Sem o parâmetro, as removidas ficam de fora.

sortstring

Ordenação: nome do campo para crescente ou prefixado com '-' para decrescente; vários campos separados por vírgula. Campos aceitos: 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

Quantidade de metas por página. Padrão 30, máximo 100.

Response

Sucesso

responseboolean

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

Changes

Changed in 6 of the 98 revisions of this API.121943

  • d71b18b1685d111621See the full diff
    • ▲

      the response property // became nullable for the status

      response-property-became-nullable

    • ▲

      the response property // became nullable for the status

      response-property-became-nullable

    • ▲

      the response property // became nullable for the status

      response-property-became-nullable

    • ▲

      the response property // became nullable for the status

      response-property-became-nullable

    • ▲

      the response property // became nullable for the status

      response-property-became-nullable

    • ▲

      the response property // became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the /// response's property type changed from no type to object for status

      response-property-type-changed

    • ▲

      the // response's property type changed from integer to number for status

      response-property-type-changed

    • ●

      added the new active enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new completed enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new composite enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new count enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new currency enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new funnel_steps_links enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new funnel_steps_links_by_user enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new inactive enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_filter_query enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new limit enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new manual enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new percentage enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new permission_required enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new projects_created enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new projects_created_by_user enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new target enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      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

    • ○

      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

    • ○

      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

    • ○

      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

    • ○

      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

    • ○

      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

    • ○

      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

    • ○

      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

    • ○

      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

    • ○

      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

    • ○

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

      response-optional-property-added

  • 3202abfa17f92See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

  • 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