Ler os eventos de um job por setor censitário e semana

GET

/v1/jobs/{job_id}/setores

curl --request GET \
  --url 'https://api.brasilsintetico.com/v1/jobs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/setores?municipio=example' \
  --header 'Authorization: Bearer <token>'

Os eventos de um município por setor censitário e semana, para um job que os pediu (saida_por_setor): a média arredondada das contagens publicadas pelas réplicas, ou null com o motivo: a regra de k em alguma réplica (menor_que_k, complementar) ou o corte do diagnóstico no setor (erro_acima_do_corte, erro_nao_medido, sem_populacao_sintetica). Cada réplica publica zero ou pelo menos 5, então a média arredondada ainda pode ficar entre 1 e 4: um zero e um cinco dão 2.

Autorizações

• projectKey

Parâmetros

Parâmetros de caminho

job_id

obrigatório

string formato: uuid

Parâmetros de consulta

municipio

obrigatório

O código IBGE do município

string

/^\d{7}$/

O código IBGE do município

semana

Qualquer um de:

integer

integer

>= 1

null

null

Uma semana; todas, quando ausente

tipo

Qualquer um de:

string

string

null

null

O tipo de evento; por padrão, o primeiro que o job tem

Respostas

200

Resposta bem-sucedida

Tipo de mídiaapplication/json

object

municipio

obrigatório

string

semanas

obrigatório

As semanas que o job publicou (blocos de 7 dias a partir do dia 1)

integer

tipos

obrigatório

Os tipos de evento que a tabela tem para o job

Array<string>

tipo

obrigatório

string

semana

obrigatório

Qualquer um de:

integer

integer

null

null

corte_erro

obrigatório

O corte de erro do diagnóstico aplicado a cada setor

number

linhas

obrigatório

Uma linha por setor e semana: n, a média arredondada das contagens publicadas pelas réplicas (cada uma zero ou pelo menos 5), ou null com motivo (menor_que_k, complementar, erro_acima_do_corte, erro_nao_medido ou sem_populacao_sintetica)

Array<object>

object

key

propriedades adicionais

any

motivos

obrigatório

Quantos pares de setor e semana cada motivo escondeu

object

key

propriedades adicionais

integer

total

obrigatório

integer

truncado

obrigatório

boolean

Exemplo ^gerado

{
  "municipio": "example",
  "semanas": 1,
  "tipos": [
    "example"
  ],
  "tipo": "example",
  "semana": 1,
  "corte_erro": 1,
  "linhas": [
    {}
  ],
  "motivos": {
    "additionalProperty": 1
  },
  "total": 1,
  "truncado": true
}

422

Erro de validação

Tipo de mídiaapplication/json

object

detail

Array<object>

object

loc

obrigatório

Local

Array

msg

obrigatório

Mensagem

string

type

obrigatório

Tipo do erro

string

input

ctx

Contexto

object

Exemplo ^gerado

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}