Listar a biblioteca de campanhas

GET

/v1/biblioteca

curl --request GET \
  --url https://api.brasilsintetico.com/v1/biblioteca \
  --header 'Authorization: Bearer <token>'

Modelos de campanha por setor para começar, e casos públicos em que o motor foi conferido contra uma série publicada. Qualquer chave pode ler, sem custo.

Autorizações

• projectKey

Respostas

200

Resposta bem-sucedida

Tipo de mídiaapplication/json

object

modelos

obrigatório

Modelos para começar uma campanha

Array<object>

object

id

obrigatório

O id do modelo, para GET /v1/biblioteca/{modelo}

string

setor

obrigatório

O setor para o qual o modelo foi escrito

string

nome

obrigatório

string

para_que_serve

obrigatório

O que o modelo ajuda a decidir

string

premissas

obrigatório

As premissas do modelo em palavras simples: o público, os canais com os dias e a intensidade, o horizonte. Um modelo traz premissas, não resultados

Array<string>

calibracao

obrigatório

nao_calibrado: a recepção da mensagem ainda não foi calibrada contra dados reais, e um job feito do modelo diz isso

string

casos

obrigatório

Casos públicos: onde o motor foi conferido contra uma série publicada, com o erro, a fonte e a licença dela

Array<object>

object

id

obrigatório

string

nome

obrigatório

string

o_que_foi_medido

obrigatório

string

release

obrigatório

A release a que a medição se aplica

string

vale_ate_dia

obrigatório

O último dia simulado que a medição cobre

integer

resumo

obrigatório

Quantas UFs têm cada veredito

object

key

propriedades adicionais

integer

ufs

obrigatório

Cada UF, com o seu veredito e o seu erro

Array<object>

object

uf

obrigatório

string

veredito

obrigatório

passou, reprovado_declarado ou nao_pontuado

string

mape_pior

Qualquer um de:

object

object

key

propriedades adicionais

any

null

null

reprovacoes

Cada teste reprovado: teste, periodo, valor e limite

Array<object>

object

key

propriedades adicionais

any

testes

obrigatório

O que cada teste mede e o seu limite

object

key

propriedades adicionais

string

fonte

obrigatório

A série publicada, com o crédito e a licença dela

object

credito

obrigatório

string

licenca

obrigatório

string

url

obrigatório

string

metodo

obrigatório

A página com o método e todos os números

string

aviso

obrigatório

string

aviso

obrigatório

O que cada modelo diz de si

string

Exemplo ^gerado

{
  "modelos": [
    {
      "id": "example",
      "setor": "example",
      "nome": "example",
      "para_que_serve": "example",
      "premissas": [
        "example"
      ],
      "calibracao": "example"
    }
  ],
  "casos": [
    {
      "id": "example",
      "nome": "example",
      "o_que_foi_medido": "example",
      "release": "example",
      "vale_ate_dia": 1,
      "resumo": {
        "additionalProperty": 1
      },
      "ufs": [
        {
          "uf": "example",
          "veredito": "example",
          "mape_pior": {},
          "reprovacoes": [
            {}
          ]
        }
      ],
      "testes": {
        "additionalProperty": "example"
      },
      "fonte": {
        "credito": "example",
        "licenca": "example",
        "url": "example"
      },
      "metodo": "example",
      "aviso": "example"
    }
  ],
  "aviso": "example"
}