MetricDataController extends Controller
Table of Contents
Methods
- actionConfiguratorInteractions() : mixed
- Desc: Retorna un resumen de interacciones con el configurador. Funciona con método GET.
- actionGeneralSummary() : mixed
- Desc: Retorna un resumen general de métricas. Funciona con método GET.
- actionOptions() : void
- Desc: Método para brindar información al fronend sobre opciones de comunicación. Funciona con método OPTIONS.
- actionSummary() : mixed
- Desc: Retorna un resumen de métricas para un cliente y usuario específico. Funciona con método GET.
- actionView() : mixed
- Desc: Item de MetricData. Funciona con método GET.
- behaviors() : array<string|int, mixed>
- Desc: Retorna lista de comportamientos que el controlador debe de seguir.
- init() : void
- Desc: Inicializa configuraciones para el controlador.
Methods
actionConfiguratorInteractions()
Desc: Retorna un resumen de interacciones con el configurador. Funciona con método GET.
public
actionConfiguratorInteractions() : mixed
Notes: Obtiene un resumen de interacciones con el configurador para todas las regiones. Se realiza la consulta a la Api-metrics (v1/metrics/configurator-interactions). Se puede incluir el parámetro "range" (this_month, last_month, this_year, last_year) para especificar el período de tiempo del resumen.
Date: 2026-03-18, Version: v0.2603.21,
Example: n/a
Tags
actionGeneralSummary()
Desc: Retorna un resumen general de métricas. Funciona con método GET.
public
actionGeneralSummary() : mixed
Notes: Obtiene un resumen general de métricas para todas las regiones. Se realiza la consulta a la Api-metrics (v1/metrics/general-summary). Se pueden incluir los parámetros "period" (minute, hour, day) y "range" (this_month, last_month, this_year, last_year) para especificar el período de tiempo del resumen. También se puede incluir el parámetro "service" para especificar el servicio del que se desea obtener el resumen (ejemplo: ?service=sd_credits).
Date: 2026-03-18, Version: v0.2603.21,
Example: n/a
Tags
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 de métricas para un cliente y usuario específico. Funciona con método GET.
public
actionSummary(int $api_client_id, int $user_id) : mixed
Notes: Obtiene un resumen de métricas para un cliente y usuario específico. Se realiza la consulta a la Api-metrics (v1/metrics/summary/api_client/{api_client_id}/user/{user_id}). Se pueden incluir los parámetros "period" (minute, hour, day) y "range" (this_month, last_month, this_year, last_year) para especificar el período de tiempo del resumen.
Date: 2026-03-18, Version: v0.2603.21,
Example: n/a
Parameters
- $api_client_id : int
- $user_id : int
Tags
actionView()
Desc: Item de MetricData. Funciona con método GET.
public
actionView(int $id) : mixed
Notes: Obtiene los detalles de MetricData, con información global de todas las regiones, por ejemplo los créditos totales. Se realiza la consulta a la Api-metrics (v1/metric-data/{id}).
Date: Date: 2026-03-18, Version: v0.2603.21,
Example: n/a
Parameters
- $id : int
-
ID del recurso
behaviors()
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-11, 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-11, Version: v0.2507.01
Example: n/a