Lê o resumo comportamental + o diagnóstico de intenção/abandono de uma sessão
/v1/checkouts/sessions/{sessionId}/behaviorAutentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.
Parâmetros do caminho
sessionIdstringobrigatórioIdentificador público (sess_/ckts_/ses_…)
Respostas
200Sucesso
idstringobrigatórioIdentificador público (sess_/ckts_/ses_…)
objectstringobrigatórioSempre
checkout.session.behavior.Valores:checkout.session.behaviorstatusstringobrigatórioStatus da sessão.
behaviorobjectobrigatóriopode ser nuloO consolidado bruto: contadores, edições por campo, tempo por passo, tentativas de pagamento…;
nullsem sinais.insightsobjectobrigatóriopode ser nuloO diagnóstico da sessão;
nullsem sinais.+10 campos de
insightsstagestringobrigatórioOnde o comprador está:
browsing,filling,paying,stuck,leavingouconverted.Valores:browsingfillingpayingstuckleavingconvertedreasonsstring[]obrigatórioPor quê, em linguagem simples — a narrativa que um operador lê.
summarystringobrigatórioLeitura da sessão em um parágrafo.
computedAtstringobrigatórioQuando foi calculado (ISO 8601); recalculado a cada sinal.
confidenceintegerobrigatórioQuanta evidência sustenta as notas (0–100): uma sessão de poucos segundos é um palpite, não um diagnóstico.
intentScoreintegerobrigatórioQuão perto este comprador está de pagar (0–100).
frictionPointsobject[]obrigatórioOnde dói, do pior para o menor.
+3 campos de
frictionPointsareastringobrigatórioOnde (um campo, um passo, o pagamento).
evidencestringobrigatórioO que foi observado.
severitystringobrigatóriolow,mediumouhigh.Valores:lowmediumhigh
abandonmentRiskintegerobrigatórioQuão provável é perder esta sessão (0–100) — a chave de ordenação da fila de recuperação.
automationScoreintegerobrigatórioIndício de automação/robô (0–100). Consultivo: nunca recusa uma cobrança sozinho.
recommendedActionstringobrigatórioO que fazer a respeito:
none,wait,offerHelp,offerDiscount,recoverByEmail,recoverByWhatsappoumanualReview.Valores:nonewaitofferHelpofferDiscountrecoverByEmailrecoverByWhatsappmanualReview
engagementobjectobrigatórioEngajamento acumulado da sessão.
+6 campos de
engagementeventCountintegerobrigatórioQuantos eventos de interação foram registrados.
visitCountintegerobrigatórioQuantas vezes o checkout foi aberto.
activeTimeMsintegerobrigatórioTempo com a aba ativa, em milissegundos.
maxStepReachedintegerobrigatórioO passo mais avançado do funil alcançado.
lastTelemetryAtstringobrigatóriopode ser nuloQuando o último sinal chegou;
nullquando não houve.totalTimeSpentMsintegerobrigatórioTempo total no checkout, em milissegundos.
401Não autenticado (credencial ausente ou inválida)
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
403Sem permissão
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
404Não encontrado
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
500Erro interno do servidor
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório