Desempenho por campanha

GET

/v1/t/{tenantID}/campaigns

curl --request GET \
  --url https://dash.owiew.com/v1/t/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/campaigns \
  --header 'Authorization: Bearer <token>'

• Produção

Uma linha por campanha com entrega no período.

Não tire média de métrica derivada entre linhas. O CPA do conjunto é a soma dos gastos dividida pela soma das conversões — a média dos CPAs individuais dá um número que campanha nenhuma teve, e a diferença cresce com a desigualdade entre elas.

Exige a permissão insights.read.

Authorizations

• tokenDeAcesso

Parameters

Path Parameters

tenantID

required

string format: uuid

O cliente. Vem SEMPRE do caminho — nunca de cabeçalho, nunca de cookie. Ele é conferido contra o token: um identificador que não bata com o do token devolve 403, e não uma resposta vazia.

Query Parameters

since

string format: date

Primeiro dia, AAAA-MM-DD. Omitido, o servidor escolhe uma janela padrão — não presuma qual: peça explicitamente sempre que o número for comparado com outro.

until

string format: date

Último dia, AAAA-MM-DD. Inclusivo.

Responses

200

OK

Media typeapplication/json

object

since

Primeiro dia efetivamente usado.

string format: date

until

Último dia efetivamente usado, inclusivo.

string format: date

campaigns

Array

object

spend_micros

Investimento em MICROS: divida por 1.000.000 para obter o valor na moeda. 1.500.000 é 1,50. Nunca use ponto flutuante para converter — multiplique e divida como inteiro.

integer format: int64

impressions

Impressões.

integer format: int64

clicks

Cliques.

integer format: int64

conversions_micros

Conversões, TAMBÉM EM MICROS. A plataforma reporta conversões fracionárias (atribuição parcial), então a contagem não é inteira. Divida por 1.000.000 para ter o número de conversões. Exibir este campo cru já produziu um painel anunciando ‘75 milhões de conversões’ onde havia 75.

integer format: int64

conversion_value_micros

Valor das conversões reportado pela plataforma em MICROS: divida por 1.000.000 para obter o valor na moeda. 1.500.000 é 1,50. Nunca use ponto flutuante para converter — multiplique e divida como inteiro.

integer format: int64

currency

Moeda da CONTA, código ISO-4217. Contas de moedas diferentes NÃO podem ser somadas sem conversão — o total viria numericamente certo e semanticamente sem sentido.

string

revisions

Quantas alterações retroativas afetam este recorte. Maior que zero significa que a plataforma mudou números que já havia reportado.

integer

campaign_id

O identificador na plataforma. É a ÚNICA chave estável: nome de campanha muda, e casar por nome já produziu atribuição errada neste sistema quando dois clientes usaram o mesmo nome.

string

campaign_name

string

provider

Rede de anúncio da campanha.

string

budget_kind

Onde mora o orçamento: na campanha (daily/lifetime) ou nos conjuntos (none).

string

Allowed values: daily lifetime none

account_id

Conta de anúncio de origem.

string

days

Quantos dias do período tiveram entrega desta campanha.

integer

Example

{
  "campaigns": [
    {
      "budget_kind": "daily"
    }
  ]
}

401

Token ausente, malformado ou vencido.

Media typeapplication/json

object

error

object

code

Código estável, seguro para comparar.

string

message

Texto para pessoa. Pode mudar entre versões — não decida nada a partir dele.

string

trace_id

Identificador da ocorrência. Cite-o ao pedir suporte.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "trace_id": "example"
  }
}

403

O token é válido, e o escopo não. Ou ele foi emitido para outro cliente, ou o papel não inclui a permissão da rota. NÃO é 404 de propósito: esconder um erro de escopo atrás de ‘não encontrado’ faz quem integra procurar o problema no lugar errado.

Media typeapplication/json

object

error

object

code

Código estável, seguro para comparar.

string

message

Texto para pessoa. Pode mudar entre versões — não decida nada a partir dele.

string

trace_id

Identificador da ocorrência. Cite-o ao pedir suporte.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "trace_id": "example"
  }
}