Release Notes

Versão 1.0.5 (28/05/2025)

Novas Funcionalidades

• Adicionado novo endpoint /players/list que fornece uma lista de todos os players pertencentes à empresa do usuário autenticado:

  • Retorna informações básicas do player incluindo ID, nome e data de criação

  • Filtra automaticamente os players com base na empresa do usuário autenticado

  • Suporta formato de resposta JSON

Exemplo de Resposta

[
  {
    "id": "player1",
    "name": "Meu Player",
    "created_at": "2025-05-28T10:00:00Z"
  }
]

---

Versão 1.0.4 (27/05/2025)

Novas Funcionalidades

• Adicionado novo endpoint /events/leaderboard que fornece rankings de players baseados em métricas de engajamento de vídeo:

  • Suporta múltiplos rankings com diferentes limites de players em uma única requisição

  • Permite filtrar por tipos de eventos (started, finished, viewed, clicked, paused)

  • Inclui métricas para total de reproduções, reproduções únicas por sessão e reproduções únicas por dispositivo

  • Suporta filtro por período com data final opcional

Exemplo de Requisição

{
  "company_id": "2b884cba-0b12-42ce-b3a1-7a3182d414df",
  "leaderboards": [
    {
      "leaderboard_limit": 10,
      "start_date": "2023-10-26",
      "end_date": "2023-11-26",
      "event": "finished"
    },
    {
      "leaderboard_limit": 5,
      "start_date": "2023-09-26",
      "event": "started"
    }
  ],
  "timezone": "America/Sao_Paulo"
}

Exemplo de Resposta

[
  {
    "leaderboard_name": "leaderboard_10",
    "event": "finished",
    "leaderboards": [
      {
        "player_id": "player1",
        "total_plays": 100,
        "uniq_plays": 50,
        "uniq_device_plays": 25
      }
    ]
  }
]

---

Version 1.0.3 (2025-05-15)

Melhorias

• Melhorada a performance dos seguintes endopints:

  • /events/total_by_company_day

Detalhamento

Algumas vezes durante a requisição de alguns usuários, os mesmos estavam atingindo o limite de recurso permitido, porém, o request em questão não requisitava muitos dias de dados, isso foi um problema causado devido a maneira com a qual o endpoint agregava dados, todos os requests devem ser normalizados agora utilizando uma quantidade devida de recursos.

---

Versão 1.0.2 (2025-05-15)

Melhorias

• Melhorias para lidar com exceções em requests que utilizam mais recursos do que o permitido considerando o plano da empresa:

  • Adicionado controles específicos para lidar com o erro AUTHENTICATION_FAILED

  • Adicionado controles específicos para lidar com o erro MEMORY_LIMIT_EXCEEDED

Exemplos de respostas de erro 401 - Não autorizado

Quando uma empresa não tem acesso ainda a API:

{
  "error": "This company does not have access to the public analytics API.",
  "code": 516
}

Quando a query ultrapassa o limite de recurso autorizado para o plano da empresa:

{
  "error": "Your api key tier is not enough to perform this query. Please contact support at [e-mail]",
  "code": 241
}

---

Versão 1.0.1 (15/05/2025)

Correções de Bugs

• Corrigido o tratamento de fuso horário no endpoint /sessions/stats_by_field_by_day para garantir relatórios de data consistentes em diferentes fusos horários. Isso afeta como as datas são calculadas nas seguintes métricas:

  • Estatísticas de sessão por dia

  • Taxas de conversão

  • Timestamps de eventos

  • Agregações baseadas em data

Exemplo da Correção

Antes desta correção, ao usar o fuso horário "America/Sao_Paulo" (GMT-3), eventos que ocorreram no mesmo dia poderiam ser divididos em duas datas diferentes devido a problemas de conversão de fuso horário. Por exemplo:

// Antes da correção
{
    "grouped_field": "United States",
    "total_viewed": 100,
    "date_key": "2025-05-13"  // Alguns eventos de 14 de maio foram incorretamente agrupados aqui
},
{
    "grouped_field": "United States",
    "total_viewed": 200,
    "date_key": "2025-05-14"  // Apenas alguns eventos de 14 de maio estavam aqui
}

Agora, todos os eventos do mesmo dia são agrupados corretamente, independentemente do fuso horário especificado na requisição:

// Após a correção
{
  "grouped_field": "United States",
  "total_viewed": 300, // Todos os eventos de 14 de maio agora estão corretamente agrupados
  "date_key": "2025-05-14"
}

---

Nota: Esta versão inclui correções e melhorias na funcionalidade existente sem introduzir novos recursos ou alterações incompatíveis.