Métricas
Obtener métricas de la organización
Get metrics for your organization with optional date range and brand filtering. Organization is determined from your API key.
GET
Get organization metrics
Descripción general
Obtén las métricas de seguridad de tu organización, incluidos reportes, amenazas bloqueadas, Takedowns (solicitudes de baja de contenido fraudulento) y más. Este endpoint ofrece analíticas completas sobre la postura de seguridad de tu organización. La organización se infiere automáticamente a partir de tu clave de API.Inicio rápido
Autenticación
Incluye tu clave de API en el encabezadoX-API-KEY:
Solicitud de ejemplo
Parámetros de consulta
Respuesta
Respuesta exitosa
Campos de la respuesta
Tipos de métricas
Métricas a nivel de organización (por defecto)
Cuando no se indicabrandSlug, devuelve las métricas de toda la organización:
- Agrega todas las Proposals (propuestas para bloquear o permitir un asset), los reportes y los takedowns de la organización
- Incluye las amenazas con estado
BLOCKED,APPROVEDyAUTO_APPROVED - El filtro por fecha se aplica a las marcas de tiempo
createdAt - Incluye todas las marcas de la organización
Métricas a nivel de marca (opcional)
Cuando se indicabrandSlug (requiere el feature flag brands-metrics):
- Filtra las métricas a una marca específica mediante el historial de revisión
- Consulta el historial de estados de los assets para encontrar las amenazas bloqueadas específicas de la marca
- Usa la tabla de historial de estados con las revisiones de marca
- El filtro por fecha de los takedowns usa las marcas de tiempo
updatedAt - Nota:
threatsWatchlistedsiempre devuelve 0 en las consultas acotadas a una marca
Casos de uso
Obtener las métricas de todo el historial
Obtén las métricas de todo el historial de tu organización:Obtener las métricas de una marca específica
Obtén las métricas filtradas a una marca específica:Obtener las métricas mensuales
Comparar períodos de tiempo
Analizar la distribución de amenazas
Visualizar las amenazas a lo largo del tiempo
Generar un panel de seguridad
Exportar un informe de métricas
Respuestas de error
401 Unauthorized
Se devuelve cuando la clave de API falta, no es válida o no tiene acceso a la organización:400 Bad Request
Se devuelve cuando los parámetros de consulta no son válidos:404 Not Found
Se devuelve cuando el slug de la marca no se encuentra o no pertenece a tu organización:Buenas prácticas
Rangos de fechas
- Usa siempre el formato ISO 8601 para las fechas:
YYYY-MM-DDTHH:mm:ss.sssZ - Incluye la información de zona horaria (normalmente UTC con el sufijo
Z) - Omite ambas fechas para obtener las métricas de todo el historial
- Usa rangos de fechas coherentes al comparar períodos
Rendimiento
- Guarda en caché los datos de métricas con un TTL adecuado (p. ej., 1 hora para paneles)
- Usa los filtros de fecha para consultar períodos específicos en lugar de filtrar del lado del cliente
- Considera programar instantáneas periódicas de las métricas para llevar un seguimiento histórico
Análisis
- Compara las métricas de distintos períodos para identificar tendencias
- Monitorea la tasa de éxito de los takedowns para evaluar la efectividad de las acciones contra amenazas
- Haz seguimiento de las amenazas por tipo de asset para entender los patrones de ataque
Notas
- La organización se determina automáticamente a partir de tu clave de API
- Todas las marcas de tiempo están en formato ISO 8601 con zona horaria UTC
- Si no se indica un rango de fechas, se devuelven las métricas de todo el historial
- Las métricas se calculan en tiempo real según el rango de fechas indicado
- El array
blockedByTypeincluye todos los tipos de asset que tienen amenazas bloqueadas - El array
blockedByDayofrece datos de serie temporal para visualización - El filtro por marca requiere el feature flag brands-metrics
- Todas las consultas excluyen los registros eliminados de forma lógica (soft delete)
- Los rangos de fechas son inclusivos
- En las consultas filtradas por marca,
threatsWatchlistedsiempre devuelve 0 - El filtro por fecha de los takedowns usa marcas de tiempo distintas en las consultas por marca y en las consultas por organización
Autorizaciones
Your API key. This is required by most endpoints to access our API programatically. Reach out to us at support@chainpatrol.io to get an API key for your use.