# Enumere las métricas de empleo.

## ▶️ Uso

Con el método List Employment Metrics, puedes:

1. Listar métricas de empleo relacionadas con un link.id específico (usando el parámetro de consulta link).
2. Obtener los detalles de un employment-metric.id específico (usando el parámetro de consulta id).
3. [No Recomendado] Listar todas las métricas de empleo relacionadas con tu cuenta de Belvo (sin usar ningún parámetro de consulta).

## 📖 Paginación

Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta page_size para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta page para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación.

## 🔦 Filtrado de Respuestas

Consulta la lista de campos a continuación para ver los campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas.

Endpoint: GET /api/employment-metrics/
Version: 1.223.0
Security: basicAuth

## Query parameters:

  - `link` (string)
    El link.id por el que deseas filtrar.

ℹ️ Recomendamos encarecidamente añadir el filtro link.id para mejorar tu rendimiento.
    Example: "8848bd0c-9c7e-4f53-a732-ec896b11d4c4"

  - `page_size` (integer)
    Indica cuántos resultados devolver por página. Por defecto, devolvemos 100 resultados por página.

ℹ️ El número mínimo de resultados devueltos por página es 1 y el máximo es 1000. Si introduces un valor mayor que 1000, nuestra API usará por defecto el valor máximo (1000).
    Example: 100

  - `page` (integer)
    Un número de página dentro del conjunto de resultados paginados.
    Example: 1

  - `link__in` (array)
    Devuelve resultados solo para estos link.ids.
    Example: ["5722d0ba-69d7-42dc-8ff5-33767b83c5d6"]

  - `omit` (string)
    Omite ciertos campos para que no se devuelvan en la respuesta. Para más información, consulta nuestro artículo del DevPortal Filtrando respuestas.

  - `fields` (string)
    Devuelve solo los campos especificados en la respuesta. Para obtener más información, consulta nuestro artículo del DevPortal Filtrando respuestas.

## Response 200 fields (application/json):

  - `count` (integer)
    El número total de resultados en tu cuenta de Belvo.
    Example: 130

  - `next` (string,null)
    La URL a la siguiente página de resultados. Cada página consta de hasta 100 elementos. Si no hay suficientes resultados para una página adicional, el valor es null.

En nuestro ejemplo de documentación, usamos {endpoint} como un valor de marcador de posición. En producción, este valor será reemplazado por el endpoint real que estás utilizando actualmente (por ejemplo, accounts o owners).
    Example: "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2"

  - `previous` (string,null)
    La URL a la página anterior de resultados. Si no hay una página anterior, el valor es null.

  - `results` (array)
    Matriz de objetos de métricas de empleo.

  - `results.id` (string, required)
    Identificador único de Belvo para el elemento actual.
    Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"

  - `results.link` (string,null, required)
    El link.id al que pertenecen los datos.
    Example: "30cb4806-6e00-48a4-91c9-ca55968576c8"

  - `results.collected_at` (string, required)
    La marca de tiempo ISO-8601 cuando se recopiló el punto de datos.
    Example: "2022-02-09T08:45:50.406032Z"

  - `results.created_at` (string, required)
    La marca de tiempo ISO-8601 de cuando se creó el punto de datos en la base de datos de Belvo.
    Example: "2022-02-09T08:45:50.406032Z"

  - `results.updated_at` (string,null, required)
    La marca de tiempo ISO-8601 de cuándo se actualizó por última vez el cálculo de las métricas de empleo.
    Example: "2023-08-30T15:31:35.728607Z"

  - `results.reference_date` (string,null, required)
    La reference_date que proporcionaste en tu solicitud. Si no proporcionaste una, este campo devolverá null, lo que indica que los cálculos se realizan hasta la fecha de la solicitud.

Nota: Todos los cálculos son relativos a esta fecha.
    Example: "2023-06-01"

  - `results.age` (integer, required)
    La edad del individuo.
    Example: 32

  - `results.current_status` (string, required)
    Indica el estado laboral del individuo. Devolvemos una de las siguientes respuestas:

  - EMPLOYED
  - RETIRED
  - UNEMPLOYED
  - null
    Enum: "EMPLOYED", "RETIRED", "UNEMPLOYED", "null"

  - `results.current_employer_count` (integer,null, required)
    El número de empleadores que tiene actualmente el individuo.
    Example: 1

  - `results.base_salary_last` (number,null, required)
    El último salario base del usuario. Si current_status es EMPLOYED, este es el salario base actual del usuario.
    Example: 42.17

  - `results.weeks_employed_last_job` (number,null, required)
    El número de semanas que el usuario estuvo empleado en su último trabajo. Si current_status es EMPLOYED, entonces este campo indica el número de semanas que el usuario ha estado empleado en su trabajo actual.
    Example: 327.1429

  - `results.weeks_since_last_job` (number,null, required)
    El número de semanas desde su último trabajo. Si el valor de este campo es 0, esto indica que el usuario está actualmente empleado.

  - `results.weeks_employed_total` (number,null, required)
    El número total de semanas que el usuario ha estado empleado, según la institución.

> Nota:
>
> En el caso de que el usuario esté empleado en dos o más lugares al mismo tiempo, seguimos calculando esas semanas como una semana. Por ejemplo, si un usuario tiene tres trabajos simultáneos durante un mes, esto se calcula como 4 semanas.
    Example: 148.2

  - `results.weeks_with_multiple_employers` (number,null, required)
    El número de semanas que el individuo ha tenido más de un empleador al mismo tiempo.

  - `results.employer_count` (integer,null, required)
    El número total de empleadores que el usuario ha tenido. Útil para indicar la estabilidad laboral a lo largo de su vida.
    Example: 14

  - `results.unique_employer_count` (integer,null, required)
    El número de empleadores únicos que ha tenido la persona.

> Nota:
>
> Si el usuario dejó una empresa y regresó, por ejemplo, seis meses después a la misma empresa, esto se cuenta como un solo empleador.
    Example: 3

  - `results.employers_per_year` (number,null, required)
    Número de empleadores por año. Útil para indicar la estabilidad laboral a lo largo de un año.

> Nota:
>
> Si el usuario dejó una empresa y regresó, por ejemplo, seis meses después a la misma empresa, esto se cuenta como un solo empleador.
    Example: 0.6326

  - `results.weeks_between_jobs` (number,null, required)
    El número total de semanas que el individuo estuvo desempleado.
    Example: 687.2865

  - `results.max_weeks_between_jobs` (number,null, required)
    El número máximo de semanas que el individuo estuvo desempleado.
    Example: 249.8571

  - `results.increases_last_job` (integer,null, required)
    El número total de aumentos salariales que el usuario tuvo en su último trabajo. Si current_status es EMPLOYED, esto se refiere al trabajo actual del usuario.

> Nota:
>
> Para todos los aumentos o disminuciones salariales, solo tomamos en cuenta aquellos donde el cambio en el salario es superior al 2%.

  - `results.decreases_last_job` (integer,null, required)
    El número total de aumentos salariales que el usuario tuvo en su último trabajo. Si current_status es EMPLOYED, esto se refiere al trabajo actual del usuario.

  - `results.increases_after_change` (integer,null, required)
    El número total de aumentos salariales entre el penúltimo trabajo del individuo y el último (o actual) trabajo.

  - `results.decreases_after_change` (integer,null, required)
    El número total de disminuciones salariales entre el penúltimo trabajo del individuo y el último (o actual) trabajo.

  - `results.increases_overall` (integer,null, required)
    El número total de aumentos salariales a lo largo de la carrera laboral del individuo.

  - `results.decreases_overall` (integer,null, required)
    El número total de disminuciones salariales a lo largo de la carrera laboral del individuo.

  - `results.increases_1y` (integer,null, required)
    El número total de aumentos salariales a lo largo del último año del individuo (YTD).

  - `results.decreases_1y` (integer,null, required)
    El número total de disminuciones salariales a lo largo del último año del individuo (YTD).

  - `results.increases_3y` (integer,null, required)
    El número total de aumentos salariales durante los últimos tres años del individuo.

> Nota:
>
> Si la carrera laboral del individuo es de menos de tres años, devolvemos null.

  - `results.decreases_3y` (integer,null, required)
    El número total de disminuciones salariales a lo largo de los últimos tres años del individuo.

> Nota:
>
> Si la carrera laboral del individuo es de menos de tres años, devolvemos null.

  - `results.increases_5y` (integer,null, required)
    El número total de aumentos salariales durante los últimos cinco años del individuo.

> Nota:
>
> Si la carrera laboral del individuo es de menos de cinco años, devolvemos null.

  - `results.decreases_5y` (integer,null, required)
    El número total de disminuciones salariales a lo largo de los últimos cinco años del individuo.

> Nota:
>
> Si la carrera laboral del individuo es de menos de cinco años, devolvemos null.

  - `results.yearly_change_1y` (number,null, required)
    El cambio porcentual del salario del individuo para el último año (YTD).

  - `results.yearly_change_3y` (number,null, required)
    El cambio porcentual del salario del individuo durante los últimos tres años.

> Nota:
>
> Si la carrera laboral del individuo es inferior a tres años, devolvemos null.

  - `results.yearly_change_5y` (number,null, required)
    El cambio porcentual del salario del individuo durante los últimos cinco años.

> Nota:
>
> Si la carrera laboral del individuo es inferior a cinco años, devolvemos null.

  - `results.min_monthly_salary_1y` (number,null, required)
    El salario mensual mínimo del individuo durante el último año.
    Example: 3402.88

  - `results.min_monthly_salary_3y` (number,null, required)
    El salario mensual mínimo del individuo durante los últimos tres años.
    Example: 3402.88

  - `results.min_monthly_salary_5y` (number,null, required)
    El salario mensual mínimo del individuo durante los últimos cinco años.
    Example: 3402.88

  - `results.average_monthly_salary_1y` (number,null, required)
    El salario mensual promedio del individuo durante el último año.
    Example: 3402.88

  - `results.average_monthly_salary_3y` (number,null, required)
    El salario mensual promedio del individuo durante los últimos tres años.
    Example: 3402.88

  - `results.average_monthly_salary_5y` (number,null, required)
    El salario mensual promedio del individuo durante los últimos cinco años.
    Example: 3402.88

  - `results.max_monthly_salary_1y` (number,null, required)
    El salario mensual máximo del individuo para el último año.
    Example: 3402.88

  - `results.max_monthly_salary_3y` (number,null, required)
    El salario mensual máximo del individuo durante los últimos tres años.
    Example: 3402.88

  - `results.max_monthly_salary_5y` (number,null, required)
    El salario mensual máximo del individuo durante los últimos cinco años.
    Example: 3402.88

## Response 403 fields (application/json):

  - `code` (string)
    Un código de error único (access_to_resource_denied) que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar 403 access_to_resource_denied.
    Example: "access_to_resource_denied"

  - `message` (string)
    Una breve descripción del error.

Para los errores access_to_resource_denied, la descripción es:

  - You don't have access to this resource..
    Example: "You don't have access to this resource."

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 404 fields (application/json):

  - `code` (string)
    Un código de error único (not_found) que te permite clasificar y manejar el error de manera programática.
    Example: "not_found"

  - `message` (string)
    Una breve descripción del error.

Para errores not_found, la descripción es:

  - Not found
    Example: "Not found"

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 408 fields (application/json):

  - `code` (string)
    Un código de error único (request_timeout) que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 408 request_timeout.
    Example: "request_timeout"

  - `message` (string)
    Una breve descripción del error.

Para los errores de request_timeout, la descripción es:

  - The request timed out, you can retry asking for less data by changing your query parameters.
    Example: "The request timed out, you can retry asking for less data by changing your query parameters"

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 500 fields (application/json):

  - `code` (string)
    Un código de error único (unexpected_error) que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 500 unexpected_error.
    Example: "unexpected_error"

  - `message` (string)
    Una breve descripción del error.

Para los errores unexpected_error, la descripción es:

- Belvo no puede procesar la solicitud debido a un problema interno del sistema o a una respuesta no soportada de una institución.
    Example: "Belvo is unable to process the request due to an internal system issue or to an unsupported response from an institution"

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"