API atual/Referência completa/Página do produto: conversão

Personalização

Liga a reordenação por interesse do cliente nas listagens da loja e consulta o relatório de ganho.

A personalização reordena as listagens da vitrine (página inicial, categorias e busca) conforme o interesse de cada cliente, aprendido do que ele já viu e comprou. Quem não tem histórico suficiente continua vendo a ordem normal. O cliente pode, na conta dele, recusar a personalização e apagar o perfil (direitos da LGPD); esses pedidos são tratados nas rotas da vitrine.

Estas rotas ligam e desligam a personalização por superfície e mostram o relatório de ganho. Exigem manage_settings.

Ler a configuração

GET/api/v1/admin/personalization/settingsAdmin

Ler quais superfícies são personalizadas

bash

curl "$BASE_URL/api/v1/admin/personalization/settings" \
  -H "Authorization: Bearer $TOKEN"

200Configuração

json

{ "home_enabled": true, "category_enabled": true, "search_enabled": true, "min_events": 5 }

Campos da resposta

home_enabledboolean

Personaliza a página inicial. Padrão false.

category_enabledboolean

Personaliza as páginas de categoria. Padrão false.

search_enabledboolean

Personaliza os resultados de busca. Padrão false.

min_eventsinteger

Quantos eventos de navegação e compra o cliente precisa ter acumulado antes de ser personalizado. Padrão 5.

Gravar a configuração

PUT/api/v1/admin/personalization/settingsAdmin

Gravar as superfícies personalizadas

Grava o objeto inteiro: o que faltar vira false. min_events menor ou igual a zero (ou ausente) vira 5. A resposta devolve o que foi gravado.

Corpo da requisição

home_enabledboolean

Personaliza a página inicial.

category_enabledboolean

Personaliza as categorias.

search_enabledboolean

Personaliza a busca.

min_eventsintegerpadrão: 5

Interações mínimas antes de personalizar.

bash

curl -X PUT "$BASE_URL/api/v1/admin/personalization/settings" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"home_enabled":true,"category_enabled":true,"search_enabled":false,"min_events":8}'

200Configuração gravada

json

{ "home_enabled": true, "category_enabled": true, "search_enabled": false, "min_events": 8 }

Relatório de ganho

GET/api/v1/admin/personalization/upliftAdmin

Comparar clientes personalizados com o grupo de controle

Destina-se a comparar a taxa de cliques (CTR) e a de adição ao carrinho entre os clientes personalizados e um grupo de controle (que não recebe personalização), numa janela de 30 dias.

bash

curl "$BASE_URL/api/v1/admin/personalization/uplift" \
  -H "Authorization: Bearer $TOKEN"

200Ganho

json

{ "atc_holdout": 0, "atc_personalized": 0, "ctr_holdout": 0, "ctr_personalized": 0, "window_days": 30 }

Campos da resposta

ctr_personalizednumber

Taxa de cliques dos clientes personalizados.

ctr_holdoutnumber

Taxa de cliques do grupo de controle.

atc_personalizednumber

Taxa de adição ao carrinho dos personalizados.

atc_holdoutnumber

Taxa de adição ao carrinho do grupo de controle.

window_daysinteger

Janela do relatório, em dias.

Erros

Status	Quando	Corpo de exemplo
400	`PUT` com corpo que não é JSON.	`{"error":"invalid body","detail":"..."}`
401	Sem token ou token expirado.	`{"error":"invalid or expired token"}`
403	Sem `manage_settings`.	`{"error":"insufficient privileges","privilege_required_any":["manage_settings"]}`

Veja também

API atual/Referência completa/Página do produto: conversão

Personalização

Liga a reordenação por interesse do cliente nas listagens da loja e consulta o relatório de ganho.

Estas rotas ligam e desligam a personalização por superfície e mostram o relatório de ganho. Exigem manage_settings.

Ler a configuração

GET/api/v1/admin/personalization/settingsAdmin

Ler quais superfícies são personalizadas

bash

curl "$BASE_URL/api/v1/admin/personalization/settings" \
  -H "Authorization: Bearer $TOKEN"

200Configuração

json

{ "home_enabled": true, "category_enabled": true, "search_enabled": true, "min_events": 5 }

Campos da resposta

home_enabledboolean

Personaliza a página inicial. Padrão false.

category_enabledboolean

Personaliza as páginas de categoria. Padrão false.

search_enabledboolean

Personaliza os resultados de busca. Padrão false.

min_eventsinteger

Quantos eventos de navegação e compra o cliente precisa ter acumulado antes de ser personalizado. Padrão 5.

Gravar a configuração

PUT/api/v1/admin/personalization/settingsAdmin

Gravar as superfícies personalizadas

Grava o objeto inteiro: o que faltar vira false. min_events menor ou igual a zero (ou ausente) vira 5. A resposta devolve o que foi gravado.

Corpo da requisição

home_enabledboolean

Personaliza a página inicial.

category_enabledboolean

Personaliza as categorias.

search_enabledboolean

Personaliza a busca.

min_eventsintegerpadrão: 5

Interações mínimas antes de personalizar.

bash

curl -X PUT "$BASE_URL/api/v1/admin/personalization/settings" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"home_enabled":true,"category_enabled":true,"search_enabled":false,"min_events":8}'

200Configuração gravada

json

{ "home_enabled": true, "category_enabled": true, "search_enabled": false, "min_events": 8 }

Relatório de ganho

GET/api/v1/admin/personalization/upliftAdmin

Comparar clientes personalizados com o grupo de controle

Destina-se a comparar a taxa de cliques (CTR) e a de adição ao carrinho entre os clientes personalizados e um grupo de controle (que não recebe personalização), numa janela de 30 dias.

bash

curl "$BASE_URL/api/v1/admin/personalization/uplift" \
  -H "Authorization: Bearer $TOKEN"

200Ganho

json

{ "atc_holdout": 0, "atc_personalized": 0, "ctr_holdout": 0, "ctr_personalized": 0, "window_days": 30 }

Campos da resposta

ctr_personalizednumber

Taxa de cliques dos clientes personalizados.

ctr_holdoutnumber

Taxa de cliques do grupo de controle.

atc_personalizednumber

Taxa de adição ao carrinho dos personalizados.

atc_holdoutnumber

Taxa de adição ao carrinho do grupo de controle.

window_daysinteger

Janela do relatório, em dias.

Erros

Status	Quando	Corpo de exemplo
400	`PUT` com corpo que não é JSON.	`{"error":"invalid body","detail":"..."}`
401	Sem token ou token expirado.	`{"error":"invalid or expired token"}`
403	Sem `manage_settings`.	`{"error":"insufficient privileges","privilege_required_any":["manage_settings"]}`