Membros logados que pararam numa etapa do funil

GET/api/analytics/funnel/members

Auth: Jeton requis
Clé d’API:: reports:read
X-CommunityId: X-CommunityId Envoyez le X-CommunityId de la communauté où l’opération a lieu.

Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.

Owner, admin e financeiro. Membros cuja etapa mais avançada no período foi `step`, na mesma população de `GET /api/analytics/funnel` (sessões rastreadas desde `collectionStartedAt` e os pedidos ligados a elas; anônimos e pedidos sem visita rastreada não entram). `visit` é quem visitou a comunidade sem abrir a vitrine nem chegar a um produto selecionado; `catalog` é quem abriu a vitrine e não chegou a nenhum produto selecionado. `total` é quantos pararam ali; `members` traz uma página de perfis, do mais recente ao mais antigo pela última atividade na comunidade (`lastSeenAt`; quem nunca foi visto fica no fim), e `pagination` diz a página (`pagination.total` conta só quem casa com `search`). Sem `page`, vem a primeira página. `limit` acima de 100 é tratado como 100.

Cada membro traz `products`: os produtos (dentro de `productIds`, quando informado) em que parou nessa etapa, do mais recente ao mais antigo, no máximo 3, com `at` (último contato com o produto na etapa: a visita rastreada ou o pedido); `productsTotal` diz quantos são ao todo. `planId` vem sempre `null` (o funil é por produto). Em `step=visit` e `step=catalog`, `products` vem vazio.

Paramètres

Nom	Emplacement	Type	Description
`step`obligatoire	query	`visit \| catalog \| product \| checkout_identify \| checkout_payment \| checkout_submitted \| checkout_success`
`productId`facultatif	query	`string (uuid)`	Um produto (mantido por compatibilidade; soma-se a `productIds`).
`productIds`facultatif	query	`string (uuid)[]`	Vários produtos, separados por vírgula (`productIds=a,b`) ou repetidos (`productIds=a&productIds=b`), até 100. Sem `productId` nem `productIds`, todos os produtos. Os pedidos (etapas e `untrackedOrders`) filtram igual.
`from`facultatif	query	`string (date)`
`to`facultatif	query	`string (date)`
`page`facultatif	query	`integer`
`limit`facultatif	query	`integer`	Perfis por página, até 100 (valores até 500 são aceitos e tratados como 100).
`search`facultatif	query	`string`	Parte do nome ou do e-mail do membro.

En-têtes

Nom	Type	Description
`X-CommunityId`facultatif	`string (uuid)`	ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Réponses

Statut	Description
`200`	Membros.
`400`	Requisição inválida — falha de validação.
`401`	Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`).
`403`	Autenticado, mas sem permissão para esta operação.
`500`	Erro interno do servidor.

Exemple curl

curl -X GET "https://api.memberfy.net/api/analytics/funnel/members" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"