MetricsController extends Controller
Table of Contents
Properties
- $enableCsrfValidation : mixed
- $ms : MetricService
Methods
- __construct() : mixed
- actionConfiguratorInteractions() : array{credits_used: array, interactions: array}
- Desc: Retorna información sobre las interacciones del configurador, con posibilidad de filtrar por rango de fechas.
- actionCreate() : MetricEvents}
- Desc: Crea un nuevo evento de métrica.
- actionGeneralSummary() : array{period: array, ratio_used_not_used: array, event_types: array, metric_data: array|bool}
- Desc: Retorna un resumen general del consumo de créditos, con posibilidad de filtrar por periodo, rango de fechas y cliente específico.
- actionIndex() : array<string|int, mixed>
- Desc: Retorna una lista de los eventos de métricas.
- actionOptions() : void
- Desc: Método para brindar información al fronend sobre opciones de comunicación. Funciona con método OPTIONS.
- actionSummary() : array{period: array, ratio_used_not_used: array, event_types: array}
- Desc: Retorna un resumen del consumo de créditos de un cliente específico, con posibilidad de filtrar por periodo y rango de fechas.
- actionView() : MetricEvents
- Desc: Retorna los eventos de métricas específicos por su ID.
- behaviors() : array<string|int, mixed>
- Desc: Retorna lista de comportamientos que el controlador debe de seguir.
- init() : void
- Desc: Inicializa configuraciones para el controlador.
Properties
$enableCsrfValidation
public
mixed
$enableCsrfValidation
= false
$ms
private
MetricService
$ms
Methods
__construct()
public
__construct(mixed $id, mixed $module, MetricService $ms[, mixed $config = [] ]) : mixed
Parameters
- $id : mixed
- $module : mixed
- $ms : MetricService
- $config : mixed = []
actionConfiguratorInteractions()
Desc: Retorna información sobre las interacciones del configurador, con posibilidad de filtrar por rango de fechas.
public
actionConfiguratorInteractions() : array{credits_used: array, interactions: array}
Notes: Este método se creó para brindar información al frontend sobre las opciones de comunicación, aunque también puede ser útil para el análisis del uso del configurador.
Ref: n/a,
Date: 2026-03-18, Version: v0.2603.21,
Example: GET /api/v1/metrics/configurator-interactions?range=this_month, GET /api/v1/metrics/configurator-interactions?range=last_month
Return values
array{credits_used: array, interactions: array}actionCreate()
Desc: Crea un nuevo evento de métrica.
public
actionCreate() : MetricEvents}
Notes: n/a, Ref: n/a,
Date: 2026-03-18, Version: v0.2603.21,
Tags
Return values
MetricEvents}actionGeneralSummary()
Desc: Retorna un resumen general del consumo de créditos, con posibilidad de filtrar por periodo, rango de fechas y cliente específico.
public
actionGeneralSummary() : array{period: array, ratio_used_not_used: array, event_types: array, metric_data: array|bool}
Notes: El parámetro de servicio se agregó para permitir la extensión a otros servicios en el futuro, aunque actualmente solo se tiene SD_CREDITS.
Ref: n/a,
Date: 2026-03-18, Version: v0.2603.21,
Example: GET /api/v1/metrics/general-summary?period=day&range=this_month&service=sd_credits, GET /api/v1/metrics/general-summary?period=day&range=this_month&service=sd_credits&api_client_id=1
Tags
Return values
array{period: array, ratio_used_not_used: array, event_types: array, metric_data: array|bool}actionIndex()
Desc: Retorna una lista de los eventos de métricas.
public
actionIndex() : array<string|int, mixed>
Notes: Se pueden filtrar por api_client_id, user_id y service_name. La respuesta incluye paginación.
Date: 2026-03-18, Version: v0.2603.21,
Example: GET /api/v1/metrics, GET /api/v1/metrics?page=2
Return values
array<string|int, mixed>actionOptions()
Desc: Método para brindar información al fronend sobre opciones de comunicación. Funciona con método OPTIONS.
public
actionOptions([mixed $id = null ]) : void
Notes: n/a,
Ref: https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Methods/OPTIONS
Date: 2025-08-07, Version: v0.2507.01
Example: n/a
Parameters
- $id : mixed = null
actionSummary()
Desc: Retorna un resumen del consumo de créditos de un cliente específico, con posibilidad de filtrar por periodo y rango de fechas.
public
actionSummary(int $api_client_id, int $user_id) : array{period: array, ratio_used_not_used: array, event_types: array}
Notes: El parámetro de servicio se agregó para permitir la extensión a otros servicios en el futuro, aunque actualmente solo se tiene SD_CREDITS.
Ref: n/a
Date: 2026-03-18, Version: v0.2603.21,
Example: GET /api/v1/metrics/summary?api_client_id=1&user_id=123&period=day&range=this_month&service=sd_credits
Parameters
- $api_client_id : int
- $user_id : int
Tags
Return values
array{period: array, ratio_used_not_used: array, event_types: array}actionView()
Desc: Retorna los eventos de métricas específicos por su ID.
public
actionView(int $id) : MetricEvents
Notes: n/a, Ref: n/a,
Date: 2026-03-18, Version: v0.2603.21,
Parameters
- $id : int
Return values
MetricEventsbehaviors()
Desc: Retorna lista de comportamientos que el controlador debe de seguir.
public
behaviors() : array<string|int, mixed>
Notes: Contiene excepciones de auht, auhtenticator, filtros de cors, métodos HTTP permitidos.
Ref: https://www.yiiframework.com/doc/api/2.0/yii-rest-controller#behaviors()-detail
Date: 2025-08-07, Version: v0.2507.01
Example: n/a
Return values
array<string|int, mixed> —Configuraciones del comportamiento
init()
Desc: Inicializa configuraciones para el controlador.
public
init() : void
Notes: Se deshabilita la sesión (porque se comporta como un API rest).
Ref: https://www.yiiframework.com/doc/api/2.0/yii-rest-controller#init()-detail
Date: 2025-08-07, Version: v0.2507.01
Example: n/a