From d68f977326b67cd0602a76379f4d59bd05000da8 Mon Sep 17 00:00:00 2001 From: Charlie Hopkins-Brinicombe Date: Tue, 28 Jul 2026 11:08:06 +0100 Subject: [PATCH 1/4] Add docs for batch event API --- .../submit-a-batch-of-metric-events.mdx | 10 ++++ docs.json | 4 +- .../submit-a-batch-of-metric-events.mdx | 10 ++++ es/features/events.mdx | 26 +++++----- features/events.mdx | 2 + i18n.lock | 51 +++++++++++-------- scripts/sync-openapi-titles.mjs | 42 ++++++++++++--- 7 files changed, 103 insertions(+), 42 deletions(-) create mode 100644 admin-api/endpoints/metrics/submit-a-batch-of-metric-events.mdx create mode 100644 es/admin-api/endpoints/metrics/submit-a-batch-of-metric-events.mdx diff --git a/admin-api/endpoints/metrics/submit-a-batch-of-metric-events.mdx b/admin-api/endpoints/metrics/submit-a-batch-of-metric-events.mdx new file mode 100644 index 00000000..aee426cd --- /dev/null +++ b/admin-api/endpoints/metrics/submit-a-batch-of-metric-events.mdx @@ -0,0 +1,10 @@ +--- +title: Submit a batch of metric events +openapi: "https://admin.trophy.so/v1/openapi post /metrics/events" +--- + +import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx"; + +**Rate Limits** + + diff --git a/docs.json b/docs.json index 9c3f0ead..d9dd2d21 100644 --- a/docs.json +++ b/docs.json @@ -237,6 +237,7 @@ "admin-api/endpoints/metrics/get-a-metric", "admin-api/endpoints/metrics/update-metrics", "admin-api/endpoints/metrics/create-metrics", + "admin-api/endpoints/metrics/submit-a-batch-of-metric-events", "admin-api/endpoints/metrics/delete-metrics" ] }, @@ -588,6 +589,7 @@ "es/admin-api/endpoints/metrics/get-a-metric", "es/admin-api/endpoints/metrics/update-metrics", "es/admin-api/endpoints/metrics/create-metrics", + "es/admin-api/endpoints/metrics/submit-a-batch-of-metric-events", "es/admin-api/endpoints/metrics/delete-metrics" ] }, @@ -871,4 +873,4 @@ "destination": "/es/platform/experimentation#what-is-engagement" } ] -} +} \ No newline at end of file diff --git a/es/admin-api/endpoints/metrics/submit-a-batch-of-metric-events.mdx b/es/admin-api/endpoints/metrics/submit-a-batch-of-metric-events.mdx new file mode 100644 index 00000000..d88b385d --- /dev/null +++ b/es/admin-api/endpoints/metrics/submit-a-batch-of-metric-events.mdx @@ -0,0 +1,10 @@ +--- +title: Enviar un lote de eventos de métricas +openapi: "https://admin.trophy.so/v1/openapi post /metrics/events" +--- + +import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx"; + +**Límites de velocidad** + + diff --git a/es/features/events.mdx b/es/features/events.mdx index 4c0d8349..fec0fdac 100644 --- a/es/features/events.mdx +++ b/es/features/events.mdx @@ -169,11 +169,13 @@ Cada métrica tiene un `key` único que puedes usar para referenciar y rastrear Para comenzar a rastrear las interacciones de usuarios como eventos en tus Métricas de Trophy, usa la [API de Métricas](/es/api-reference/endpoints/metrics/send-a-metric-change-event) o una de nuestras [Bibliotecas cliente](/es/api-reference/client-libraries) con tipos seguros, compatibles con la mayoría de los principales lenguajes de programación. -Aquí hay un ejemplo donde una plataforma de estudio ficticia utiliza una métrica para rastrear el número de tarjetas de estudio volteadas por cada estudiante. Cada vez que un estudiante interactúa, la plataforma envía un evento a Trophy indicándole cuántas tarjetas de estudio vieron: +Si estás enviando eventos en lote desde tu backend (por ejemplo, vaciados de cola, migraciones o importaciones por lotes), utiliza el endpoint de la Admin API [Enviar un lote de eventos de métrica](/es/admin-api/endpoints/metrics/submit-a-batch-of-metric-events) para enviar hasta 1,000 eventos de métrica en una sola solicitud. + +Aquí hay un ejemplo donde una plataforma de estudio ficticia está usando una métrica para rastrear el número de tarjetas didácticas volteadas por cada estudiante. Cada vez que un estudiante interactúa, la plataforma envía un evento a Trophy indicándole cuántas tarjetas vieron: -Cualquier [Logro](/es/features/achievements), [Racha](/es/features/streaks), [Puntos](/es/features/points) o [Clasificación](/es/features/leaderboards) que se haya configurado para esta métrica se procesará automáticamente, y la respuesta contendrá cualquier actualización del progreso del usuario que sea un resultado directo del evento ocurrido: +Cualquier [Logro](/es/features/achievements), [Racha](/es/features/streaks), [Puntos](/es/features/points) o [Clasificación](/es/features/leaderboards) que se haya configurado para esta métrica se procesará automáticamente, y la respuesta contendrá cualquier actualización del progreso del usuario que sea resultado directo del evento que ocurrió: @@ -182,15 +184,15 @@ En este ejemplo, la respuesta incluye lo siguiente: - Los logros recién desbloqueados del usuario como resultado del evento - La racha más reciente del usuario como resultado del evento - Los puntos más recientes del usuario para cada sistema de puntos que cambió como resultado del evento -- Los datos de clasificación más recientes del usuario para cada clasificación que cambió como resultado del evento +- Los datos más recientes de clasificación del usuario para cada clasificación que cambió como resultado del evento -Con un poco de código personalizado, estos datos de respuesta se pueden utilizar para impulsar cualquier experiencia dentro de la aplicación que desees, incluyendo: +Con un poco de código personalizado, estos datos de respuesta pueden utilizarse para impulsar cualquier experiencia dentro de la aplicación que desees, incluyendo: - Activar notificaciones dentro de la aplicación - Efectos de sonido - Animaciones -Observa cómo Charlie integra el seguimiento de métricas en una aplicación simple de NextJS usando el SDK de Trophy para [Node.js](/es/api-reference/client-libraries): +Observa a Charlie integrar el seguimiento de métricas en una aplicación NextJS simple usando el SDK de [Node.js](/es/api-reference/client-libraries) de Trophy: