Visão geral da API de leitura

A API de leitura devolve os dados de mídia paga do seu cliente na owiew: investimento, impressões, cliques, conversões, contas de anúncio e a trilha de quando cada número foi observado. Os valores vêm como as plataformas de anúncio os reportaram, sem arredondamento nem conversão de moeda.

O que a API é

Uma API HTTP com respostas em JSON, descrita em OpenAPI 3.1.
Somente leitura. Todas as rotas publicadas usam GET, com uma única exceção: POST /v1/token, que troca a sua chave de API por um token de curta duração.
Isolada por cliente. Cada chave de API pertence a um cliente e, se você quiser, a um subconjunto das contas de anúncio dele.
Pensada para programas, não para pessoas. Não há login, senha nem segundo fator: a credencial é a chave de API.

O que a API não faz

Não escreve. Marcar campanha, conectar loja, ativar plano ou alterar orçamento não existem na API publicada. Essas ações mudam o que o painel mostra ou gastam dinheiro na plataforma de anúncio, e por isso exigem uma pessoa confirmando na tela, com registro.
Não entrega métricas derivadas prontas. CPA, CPC, CTR, CPM e ROAS não vêm nas respostas de totais; você calcula a partir dos totais somados. Veja Unidades e tipos.
Não pagina por cursor. O recorte de uma consulta é a janela de datas. Veja Janelas de data e paginação.
Não oferece um usuário de serviço. Veja Autenticação.

Endereço base

Os exemplos desta documentação usam a variável de ambiente OWIEW_API_URL, cujo valor é:

https://dash.owiew.com

Todas as rotas de leitura ficam sob /v1/t/{tenantID}/..., em que {tenantID} é o identificador do cliente que a troca de token devolve. A troca fica em /v1/token, no mesmo endereço.

Versionamento

A versão está no caminho: tudo que existe hoje é /v1.
A versão do documento OpenAPI é 1.0.0. As mudanças estão no Changelog.
Escreva o seu cliente para ignorar campos que ele não conhece. Uma resposta pode ganhar campos novos sem que isso seja uma nova versão do caminho.
Os códigos de erro (error.code) são estáveis e seguros para comparar. O texto de error.message é para pessoas e pode mudar.

Como a documentação está organizada

Quero	Vá para
Fazer a primeira chamada em 5 minutos	Início rápido
Entender chave, token e erros 401 e 403	Autenticação
Saber o que uma chave enxerga	Permissões e escopo
Não errar uma conta de dinheiro	Unidades e tipos
Consultar uma rota específica	Referência
Copiar um código que funciona	Receitas: gasto por campanha, conciliar com pedidos, exportar para planilha