Pular para o conteúdo principal

Referência da API

API de análises

API de análises

A API de análises fornece dados de desempenho do cardápio para donos de restaurante e um endpoint de rastreamento para registrar as interações dos clientes.

GET /api/analytics

Recupera os dados de análises do seu restaurante.

Autenticação: obrigatória (Bearer token). Também verifica a propriedade do restaurante.

Resposta (200 OK)

{
  "success": true,
  "data": {
    "totalViews": 1250,
    "uniqueVisitors": 890,
    "averageDuration": 45.2,
    "topItems": [
      {
        "id": "uuid",
        "name": "Margherita Pizza",
        "views": 340
      }
    ],
    "modelCoverage": 0.85
  }
}

Observação: o campo modelCoverage indica a porcentagem de itens do cardápio que têm um modelo 3D com status READY (somente 3D Menu Pro). Ele usa um LEFT JOIN com a tabela three_d_models onde status = 'READY'.

POST /api/analytics/track

Registra uma nova visualização de página. Usado pelo cliente visualizador do cardápio.

Autenticação: pública (nenhum token necessário)

Corpo da requisição

{
  "restaurantId": "uuid",
  "menuItemId": "uuid"
}

Resposta (201 Created)

{
  "success": true,
  "data": {
    "id": "uuid"
  }
}

Importante: a resposta encapsula os dados em data.data — use response.data?.id a partir do JSON analisado, e não response.id.

PATCH /api/analytics/track

Atualiza um registro de visualização existente com dados de duração e interação.

Autenticação: pública (nenhum token necessário)

Corpo da requisição

{
  "viewId": "uuid",
  "duration": 45,
  "interactions": 3
}

Resposta (200 OK)

{
  "success": true,
  "data": {
    "id": "uuid",
    "duration": 45,
    "interactions": 3
  }
}

Observação: sempre use fetch com keepalive: true nas chamadas de rastreamento de análises. Não use navigator.sendBeacon, que só aceita POST com tipo de conteúdo text/plain.