Pular para o conteúdo
Brasil SintéticoBrasil SintéticoBrasil Sintético

Comparar dois jobs

GET
/v1/jobs/compare
curl --request GET \
  --url 'https://api.brasilsintetico.com/v1/jobs/compare?a=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0&b=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0&limite=200' \
  --header 'Authorization: Bearer <token>'

Duas simulações concluídas do projeto, na mesma release, lado a lado: cada cenário e, tabela por tabela, os números principais dos achados com a diferença. Só se lê o que a rota dos achados serve, então a regra de privacidade vale.

Autorizações

Seção intitulada “Autorizações”

Parâmetros

Seção intitulada “Parâmetros”

Parâmetros de consulta

Seção intitulada “Parâmetros de consulta”
a
obrigatório

O primeiro job

string formato: uuid

O primeiro job

b
obrigatório

O segundo job: cada diferença é b menos a

string formato: uuid

O segundo job: cada diferença é b menos a

municipio
Qualquer um de:
Array<string>

Códigos IBGE a manter; por padrão, os que uma das duas campanhas mira

limite
integer
padrão: 200 >= 1 <= 1000

Respostas

Seção intitulada “Respostas”

200

Seção intitulada “200”

Resposta bem-sucedida

Tipo de mídiaapplication/json
object
a
obrigatório
object
job_id
obrigatório
string formato: uuid
nome
obrigatório
string
release
obrigatório
string
familia
obrigatório
Qualquer um de:
string
horizonte
obrigatório
object
data_inicio
Qualquer um de:
string
dias
Qualquer um de:
integer
grupo_comparacao
obrigatório
Qualquer um de:
string
grade
obrigatório

A grade que os achados descrevem: principal ou etaria

string
veredito
obrigatório
Qualquer um de:
object
key
propriedades adicionais
string
b
obrigatório
object
job_id
obrigatório
string formato: uuid
nome
obrigatório
string
release
obrigatório
string
familia
obrigatório
Qualquer um de:
string
horizonte
obrigatório
object
data_inicio
Qualquer um de:
string
dias
Qualquer um de:
integer
grupo_comparacao
obrigatório
Qualquer um de:
string
grade
obrigatório

A grade que os achados descrevem: principal ou etaria

string
veredito
obrigatório
Qualquer um de:
object
key
propriedades adicionais
string
mesmo_grupo_comparacao
obrigatório

Se os dois cenários têm o mesmo grupo de comparação e, portanto, os mesmos números aleatórios: aí a diferença vem dos planos, não do acaso

boolean
municipios

O nome de cada município que as linhas trazem, pelo código IBGE

object
key
propriedades adicionais
string
tabelas
obrigatório

saturacao, alcance_efetivo, alcance_potencial, contribuicao e elasticidade; uma tabela que nenhum dos dois jobs tem volta vazia

object
key
propriedades adicionais
object
chaves
obrigatório

As colunas que pareiam as linhas dos dois jobs

Array<string>
valores
obrigatório

Os números principais: as médias entre as réplicas, ou as contagens de uma tabela sem médias

Array<string>
linhas
obrigatório

Uma linha por chave: as colunas dela, a e b (null onde aquele job não tem essa linha) e diferenca, b menos a

Array<object>
object
key
propriedades adicionais
any
total
obrigatório

Quantas linhas pular antes da página

integer
truncado
obrigatório
boolean

Exemplo gerado

{
  "a": {
    "job_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "nome": "example",
    "release": "example",
    "familia": "example",
    "horizonte": {
      "data_inicio": "example",
      "dias": 1
    },
    "grupo_comparacao": "example",
    "grade": "example",
    "veredito": {
      "additionalProperty": "example"
    }
  },
  "b": {
    "job_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "nome": "example",
    "release": "example",
    "familia": "example",
    "horizonte": {
      "data_inicio": "example",
      "dias": 1
    },
    "grupo_comparacao": "example",
    "grade": "example",
    "veredito": {
      "additionalProperty": "example"
    }
  },
  "mesmo_grupo_comparacao": true,
  "municipios": {
    "additionalProperty": "example"
  },
  "tabelas": {
    "additionalProperty": {
      "chaves": [
        "example"
      ],
      "valores": [
        "example"
      ],
      "linhas": [
        {}
      ],
      "total": 1,
      "truncado": true
    }
  }
}

422

Seção intitulada “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": {}
    }
  ]
}