API atual/Referência completa/Venddor Intelligence: insights e dicas

Gerar, ver e dispensar insights

Dispara a geração de insights na hora e marca um insight como visto ou dispensado.

Três ações de manutenção da caixa de insights. As marcações são idempotentes e informam apenas o novo estado.

Gerar agora

Roda um ciclo completo de geração imediatamente, em vez de esperar a rotina diária. A chamada só volta quando o ciclo termina, e consome recursos de IA: não a use em loop.

POST/api/v1/admin/intelligence/insights/run-nowAdmin

Gerar insights agora

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um administrador (veja Tokens).

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/admin/intelligence/insights/run-now" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Ciclo concluído

json

{ "status": "ok" }

Erros

Status	Quando	Corpo
401	Sem token ou token inválido/expirado.	`{"error":"missing authorization header"}` ou `{"error":"invalid or expired token"}`
403	O administrador não tem nenhum dos privilégios exigidos.	`{"error":"insufficient privileges","privilege_required_any":["intelligence_use_chat","view_reports"]}`
403	Recurso desligado na loja.	`{"error":"intelligence module disabled"}` ou `{"error":"enable_proactive_insights is OFF"}`
500	Falha no ciclo (por exemplo, nenhum provedor de IA).	`{"error":"..."}`

Marcar como visto

Preenche seen_at (na primeira vez). O insight continua na lista.

PATCH/api/v1/admin/intelligence/insights/{id}/seenAdmin

Marcar como visto

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um administrador (veja Tokens).

Parâmetros de caminho

iduuidobrigatório

Id do insight.

Exemplo de requisição

bash

curl -X PATCH "$BASE_URL/api/v1/admin/intelligence/insights/$INSIGHT_ID/seen" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Marcado

json

{ "state": "seen" }

Erros

Status	Quando	Corpo
401	Sem token ou token inválido/expirado.	`{"error":"missing authorization header"}` ou `{"error":"invalid or expired token"}`
403	O administrador não tem nenhum dos privilégios exigidos.	`{"error":"insufficient privileges","privilege_required_any":["intelligence_use_chat","view_reports"]}`
500	`id` com formato inválido.	`{"error":"..."}`

Dispensar

Preenche dismissed_at. O insight sai da lista do administrador (continua no histórico da loja).

PATCH/api/v1/admin/intelligence/insights/{id}/dismissAdmin

Dispensar

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um administrador (veja Tokens).

Parâmetros de caminho

iduuidobrigatório

Id do insight.

Exemplo de requisição

bash

curl -X PATCH "$BASE_URL/api/v1/admin/intelligence/insights/$INSIGHT_ID/dismiss" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Dispensado

json

{ "state": "dismissed" }

Erros

Status	Quando	Corpo
401	Sem token ou token inválido/expirado.	`{"error":"missing authorization header"}` ou `{"error":"invalid or expired token"}`
403	O administrador não tem nenhum dos privilégios exigidos.	`{"error":"insufficient privileges","privilege_required_any":["intelligence_use_chat","view_reports"]}`
500	`id` com formato inválido.	`{"error":"..."}`

Veja também

Insights

API atual/Referência completa/Venddor Intelligence: insights e dicas

Gerar, ver e dispensar insights

Dispara a geração de insights na hora e marca um insight como visto ou dispensado.

Três ações de manutenção da caixa de insights. As marcações são idempotentes e informam apenas o novo estado.

Gerar agora

Roda um ciclo completo de geração imediatamente, em vez de esperar a rotina diária. A chamada só volta quando o ciclo termina, e consome recursos de IA: não a use em loop.

POST/api/v1/admin/intelligence/insights/run-nowAdmin

Gerar insights agora

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um administrador (veja Tokens).

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/admin/intelligence/insights/run-now" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Ciclo concluído

json

{ "status": "ok" }

Erros

Status	Quando	Corpo
401	Sem token ou token inválido/expirado.	`{"error":"missing authorization header"}` ou `{"error":"invalid or expired token"}`
403	O administrador não tem nenhum dos privilégios exigidos.	`{"error":"insufficient privileges","privilege_required_any":["intelligence_use_chat","view_reports"]}`
403	Recurso desligado na loja.	`{"error":"intelligence module disabled"}` ou `{"error":"enable_proactive_insights is OFF"}`
500	Falha no ciclo (por exemplo, nenhum provedor de IA).	`{"error":"..."}`

Marcar como visto

Preenche seen_at (na primeira vez). O insight continua na lista.

PATCH/api/v1/admin/intelligence/insights/{id}/seenAdmin

Marcar como visto

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um administrador (veja Tokens).

Parâmetros de caminho

iduuidobrigatório

Id do insight.

Exemplo de requisição

bash

curl -X PATCH "$BASE_URL/api/v1/admin/intelligence/insights/$INSIGHT_ID/seen" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Marcado

json

{ "state": "seen" }

Erros

Status	Quando	Corpo
401	Sem token ou token inválido/expirado.	`{"error":"missing authorization header"}` ou `{"error":"invalid or expired token"}`
403	O administrador não tem nenhum dos privilégios exigidos.	`{"error":"insufficient privileges","privilege_required_any":["intelligence_use_chat","view_reports"]}`
500	`id` com formato inválido.	`{"error":"..."}`

Dispensar

Preenche dismissed_at. O insight sai da lista do administrador (continua no histórico da loja).

PATCH/api/v1/admin/intelligence/insights/{id}/dismissAdmin

Dispensar

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um administrador (veja Tokens).

Parâmetros de caminho

iduuidobrigatório

Id do insight.

Exemplo de requisição

bash

curl -X PATCH "$BASE_URL/api/v1/admin/intelligence/insights/$INSIGHT_ID/dismiss" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Dispensado

json

{ "state": "dismissed" }

Erros

Status	Quando	Corpo
401	Sem token ou token inválido/expirado.	`{"error":"missing authorization header"}` ou `{"error":"invalid or expired token"}`
403	O administrador não tem nenhum dos privilégios exigidos.	`{"error":"insufficient privileges","privilege_required_any":["intelligence_use_chat","view_reports"]}`
500	`id` com formato inválido.	`{"error":"..."}`

Veja também

Insights