Saltar al contenido principal
POST
Get public metrics for organizations
Este endpoint está obsoleto. Usa en su lugar el nuevo endpoint RESTful GET /organization/metrics. Este endpoint se eliminará en una versión futura.

Inicio rápido

Autenticación

Incluye tu clave de API en el encabezado Authorization:

Solicitud de ejemplo

Control de acceso

La API aplica un control de acceso estricto según el tipo de tu clave de API:
  1. Claves de API de organización:
    • Solo pueden acceder a las métricas de su organización asociada
    • Deben coincidir exactamente con el organizationSlug
    • Ejemplo: una clave de API de “acme-org” solo puede consultar las métricas de “acme-org”
  2. Claves de API de usuario:
    • Pueden acceder a las métricas de cualquier organización de la que el usuario sea miembro
    • Requieren que el usuario sea un miembro activo de la organización consultada
    • Ejemplo: un usuario que es miembro tanto de “acme-org” como de “beta-org” puede consultar las métricas de ambas organizaciones
Si intentas consultar una organización sin los permisos adecuados, recibirás un error 403 Forbidden con el mensaje: “You do not have permission to access metrics for this organization”

Implementación de ejemplo

Detalles de la API

Parámetros de la solicitud

Formato de la respuesta

totalDetections cuenta las amenazas sospechosas: todos los resultados de detección dentro del rango de fechas que no se hayan eliminado, sin importar si después se confirmaron o no. Las amenazas confirmadas se cuentan en threatsBlockedCount.

Manejo de errores

Notas

  • Si no se indica un rango de fechas, se devolverán las métricas de todo el historial
  • La API solo devuelve las métricas de una única organización por solicitud
  • Las claves de API de organización solo pueden acceder a las métricas de su organización asociada
  • Las claves de API de usuario pueden acceder a las métricas de cualquier organización de la que el usuario sea miembro
  • Para consultar varias organizaciones, debes usar una clave de API de usuario y asegurarte de que el usuario sea miembro de todas las organizaciones que quieras consultar

Autorizaciones

X-API-KEY
string
header
requerido

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.

Cuerpo

application/json
organizationSlug
string
requerido
brandSlug
string
startDate
string

Count from this date. A date-only value (YYYY-MM-DD) starts at midnight UTC

endDate
string

Count up to and including this date. A date-only value (YYYY-MM-DD) covers the whole day in UTC; pass a full timestamp for a precise cut-off

Respuesta

Successful response

metrics
object
requerido
blockedByType
object[]
requerido
blockedByDay
object[]
requerido