Ler uma tabela dos achados de um job

GET

/v1/jobs/{job_id}/findings

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

Os achados de um job concluído, em linhas: é assim que se lê a saída de um job.

Autorizações

• projectKey

Parâmetros

Parâmetros de caminho

job_id

obrigatório

string formato: uuid

Parâmetros de consulta

tabela

Uma de: saturacao, alcance_efetivo, alcance_potencial, contribuicao, elasticidade, veredito

string

padrão: saturacao

Uma de: saturacao, alcance_efetivo, alcance_potencial, contribuicao, elasticidade, veredito

municipio

Qualquer um de:

Array<string>

Array<string>

null

null

Códigos IBGE a manter; por padrão, os municípios que a campanha mira

limite

integer

padrão: 200 >= 1 <= 1000

Respostas

200

Resposta bem-sucedida

Tipo de mídiaapplication/json

object

tabela

obrigatório

string

colunas

obrigatório

Array<string>

descricao

O que cada coluna significa, pelo nome base (total_media é total)

object

key

propriedades adicionais

string

municipios

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

object

key

propriedades adicionais

string

linhas

obrigatório

Array<object>

object

key

propriedades adicionais

any

total

obrigatório

integer

truncado

obrigatório

boolean

grade

A grade de publicação que as linhas descrevem: principal, ou etaria (município × faixa etária de 5 anos × sexo) para um público recortado em faixas de 5 anos

string

padrão: principal

Exemplo

{
  "grade": "principal"
}

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": {}
    }
  ]
}