Referência da APIFunil
Dados do funil (contagem + conversas por etapa)
Avalia o funil em tempo de leitura: para cada conversa no escopo, acha a etapa de MAIOR posicao cuja regra ela satisfaz e a coloca ali. Devolve, por etapa, a contagem e ate 50 conversas (as mais recentes), alem de unplaced (conversas que nao casaram com nenhuma etapa) e totalEvaluated. Avaliacao limitada as 5000 conversas mais recentes.
Authorization
bearerAuth AuthorizationBearer <token>
API key enviada como Authorization Bearer pzk_live_... ou pzk_test_...
In: header
Path Parameters
id*string
Identificador do funil.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/funnels/string/data"{
"funnel": {
"id": "string",
"instanceId": "string",
"name": "string"
},
"stages": [
{
"id": "string",
"name": "string",
"color": "gray",
"rule": {
"origin": "any",
"status": "any",
"labelId": "string",
"flowMode": "any",
"flowId": "string",
"nodeId": "string"
},
"posicaoX": 0,
"posicaoY": 0,
"position": 0,
"proximoStageId": "string",
"count": 0,
"conversations": [
{
"id": "string",
"contactName": "string",
"contactPhone": "string",
"status": "string",
"lastMessageAt": "2019-08-24T14:15:22Z"
}
]
}
],
"unplaced": 0,
"totalEvaluated": 0
}{
"error": {
"code": "UNAUTHORIZED",
"message": "API key ausente ou invalida"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Projeto inativo ou sem permissao"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Instancia nao encontrada"
}
}