# Listar métricas de emprego

## ▶️ Uso

Com o método Listar Métricas de Emprego, você pode:

1. Listar métricas de emprego relacionadas a um  específico (usando o parâmetro de consulta ).
2. Obter os detalhes de um  específico (usando o parâmetro de consulta ).
3.  Listar todas as métricas de emprego relacionadas à sua conta Belvo (sem usar nenhum parâmetro de consulta).

## 📖 Paginação

Este método retorna uma resposta paginada (padrão: 100 itens por página). Você pode usar o parâmetro de consulta  para aumentar o número de itens retornados até um máximo de 1000 itens. Você pode usar o parâmetro de consulta  para navegar pelos resultados. Para mais detalhes sobre como navegar pelas respostas paginadas da Belvo, consulte nosso artigo Dicas de Paginação.

## 🔦 Filtrando Respostas

Consulte a lista de consultas abaixo para ver uma lista de campos pelos quais você pode filtrar suas respostas. Para mais informações sobre como usar filtros, consulte nosso artigo Filtrando respostas.

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

## Query parameters:

  - `link` (string)
    O  pelo qual você deseja filtrar.

ℹ️ Recomendamos fortemente adicionar o filtro  para melhorar seu desempenho.
    Example: "8848bd0c-9c7e-4f53-a732-ec896b11d4c4"

  - `page_size` (integer)
    Indica quantos resultados retornar por página. Por padrão, retornamos 100 resultados por página.

ℹ️ O número mínimo de resultados retornados por página é 1 e o máximo é 1000. Se você inserir um valor maior que 1000, nossa API usará o valor máximo por padrão (1000).
    Example: 100

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

  - `link__in` (array)
    Retorne resultados apenas para esses s.
    Example: ["5722d0ba-69d7-42dc-8ff5-33767b83c5d6"]

  - `omit` (string)
    Omitir certos campos de serem retornados na resposta. Para mais informações, consulte nosso artigo Filtrando respostas no DevPortal.

  - `fields` (string)
    Retorne apenas os campos especificados na resposta. Para mais informações, consulte nosso artigo no DevPortal Filtrando respostas.

## Response 200 fields (application/json):

  - `count` (integer)
    O número total de resultados na sua conta Belvo.
    Example: 130

  - `next` (string,null)
    A URL para a próxima página de resultados. Cada página consiste em até 100 itens. Se não houver resultados suficientes para uma página adicional, o valor será .

Em nosso exemplo de documentação, usamos  como um valor de espaço reservado. Em produção, esse valor será substituído pelo endpoint real que você está usando atualmente (por exemplo,  ou ).
    Example: "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2"

  - `previous` (string,null)
    A URL para a página anterior de resultados. Se não houver uma página anterior, o valor será .

  - `results` (array)
    Array de objetos de métricas de emprego.

  - `results.id` (string, required)
    Identificador único da Belvo para o item atual.
    Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"

  - `results.link` (string,null, required)
    O  ao qual os dados pertencem.
    Example: "30cb4806-6e00-48a4-91c9-ca55968576c8"

  - `results.collected_at` (string, required)
    O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
    Example: "2022-02-09T08:45:50.406032Z"

  - `results.created_at` (string, required)
    O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo.
    Example: "2022-02-09T08:45:50.406032Z"

  - `results.updated_at` (string,null, required)
    O carimbo de data/hora ISO-8601 de quando o cálculo das métricas de emprego foi atualizado pela última vez.
    Example: "2023-08-30T15:31:35.728607Z"

  - `results.reference_date` (string,null, required)
    A reference_date que você forneceu em sua solicitação. Se você não forneceu uma, este campo retornará , indicando que os cálculos são realizados até a data da solicitação.

 Todos os cálculos são relativos a esta data.
    Example: "2023-06-01"

  - `results.age` (integer, required)
    A idade do indivíduo.
    Example: 32

  - `results.current_status` (string, required)
    Indica o status de emprego do indivíduo. Retornamos uma das seguintes respostas:

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

  - `results.current_employer_count` (integer,null, required)
    O número de empregadores que o indivíduo tem no momento.
    Example: 1

  - `results.base_salary_last` (number,null, required)
    O salário base mais recente do usuário. Se  for , este é o salário base atual do usuário.
    Example: 42.17

  - `results.weeks_employed_last_job` (number,null, required)
    O número de semanas em que o usuário esteve empregado em seu último emprego. Se  for , então este campo indica o número de semanas em que o usuário está empregado em seu emprego atual.
    Example: 327.1429

  - `results.weeks_since_last_job` (number,null, required)
    O número de semanas desde o último emprego. Se o valor deste campo for , isso indica que o usuário está atualmente empregado.

  - `results.weeks_employed_total` (number,null, required)
    O número total de semanas em que o usuário esteve empregado, de acordo com a instituição.

> 
>
> No caso de o usuário estar empregado em dois ou mais lugares ao mesmo tempo, ainda calculamos essas semanas como uma semana. Por exemplo, se um usuário tem três empregos simultâneos por um mês, isso é calculado como 4 semanas.
    Example: 148.2

  - `results.weeks_with_multiple_employers` (number,null, required)
    O número de semanas em que o indivíduo teve mais de um empregador ao mesmo tempo.

  - `results.employer_count` (integer,null, required)
    O número total de empregadores que o usuário teve. Útil para indicar a estabilidade de emprego ao longo de sua vida.
    Example: 14

  - `results.unique_employer_count` (integer,null, required)
    O número de empregadores únicos que o indivíduo teve.

> 
>
> Se o usuário saiu de uma empresa e retornou, por exemplo, seis meses depois para a mesma empresa, isso é contado como um empregador.
    Example: 3

  - `results.employers_per_year` (number,null, required)
    Número de empregadores por ano. Útil para indicar a estabilidade no emprego ao longo de um ano.

> 
>
> Se o usuário saiu de uma empresa e retornou, por exemplo, seis meses depois para a mesma empresa, isso é contado como um empregador.
    Example: 0.6326

  - `results.weeks_between_jobs` (number,null, required)
    O número total de semanas em que o indivíduo esteve desempregado.
    Example: 687.2865

  - `results.max_weeks_between_jobs` (number,null, required)
    O número máximo de semanas em que o indivíduo esteve desempregado.
    Example: 249.8571

  - `results.increases_last_job` (integer,null, required)
    O número total de aumentos salariais que o usuário teve em seu último emprego. Se  for , isso se refere ao emprego atual do usuário.

> 
>
> Para todos os aumentos ou reduções salariais, consideramos apenas aqueles em que a mudança no salário é superior a 2%.

  - `results.decreases_last_job` (integer,null, required)
    O número total de aumentos salariais que o usuário teve em seu último emprego. Se  for , isso se refere ao emprego atual do usuário.

  - `results.increases_after_change` (integer,null, required)
    O número total de aumentos salariais entre o penúltimo emprego do indivíduo e o último (ou atual) emprego.

  - `results.decreases_after_change` (integer,null, required)
    O número total de reduções salariais entre o penúltimo emprego do indivíduo e o último (ou atual) emprego.

  - `results.increases_overall` (integer,null, required)
    O número total de aumentos salariais ao longo da carreira profissional do indivíduo.

  - `results.decreases_overall` (integer,null, required)
    O número total de reduções salariais ao longo da carreira profissional do indivíduo.

  - `results.increases_1y` (integer,null, required)
    O número total de aumentos salariais ao longo do último ano do indivíduo (YTD).

  - `results.decreases_1y` (integer,null, required)
    O número total de reduções salariais ao longo do último ano do indivíduo (YTD).

  - `results.increases_3y` (integer,null, required)
    O número total de aumentos salariais ao longo dos últimos três anos do indivíduo.

> 
>
> Se a carreira profissional do indivíduo for inferior a três anos, retornamos .

  - `results.decreases_3y` (integer,null, required)
    O número total de reduções salariais ao longo dos últimos três anos do indivíduo.

> 
>
> Se a carreira profissional do indivíduo for inferior a três anos, retornamos .

  - `results.increases_5y` (integer,null, required)
    O número total de aumentos salariais ao longo dos últimos cinco anos do indivíduo.

> 
>
> Se a carreira profissional do indivíduo for inferior a cinco anos, retornamos .

  - `results.decreases_5y` (integer,null, required)
    O número total de reduções salariais ao longo dos últimos cinco anos do indivíduo.

> 
>
> Se a carreira profissional do indivíduo for inferior a cinco anos, retornamos .

  - `results.yearly_change_1y` (number,null, required)
    A mudança percentual do salário do indivíduo para o último ano (YTD).

  - `results.yearly_change_3y` (number,null, required)
    A variação percentual do salário do indivíduo nos últimos três anos.

> 
>
> Se a carreira profissional do indivíduo for inferior a três anos, retornamos .

  - `results.yearly_change_5y` (number,null, required)
    A variação percentual do salário do indivíduo nos últimos cinco anos.

> 
>
> Se a carreira profissional do indivíduo for inferior a cinco anos, retornamos .

  - `results.min_monthly_salary_1y` (number,null, required)
    O salário mensal mínimo do indivíduo no último ano.
    Example: 3402.88

  - `results.min_monthly_salary_3y` (number,null, required)
    O salário mensal mínimo do indivíduo nos últimos três anos.
    Example: 3402.88

  - `results.min_monthly_salary_5y` (number,null, required)
    O salário mensal mínimo do indivíduo nos últimos cinco anos.
    Example: 3402.88

  - `results.average_monthly_salary_1y` (number,null, required)
    O salário médio mensal do indivíduo no último ano.
    Example: 3402.88

  - `results.average_monthly_salary_3y` (number,null, required)
    O salário médio mensal do indivíduo nos últimos três anos.
    Example: 3402.88

  - `results.average_monthly_salary_5y` (number,null, required)
    O salário médio mensal do indivíduo nos últimos cinco anos.
    Example: 3402.88

  - `results.max_monthly_salary_1y` (number,null, required)
    O salário mensal máximo do indivíduo no último ano.
    Example: 3402.88

  - `results.max_monthly_salary_3y` (number,null, required)
    O salário mensal máximo do indivíduo nos últimos três anos.
    Example: 3402.88

  - `results.max_monthly_salary_5y` (number,null, required)
    O salário mensal máximo do indivíduo nos últimos cinco anos.
    Example: 3402.88

## Response 403 fields (application/json):

  - `code` (string)
    Um código de erro único () que permite classificar e tratar o erro programaticamente.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com 403 access_to_resource_denied.
    Example: "access_to_resource_denied"

  - `message` (string)
    Uma breve descrição do erro.

Para erros , a descrição é:

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

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: ). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 404 fields (application/json):

  - `code` (string)
    Um código de erro único () que permite classificar e lidar com o erro programaticamente.
    Example: "not_found"

  - `message` (string)
    Uma breve descrição do erro.

Para erros , a descrição é:

  -
    Example: "Not found"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: ). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 408 fields (application/json):

  - `code` (string)
    Um código de erro único () que permite classificar e lidar com o erro programaticamente.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 408 request_timeout.
    Example: "request_timeout"

  - `message` (string)
    Uma breve descrição do erro.

Para erros de , a descrição é:

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

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: ). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 500 fields (application/json):

  - `code` (string)
    Um código de erro único () que permite classificar e tratar o erro de forma programática.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 500 unexpected_error.
    Example: "unexpected_error"

  - `message` (string)
    Uma breve descrição do erro.

Para erros , a descrição é:

  - .
    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)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: ). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"