Preferências de privacidade

Funções necessárias

Necessárias para a segurança e as funções básicas do site.

Sempre ativas

Diagnósticos de Landing e reprodução com mascaramento

Mede visitas públicas, abandono e interações com links de cadastro usando um ID anônimo exclusivo desta aba, sem vincular contas. Todo o texto é mascarado e os formulários são bloqueados.

Análises opcionais de uso

Permitir análises de uso do PostHog? Altere sua escolha a qualquer momento no rodapé.

Permitir também a reprodução de sessões neste site público

A reprodução no modo opcional entre sites mostra páginas públicas e interações, com campos de entrada e conteúdo privado ocultos. A reprodução no App é uma escolha separada.

Exige análises opcionais; a reprodução neste modo entre sites fica desativada por padrão. O modo Landing acima funciona separadamente.

Como usamos os dados

O modo Landing padrão armazena um ID anônimo apenas no sessionStorage desta aba, sem vinculá-lo ao App, a contas ou ao ID opcional entre sites. Permitir análises opcionais muda para um ID separado, sem vincular os registros anteriores de Landing.

Ao permitir análises opcionais, você permite que o PostHog compartilhe um cookie anônimo entre este site e nosso App, com armazenamento local do navegador em cada site. Com seu consentimento, uma visita verificada na mesma aba pode ser vinculada à sua nova conta após a confirmação do cadastro.

A reprodução no modo opcional entre sites fica desativada por padrão. Desmarque sua opção de reprodução e salve para interromper novas gravações nesse modo; desative separadamente os diagnósticos de Landing e a reprodução com mascaramento acima. Essas escolhas não alteram as configurações da conta.

Aviso de privacidade e medição agregada separada do Cloudflare.

As análises do navegador não ativam as análises da conta.

SosoAPI
Comece grátis
PT-BR
EN繁中繁體中文（台灣）简体中文日本語한국어DeutschFrançaisEspañolPortuguês (Brasil)العربيةעבריתNederlandsहिन्दीBahasa IndonesiaNorsk bokmålSvenskaMagyar
Comece grátis

A busca carrega apenas quando você a usa. Explore todas as categorias abaixo.

Publicidade

Consultar insights publicitários

Busque resultados oficiais de publicidade paga com limites e datas, fuso horário, moeda, janela de atribuição e ação de conversão explícitos. As métricas ausentes continuam ausentes.

POST /advertising-api/insights/query

Contrato revisado: · sha256:9aedef8d43dd4514

Ler como MarkdownBaixar contrato públicoBaixar OpenAPI

Visão geral

Busque resultados oficiais de publicidade paga com limites e datas, fuso horário, moeda, janela de atribuição e ação de conversão explícitos. As métricas ausentes continuam ausentes.

Uma resposta HTTP bem-sucedida pode significar que uma requisição foi aceita, não concluída. Para trabalho em segundo plano, salve o ID retornado e consulte a mesma operação até terminar. Um post agendado ou aceito só está publicado quando a plataforma confirma; um timeout do cliente não comprova o resultado.

Autenticação e permissões

Classes de credenciais aceitas
user_session, delegated_oauth, personal_access_token
Capacidade delegada
agent:advertising_read
Função mínima no workspace
viewer
Escopo de acesso
Recursos que este usuário tem autorização para acessar
Consentimento para todos os workspaces obrigatório
Não
Altera o estado
Não
Quando a operação estiver concluída
synchronous_http_response

Um token só pode usar os direitos do seu proprietário. Cada requisição verifica participação no workspace, propriedade de recursos, workspaces selecionados e capacidades concedidas. Os perfis core e full mudam as ferramentas exibidas; não concedem acesso.

Campos da requisição

Obrigatório significa obrigatório dentro do objeto pai e da ramificação selecionada. Um filho obrigatório não torna obrigatório um pai opcional. As regras e nomes de campos abaixo são copiados do contrato.

Campos da requisição
Campo / ramificaçãoTipo / obrigatórioRestrições
$objectObrigatório no objeto pai
  • additionalProperties: false
workspace_idstringObrigatório no objeto pai
  • format: "uuid"
  • pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
advertising_account_idstringObrigatório no objeto pai
  • format: "uuid"
  • pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
levelstringObrigatório no objeto pai
  • enum: ["campaign","adset","ad"]
start_datestringObrigatório no objeto pai
  • pattern: "^\\d{4}-\\d{2}-\\d{2}$"
end_datestringObrigatório no objeto pai
  • pattern: "^\\d{4}-\\d{2}-\\d{2}$"
action_attribution_windowsarrayObrigatório no objeto pai
  • minItems: 1
  • maxItems: 1
action_attribution_windows[]stringOpcional / item
  • enum: ["1d_click","7d_click","1d_view"]
action_report_timestringObrigatório no objeto pai
  • enum: ["impression","conversion"]
conversion_action_typestringObrigatório no objeto pai
  • pattern: "^[a-z][a-z0-9_.]{0,99}$"
revenue_action_typestringObrigatório no objeto pai
  • pattern: "^[a-z][a-z0-9_.]{0,99}$"
afterstringOpcional / item
  • maxLength: 2048
limitintegerOpcional / item
  • minimum: 1
  • maximum: 50
  • default: 25
JSON Schema completo
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "workspace_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "advertising_account_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "level": {
      "type": "string",
      "enum": [
        "campaign",
        "adset",
        "ad"
      ]
    },
    "start_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "end_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "action_attribution_windows": {
      "minItems": 1,
      "maxItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "1d_click",
          "7d_click",
          "1d_view"
        ]
      }
    },
    "action_report_time": {
      "type": "string",
      "enum": [
        "impression",
        "conversion"
      ]
    },
    "conversion_action_type": {
      "type": "string",
      "pattern": "^[a-z][a-z0-9_.]{0,99}$"
    },
    "revenue_action_type": {
      "type": "string",
      "pattern": "^[a-z][a-z0-9_.]{0,99}$"
    },
    "after": {
      "type": "string",
      "maxLength": 2048
    },
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 50
    }
  },
  "required": [
    "workspace_id",
    "advertising_account_id",
    "level",
    "start_date",
    "end_date",
    "action_attribution_windows",
    "action_report_time",
    "conversion_action_type",
    "revenue_action_type"
  ],
  "additionalProperties": false
}

Resposta e conclusão

Códigos HTTP de sucesso: 200. Quando a operação estiver concluída: synchronous_http_response.

Uma resposta HTTP bem-sucedida pode significar que uma requisição foi aceita, não concluída. Para trabalho em segundo plano, salve o ID retornado e consulte a mesma operação até terminar. Um post agendado ou aceito só está publicado quando a plataforma confirma; um timeout do cliente não comprova o resultado.

Obrigatório significa obrigatório dentro do objeto pai e da ramificação selecionada. Um filho obrigatório não torna obrigatório um pai opcional. As regras e nomes de campos abaixo são copiados do contrato.

Resposta e conclusão
Campo / ramificaçãoTipo / obrigatórioRestrições
$objectObrigatório no objeto pai—
contract_versionstringObrigatório no objeto pai
  • const: "ad-performance/v1"
source_idstringObrigatório no objeto pai
  • maxLength: 100
source_sha256stringObrigatório no objeto pai
  • pattern: "^[a-f0-9]{64}$"
identity_verificationstringObrigatório no objeto pai
  • enum: ["customer_supplied","accepted_provider_grant"]
currencystringObrigatório no objeto pai
  • pattern: "^[A-Z]{3}$"
timezonestringObrigatório no objeto pai
  • maxLength: 100
selectionobjectObrigatório no objeto pai—
selection.provider_api_versionstringObrigatório no objeto pai
  • const: "v26.0"
selection.provider_account_idstringObrigatório no objeto pai
  • pattern: "^[1-9]\\d{1,24}$"
selection.currencystringObrigatório no objeto pai
  • pattern: "^[A-Z]{3}$"
selection.timezonestringObrigatório no objeto pai
  • maxLength: 100
selection.levelstringObrigatório no objeto pai
  • enum: ["campaign","adset","ad"]
selection.start_datestringObrigatório no objeto pai
  • pattern: "^\\d{4}-\\d{2}-\\d{2}$"
selection.end_datestringObrigatório no objeto pai
  • pattern: "^\\d{4}-\\d{2}-\\d{2}$"
selection.action_attribution_windowsarrayObrigatório no objeto pai
  • minItems: 1
  • maxItems: 1
selection.action_attribution_windows[]stringOpcional / item
  • enum: ["1d_click","7d_click","1d_view"]
selection.action_report_timestringObrigatório no objeto pai
  • enum: ["impression","conversion"]
selection.conversion_action_typestringObrigatório no objeto pai
  • maxLength: 100
selection.revenue_action_typestringObrigatório no objeto pai
  • maxLength: 100
completebooleanObrigatório no objeto pai—
rowsarrayObrigatório no objeto pai
  • maxItems: 500
rows[]objectOpcional / item—
rows[].row_idstringObrigatório no objeto pai
  • maxLength: 100
rows[].metricsobjectObrigatório no objeto pai—
rows[].metrics.spendobjectObrigatório no objeto pai—
rows[].metrics.spend.valuestring | nullObrigatório no objeto pai—
rows[].metrics.spend.valueanyOf 1stringObrigatório no objeto pai
  • pattern: "^\\d{1,24}(?:\\.\\d{1,6})?$"
rows[].metrics.spend.valueanyOf 2nullObrigatório no objeto pai—
rows[].metrics.spend.unitstringObrigatório no objeto pai
  • enum: ["currency","count","currency_per_click","currency_per_conversion","ratio"]
rows[].metrics.spend.availabilitystringObrigatório no objeto pai
  • enum: ["available","missing_input","zero_denominator","incompatible","partial"]
rows[].metrics.spend.reasonstring | nullObrigatório no objeto pai—
rows[].metrics.spend.reasonanyOf 1stringObrigatório no objeto pai
  • maxLength: 300
rows[].metrics.spend.reasonanyOf 2nullObrigatório no objeto pai—
rows[].metrics.spend.input_refsarrayObrigatório no objeto pai
  • maxItems: 2000
rows[].metrics.spend.input_refs[]stringOpcional / item
  • maxLength: 300
rows[].metrics.clicksobjectObrigatório no objeto pai—
rows[].metrics.clicks.valuestring | nullObrigatório no objeto pai—
rows[].metrics.clicks.valueanyOf 1stringObrigatório no objeto pai
  • pattern: "^\\d{1,24}(?:\\.\\d{1,6})?$"
rows[].metrics.clicks.valueanyOf 2nullObrigatório no objeto pai—
rows[].metrics.clicks.unitstringObrigatório no objeto pai
  • enum: ["currency","count","currency_per_click","currency_per_conversion","ratio"]
rows[].metrics.clicks.availabilitystringObrigatório no objeto pai
  • enum: ["available","missing_input","zero_denominator","incompatible","partial"]
rows[].metrics.clicks.reasonstring | nullObrigatório no objeto pai—
rows[].metrics.clicks.reasonanyOf 1stringObrigatório no objeto pai
  • maxLength: 300
rows[].metrics.clicks.reasonanyOf 2nullObrigatório no objeto pai—
rows[].metrics.clicks.input_refsarrayObrigatório no objeto pai
  • maxItems: 2000
rows[].metrics.clicks.input_refs[]stringOpcional / item
  • maxLength: 300
rows[].metrics.conversionsobjectObrigatório no objeto pai—
rows[].metrics.conversions.valuestring | nullObrigatório no objeto pai—
rows[].metrics.conversions.valueanyOf 1stringObrigatório no objeto pai
  • pattern: "^\\d{1,24}(?:\\.\\d{1,6})?$"
rows[].metrics.conversions.valueanyOf 2nullObrigatório no objeto pai—
rows[].metrics.conversions.unitstringObrigatório no objeto pai
  • enum: ["currency","count","currency_per_click","currency_per_conversion","ratio"]
rows[].metrics.conversions.availabilitystringObrigatório no objeto pai
  • enum: ["available","missing_input","zero_denominator","incompatible","partial"]
rows[].metrics.conversions.reasonstring | nullObrigatório no objeto pai—
rows[].metrics.conversions.reasonanyOf 1stringObrigatório no objeto pai
  • maxLength: 300
rows[].metrics.conversions.reasonanyOf 2nullObrigatório no objeto pai—
rows[].metrics.conversions.input_refsarrayObrigatório no objeto pai
  • maxItems: 2000
rows[].metrics.conversions.input_refs[]stringOpcional / item
  • maxLength: 300
rows[].metrics.attributed_revenueobjectObrigatório no objeto pai—
rows[].metrics.attributed_revenue.valuestring | nullObrigatório no objeto pai—
rows[].metrics.attributed_revenue.valueanyOf 1stringObrigatório no objeto pai
  • pattern: "^\\d{1,24}(?:\\.\\d{1,6})?$"
rows[].metrics.attributed_revenue.valueanyOf 2nullObrigatório no objeto pai—
rows[].metrics.attributed_revenue.unitstringObrigatório no objeto pai
  • enum: ["currency","count","currency_per_click","currency_per_conversion","ratio"]
rows[].metrics.attributed_revenue.availabilitystringObrigatório no objeto pai
  • enum: ["available","missing_input","zero_denominator","incompatible","partial"]
rows[].metrics.attributed_revenue.reasonstring | nullObrigatório no objeto pai—
rows[].metrics.attributed_revenue.reasonanyOf 1stringObrigatório no objeto pai
  • maxLength: 300
rows[].metrics.attributed_revenue.reasonanyOf 2nullObrigatório no objeto pai—
rows[].metrics.attributed_revenue.input_refsarrayObrigatório no objeto pai
  • maxItems: 2000
rows[].metrics.attributed_revenue.input_refs[]stringOpcional / item
  • maxLength: 300
rows[].metrics.cpcobjectObrigatório no objeto pai—
rows[].metrics.cpc.valuestring | nullObrigatório no objeto pai—
rows[].metrics.cpc.valueanyOf 1stringObrigatório no objeto pai
  • pattern: "^\\d{1,24}(?:\\.\\d{1,6})?$"
rows[].metrics.cpc.valueanyOf 2nullObrigatório no objeto pai—
rows[].metrics.cpc.unitstringObrigatório no objeto pai
  • enum: ["currency","count","currency_per_click","currency_per_conversion","ratio"]
rows[].metrics.cpc.availabilitystringObrigatório no objeto pai
  • enum: ["available","missing_input","zero_denominator","incompatible","partial"]
rows[].metrics.cpc.reasonstring | nullObrigatório no objeto pai—
rows[].metrics.cpc.reasonanyOf 1stringObrigatório no objeto pai
  • maxLength: 300
rows[].metrics.cpc.reasonanyOf 2nullObrigatório no objeto pai—
rows[].metrics.cpc.input_refsarrayObrigatório no objeto pai
  • maxItems: 2000
rows[].metrics.cpc.input_refs[]stringOpcional / item
  • maxLength: 300
rows[].metrics.cpaobjectObrigatório no objeto pai—
rows[].metrics.cpa.valuestring | nullObrigatório no objeto pai—
rows[].metrics.cpa.valueanyOf 1stringObrigatório no objeto pai
  • pattern: "^\\d{1,24}(?:\\.\\d{1,6})?$"
rows[].metrics.cpa.valueanyOf 2nullObrigatório no objeto pai—
rows[].metrics.cpa.unitstringObrigatório no objeto pai
  • enum: ["currency","count","currency_per_click","currency_per_conversion","ratio"]
rows[].metrics.cpa.availabilitystringObrigatório no objeto pai
  • enum: ["available","missing_input","zero_denominator","incompatible","partial"]
rows[].metrics.cpa.reasonstring | nullObrigatório no objeto pai—
rows[].metrics.cpa.reasonanyOf 1stringObrigatório no objeto pai
  • maxLength: 300
rows[].metrics.cpa.reasonanyOf 2nullObrigatório no objeto pai—
rows[].metrics.cpa.input_refsarrayObrigatório no objeto pai
  • maxItems: 2000
rows[].metrics.cpa.input_refs[]stringOpcional / item
  • maxLength: 300
rows[].metrics.attributed_roasobjectObrigatório no objeto pai—
rows[].metrics.attributed_roas.valuestring | nullObrigatório no objeto pai—
rows[].metrics.attributed_roas.valueanyOf 1stringObrigatório no objeto pai
  • pattern: "^\\d{1,24}(?:\\.\\d{1,6})?$"
rows[].metrics.attributed_roas.valueanyOf 2nullObrigatório no objeto pai—
rows[].metrics.attributed_roas.unitstringObrigatório no objeto pai
  • enum: ["currency","count","currency_per_click","currency_per_conversion","ratio"]
rows[].metrics.attributed_roas.availabilitystringObrigatório no objeto pai
  • enum: ["available","missing_input","zero_denominator","incompatible","partial"]
rows[].metrics.attributed_roas.reasonstring | nullObrigatório no objeto pai—
rows[].metrics.attributed_roas.reasonanyOf 1stringObrigatório no objeto pai
  • maxLength: 300
rows[].metrics.attributed_roas.reasonanyOf 2nullObrigatório no objeto pai—
rows[].metrics.attributed_roas.input_refsarrayObrigatório no objeto pai
  • maxItems: 2000
rows[].metrics.attributed_roas.input_refs[]stringOpcional / item
  • maxLength: 300
totalsobjectObrigatório no objeto pai—
totals.spendobjectObrigatório no objeto pai—
totals.spend.valuestring | nullObrigatório no objeto pai—
totals.spend.valueanyOf 1stringObrigatório no objeto pai
  • pattern: "^\\d{1,24}(?:\\.\\d{1,6})?$"
totals.spend.valueanyOf 2nullObrigatório no objeto pai—
totals.spend.unitstringObrigatório no objeto pai
  • enum: ["currency","count","currency_per_click","currency_per_conversion","ratio"]
totals.spend.availabilitystringObrigatório no objeto pai
  • enum: ["available","missing_input","zero_denominator","incompatible","partial"]
totals.spend.reasonstring | nullObrigatório no objeto pai—
totals.spend.reasonanyOf 1stringObrigatório no objeto pai
  • maxLength: 300
totals.spend.reasonanyOf 2nullObrigatório no objeto pai—
totals.spend.input_refsarrayObrigatório no objeto pai
  • maxItems: 2000
totals.spend.input_refs[]stringOpcional / item
  • maxLength: 300
totals.clicksobjectObrigatório no objeto pai—
totals.clicks.valuestring | nullObrigatório no objeto pai—
totals.clicks.valueanyOf 1stringObrigatório no objeto pai
  • pattern: "^\\d{1,24}(?:\\.\\d{1,6})?$"
totals.clicks.valueanyOf 2nullObrigatório no objeto pai—
totals.clicks.unitstringObrigatório no objeto pai
  • enum: ["currency","count","currency_per_click","currency_per_conversion","ratio"]
totals.clicks.availabilitystringObrigatório no objeto pai
  • enum: ["available","missing_input","zero_denominator","incompatible","partial"]
totals.clicks.reasonstring | nullObrigatório no objeto pai—
totals.clicks.reasonanyOf 1stringObrigatório no objeto pai
  • maxLength: 300
totals.clicks.reasonanyOf 2nullObrigatório no objeto pai—
totals.clicks.input_refsarrayObrigatório no objeto pai
  • maxItems: 2000
totals.clicks.input_refs[]stringOpcional / item
  • maxLength: 300
totals.conversionsobjectObrigatório no objeto pai—
totals.conversions.valuestring | nullObrigatório no objeto pai—
totals.conversions.valueanyOf 1stringObrigatório no objeto pai
  • pattern: "^\\d{1,24}(?:\\.\\d{1,6})?$"
totals.conversions.valueanyOf 2nullObrigatório no objeto pai—
totals.conversions.unitstringObrigatório no objeto pai
  • enum: ["currency","count","currency_per_click","currency_per_conversion","ratio"]
totals.conversions.availabilitystringObrigatório no objeto pai
  • enum: ["available","missing_input","zero_denominator","incompatible","partial"]
totals.conversions.reasonstring | nullObrigatório no objeto pai—
totals.conversions.reasonanyOf 1stringObrigatório no objeto pai
  • maxLength: 300
totals.conversions.reasonanyOf 2nullObrigatório no objeto pai—
totals.conversions.input_refsarrayObrigatório no objeto pai
  • maxItems: 2000
totals.conversions.input_refs[]stringOpcional / item
  • maxLength: 300
totals.attributed_revenueobjectObrigatório no objeto pai—
totals.attributed_revenue.valuestring | nullObrigatório no objeto pai—
totals.attributed_revenue.valueanyOf 1stringObrigatório no objeto pai
  • pattern: "^\\d{1,24}(?:\\.\\d{1,6})?$"
totals.attributed_revenue.valueanyOf 2nullObrigatório no objeto pai—
totals.attributed_revenue.unitstringObrigatório no objeto pai
  • enum: ["currency","count","currency_per_click","currency_per_conversion","ratio"]
totals.attributed_revenue.availabilitystringObrigatório no objeto pai
  • enum: ["available","missing_input","zero_denominator","incompatible","partial"]
totals.attributed_revenue.reasonstring | nullObrigatório no objeto pai—
totals.attributed_revenue.reasonanyOf 1stringObrigatório no objeto pai
  • maxLength: 300
totals.attributed_revenue.reasonanyOf 2nullObrigatório no objeto pai—
totals.attributed_revenue.input_refsarrayObrigatório no objeto pai
  • maxItems: 2000
totals.attributed_revenue.input_refs[]stringOpcional / item
  • maxLength: 300
totals.cpcobjectObrigatório no objeto pai—
totals.cpc.valuestring | nullObrigatório no objeto pai—
totals.cpc.valueanyOf 1stringObrigatório no objeto pai
  • pattern: "^\\d{1,24}(?:\\.\\d{1,6})?$"
totals.cpc.valueanyOf 2nullObrigatório no objeto pai—
totals.cpc.unitstringObrigatório no objeto pai
  • enum: ["currency","count","currency_per_click","currency_per_conversion","ratio"]
totals.cpc.availabilitystringObrigatório no objeto pai
  • enum: ["available","missing_input","zero_denominator","incompatible","partial"]
totals.cpc.reasonstring | nullObrigatório no objeto pai—
totals.cpc.reasonanyOf 1stringObrigatório no objeto pai
  • maxLength: 300
totals.cpc.reasonanyOf 2nullObrigatório no objeto pai—
totals.cpc.input_refsarrayObrigatório no objeto pai
  • maxItems: 2000
totals.cpc.input_refs[]stringOpcional / item
  • maxLength: 300
totals.cpaobjectObrigatório no objeto pai—
totals.cpa.valuestring | nullObrigatório no objeto pai—
totals.cpa.valueanyOf 1stringObrigatório no objeto pai
  • pattern: "^\\d{1,24}(?:\\.\\d{1,6})?$"
totals.cpa.valueanyOf 2nullObrigatório no objeto pai—
totals.cpa.unitstringObrigatório no objeto pai
  • enum: ["currency","count","currency_per_click","currency_per_conversion","ratio"]
totals.cpa.availabilitystringObrigatório no objeto pai
  • enum: ["available","missing_input","zero_denominator","incompatible","partial"]
totals.cpa.reasonstring | nullObrigatório no objeto pai—
totals.cpa.reasonanyOf 1stringObrigatório no objeto pai
  • maxLength: 300
totals.cpa.reasonanyOf 2nullObrigatório no objeto pai—
totals.cpa.input_refsarrayObrigatório no objeto pai
  • maxItems: 2000
totals.cpa.input_refs[]stringOpcional / item
  • maxLength: 300
totals.attributed_roasobjectObrigatório no objeto pai—
totals.attributed_roas.valuestring | nullObrigatório no objeto pai—
totals.attributed_roas.valueanyOf 1stringObrigatório no objeto pai
  • pattern: "^\\d{1,24}(?:\\.\\d{1,6})?$"
totals.attributed_roas.valueanyOf 2nullObrigatório no objeto pai—
totals.attributed_roas.unitstringObrigatório no objeto pai
  • enum: ["currency","count","currency_per_click","currency_per_conversion","ratio"]
totals.attributed_roas.availabilitystringObrigatório no objeto pai
  • enum: ["available","missing_input","zero_denominator","incompatible","partial"]
totals.attributed_roas.reasonstring | nullObrigatório no objeto pai—
totals.attributed_roas.reasonanyOf 1stringObrigatório no objeto pai
  • maxLength: 300
totals.attributed_roas.reasonanyOf 2nullObrigatório no objeto pai—
totals.attributed_roas.input_refsarrayObrigatório no objeto pai
  • maxItems: 2000
totals.attributed_roas.input_refs[]stringOpcional / item
  • maxLength: 300
gapsarrayObrigatório no objeto pai
  • maxItems: 1000
gaps[]stringOpcional / item
  • maxLength: 300
suggestionsarrayObrigatório no objeto pai
  • maxItems: 3
suggestions[]objectOpcional / item—
suggestions[].rule_idstringObrigatório no objeto pai
  • enum: ["supply_revenue","review_comparable_creative_test","complete_coverage"]
suggestions[].rule_versionnumberObrigatório no objeto pai
  • const: 1
suggestions[].proposalstringObrigatório no objeto pai
  • maxLength: 600
suggestions[].input_refsarrayObrigatório no objeto pai
  • maxItems: 2000
suggestions[].input_refs[]stringOpcional / item
  • maxLength: 300
suggestions[].limitationsstringObrigatório no objeto pai
  • const: "Observational comparison only; no causal uplift or profitability claim. Human review required."
advertising_account_idstringObrigatório no objeto pai
  • format: "uuid"
  • pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
next_cursorstring | nullObrigatório no objeto pai—
next_cursoranyOf 1stringObrigatório no objeto pai
  • maxLength: 2048
next_cursoranyOf 2nullObrigatório no objeto pai—
JSON Schema completo
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "contract_version": {
      "type": "string",
      "const": "ad-performance/v1"
    },
    "source_id": {
      "type": "string",
      "maxLength": 100
    },
    "source_sha256": {
      "type": "string",
      "pattern": "^[a-f0-9]{64}$"
    },
    "identity_verification": {
      "type": "string",
      "enum": [
        "customer_supplied",
        "accepted_provider_grant"
      ]
    },
    "currency": {
      "type": "string",
      "pattern": "^[A-Z]{3}$"
    },
    "timezone": {
      "type": "string",
      "maxLength": 100
    },
    "selection": {
      "type": "object",
      "properties": {
        "provider_api_version": {
          "type": "string",
          "const": "v26.0"
        },
        "provider_account_id": {
          "type": "string",
          "pattern": "^[1-9]\\d{1,24}$"
        },
        "currency": {
          "type": "string",
          "pattern": "^[A-Z]{3}$"
        },
        "timezone": {
          "type": "string",
          "maxLength": 100
        },
        "level": {
          "type": "string",
          "enum": [
            "campaign",
            "adset",
            "ad"
          ]
        },
        "start_date": {
          "type": "string",
          "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
        },
        "end_date": {
          "type": "string",
          "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
        },
        "action_attribution_windows": {
          "minItems": 1,
          "maxItems": 1,
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "1d_click",
              "7d_click",
              "1d_view"
            ]
          }
        },
        "action_report_time": {
          "type": "string",
          "enum": [
            "impression",
            "conversion"
          ]
        },
        "conversion_action_type": {
          "type": "string",
          "maxLength": 100
        },
        "revenue_action_type": {
          "type": "string",
          "maxLength": 100
        }
      },
      "required": [
        "provider_api_version",
        "provider_account_id",
        "currency",
        "timezone",
        "level",
        "start_date",
        "end_date",
        "action_attribution_windows",
        "action_report_time",
        "conversion_action_type",
        "revenue_action_type"
      ]
    },
    "complete": {
      "type": "boolean"
    },
    "rows": {
      "maxItems": 500,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "row_id": {
            "type": "string",
            "maxLength": 100
          },
          "metrics": {
            "type": "object",
            "properties": {
              "spend": {
                "type": "object",
                "properties": {
                  "value": {
                    "anyOf": [
                      {
                        "type": "string",
                        "pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "unit": {
                    "type": "string",
                    "enum": [
                      "currency",
                      "count",
                      "currency_per_click",
                      "currency_per_conversion",
                      "ratio"
                    ]
                  },
                  "availability": {
                    "type": "string",
                    "enum": [
                      "available",
                      "missing_input",
                      "zero_denominator",
                      "incompatible",
                      "partial"
                    ]
                  },
                  "reason": {
                    "anyOf": [
                      {
                        "type": "string",
                        "maxLength": 300
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "input_refs": {
                    "maxItems": 2000,
                    "type": "array",
                    "items": {
                      "type": "string",
                      "maxLength": 300
                    }
                  }
                },
                "required": [
                  "value",
                  "unit",
                  "availability",
                  "reason",
                  "input_refs"
                ]
              },
              "clicks": {
                "type": "object",
                "properties": {
                  "value": {
                    "anyOf": [
                      {
                        "type": "string",
                        "pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "unit": {
                    "type": "string",
                    "enum": [
                      "currency",
                      "count",
                      "currency_per_click",
                      "currency_per_conversion",
                      "ratio"
                    ]
                  },
                  "availability": {
                    "type": "string",
                    "enum": [
                      "available",
                      "missing_input",
                      "zero_denominator",
                      "incompatible",
                      "partial"
                    ]
                  },
                  "reason": {
                    "anyOf": [
                      {
                        "type": "string",
                        "maxLength": 300
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "input_refs": {
                    "maxItems": 2000,
                    "type": "array",
                    "items": {
                      "type": "string",
                      "maxLength": 300
                    }
                  }
                },
                "required": [
                  "value",
                  "unit",
                  "availability",
                  "reason",
                  "input_refs"
                ]
              },
              "conversions": {
                "type": "object",
                "properties": {
                  "value": {
                    "anyOf": [
                      {
                        "type": "string",
                        "pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "unit": {
                    "type": "string",
                    "enum": [
                      "currency",
                      "count",
                      "currency_per_click",
                      "currency_per_conversion",
                      "ratio"
                    ]
                  },
                  "availability": {
                    "type": "string",
                    "enum": [
                      "available",
                      "missing_input",
                      "zero_denominator",
                      "incompatible",
                      "partial"
                    ]
                  },
                  "reason": {
                    "anyOf": [
                      {
                        "type": "string",
                        "maxLength": 300
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "input_refs": {
                    "maxItems": 2000,
                    "type": "array",
                    "items": {
                      "type": "string",
                      "maxLength": 300
                    }
                  }
                },
                "required": [
                  "value",
                  "unit",
                  "availability",
                  "reason",
                  "input_refs"
                ]
              },
              "attributed_revenue": {
                "type": "object",
                "properties": {
                  "value": {
                    "anyOf": [
                      {
                        "type": "string",
                        "pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "unit": {
                    "type": "string",
                    "enum": [
                      "currency",
                      "count",
                      "currency_per_click",
                      "currency_per_conversion",
                      "ratio"
                    ]
                  },
                  "availability": {
                    "type": "string",
                    "enum": [
                      "available",
                      "missing_input",
                      "zero_denominator",
                      "incompatible",
                      "partial"
                    ]
                  },
                  "reason": {
                    "anyOf": [
                      {
                        "type": "string",
                        "maxLength": 300
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "input_refs": {
                    "maxItems": 2000,
                    "type": "array",
                    "items": {
                      "type": "string",
                      "maxLength": 300
                    }
                  }
                },
                "required": [
                  "value",
                  "unit",
                  "availability",
                  "reason",
                  "input_refs"
                ]
              },
              "cpc": {
                "type": "object",
                "properties": {
                  "value": {
                    "anyOf": [
                      {
                        "type": "string",
                        "pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "unit": {
                    "type": "string",
                    "enum": [
                      "currency",
                      "count",
                      "currency_per_click",
                      "currency_per_conversion",
                      "ratio"
                    ]
                  },
                  "availability": {
                    "type": "string",
                    "enum": [
                      "available",
                      "missing_input",
                      "zero_denominator",
                      "incompatible",
                      "partial"
                    ]
                  },
                  "reason": {
                    "anyOf": [
                      {
                        "type": "string",
                        "maxLength": 300
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "input_refs": {
                    "maxItems": 2000,
                    "type": "array",
                    "items": {
                      "type": "string",
                      "maxLength": 300
                    }
                  }
                },
                "required": [
                  "value",
                  "unit",
                  "availability",
                  "reason",
                  "input_refs"
                ]
              },
              "cpa": {
                "type": "object",
                "properties": {
                  "value": {
                    "anyOf": [
                      {
                        "type": "string",
                        "pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "unit": {
                    "type": "string",
                    "enum": [
                      "currency",
                      "count",
                      "currency_per_click",
                      "currency_per_conversion",
                      "ratio"
                    ]
                  },
                  "availability": {
                    "type": "string",
                    "enum": [
                      "available",
                      "missing_input",
                      "zero_denominator",
                      "incompatible",
                      "partial"
                    ]
                  },
                  "reason": {
                    "anyOf": [
                      {
                        "type": "string",
                        "maxLength": 300
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "input_refs": {
                    "maxItems": 2000,
                    "type": "array",
                    "items": {
                      "type": "string",
                      "maxLength": 300
                    }
                  }
                },
                "required": [
                  "value",
                  "unit",
                  "availability",
                  "reason",
                  "input_refs"
                ]
              },
              "attributed_roas": {
                "type": "object",
                "properties": {
                  "value": {
                    "anyOf": [
                      {
                        "type": "string",
                        "pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "unit": {
                    "type": "string",
                    "enum": [
                      "currency",
                      "count",
                      "currency_per_click",
                      "currency_per_conversion",
                      "ratio"
                    ]
                  },
                  "availability": {
                    "type": "string",
                    "enum": [
                      "available",
                      "missing_input",
                      "zero_denominator",
                      "incompatible",
                      "partial"
                    ]
                  },
                  "reason": {
                    "anyOf": [
                      {
                        "type": "string",
                        "maxLength": 300
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "input_refs": {
                    "maxItems": 2000,
                    "type": "array",
                    "items": {
                      "type": "string",
                      "maxLength": 300
                    }
                  }
                },
                "required": [
                  "value",
                  "unit",
                  "availability",
                  "reason",
                  "input_refs"
                ]
              }
            },
            "required": [
              "spend",
              "clicks",
              "conversions",
              "attributed_revenue",
              "cpc",
              "cpa",
              "attributed_roas"
            ]
          }
        },
        "required": [
          "row_id",
          "metrics"
        ]
      }
    },
    "totals": {
      "type": "object",
      "properties": {
        "spend": {
          "type": "object",
          "properties": {
            "value": {
              "anyOf": [
                {
                  "type": "string",
                  "pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "unit": {
              "type": "string",
              "enum": [
                "currency",
                "count",
                "currency_per_click",
                "currency_per_conversion",
                "ratio"
              ]
            },
            "availability": {
              "type": "string",
              "enum": [
                "available",
                "missing_input",
                "zero_denominator",
                "incompatible",
                "partial"
              ]
            },
            "reason": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 300
                },
                {
                  "type": "null"
                }
              ]
            },
            "input_refs": {
              "maxItems": 2000,
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 300
              }
            }
          },
          "required": [
            "value",
            "unit",
            "availability",
            "reason",
            "input_refs"
          ]
        },
        "clicks": {
          "type": "object",
          "properties": {
            "value": {
              "anyOf": [
                {
                  "type": "string",
                  "pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "unit": {
              "type": "string",
              "enum": [
                "currency",
                "count",
                "currency_per_click",
                "currency_per_conversion",
                "ratio"
              ]
            },
            "availability": {
              "type": "string",
              "enum": [
                "available",
                "missing_input",
                "zero_denominator",
                "incompatible",
                "partial"
              ]
            },
            "reason": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 300
                },
                {
                  "type": "null"
                }
              ]
            },
            "input_refs": {
              "maxItems": 2000,
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 300
              }
            }
          },
          "required": [
            "value",
            "unit",
            "availability",
            "reason",
            "input_refs"
          ]
        },
        "conversions": {
          "type": "object",
          "properties": {
            "value": {
              "anyOf": [
                {
                  "type": "string",
                  "pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "unit": {
              "type": "string",
              "enum": [
                "currency",
                "count",
                "currency_per_click",
                "currency_per_conversion",
                "ratio"
              ]
            },
            "availability": {
              "type": "string",
              "enum": [
                "available",
                "missing_input",
                "zero_denominator",
                "incompatible",
                "partial"
              ]
            },
            "reason": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 300
                },
                {
                  "type": "null"
                }
              ]
            },
            "input_refs": {
              "maxItems": 2000,
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 300
              }
            }
          },
          "required": [
            "value",
            "unit",
            "availability",
            "reason",
            "input_refs"
          ]
        },
        "attributed_revenue": {
          "type": "object",
          "properties": {
            "value": {
              "anyOf": [
                {
                  "type": "string",
                  "pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "unit": {
              "type": "string",
              "enum": [
                "currency",
                "count",
                "currency_per_click",
                "currency_per_conversion",
                "ratio"
              ]
            },
            "availability": {
              "type": "string",
              "enum": [
                "available",
                "missing_input",
                "zero_denominator",
                "incompatible",
                "partial"
              ]
            },
            "reason": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 300
                },
                {
                  "type": "null"
                }
              ]
            },
            "input_refs": {
              "maxItems": 2000,
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 300
              }
            }
          },
          "required": [
            "value",
            "unit",
            "availability",
            "reason",
            "input_refs"
          ]
        },
        "cpc": {
          "type": "object",
          "properties": {
            "value": {
              "anyOf": [
                {
                  "type": "string",
                  "pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "unit": {
              "type": "string",
              "enum": [
                "currency",
                "count",
                "currency_per_click",
                "currency_per_conversion",
                "ratio"
              ]
            },
            "availability": {
              "type": "string",
              "enum": [
                "available",
                "missing_input",
                "zero_denominator",
                "incompatible",
                "partial"
              ]
            },
            "reason": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 300
                },
                {
                  "type": "null"
                }
              ]
            },
            "input_refs": {
              "maxItems": 2000,
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 300
              }
            }
          },
          "required": [
            "value",
            "unit",
            "availability",
            "reason",
            "input_refs"
          ]
        },
        "cpa": {
          "type": "object",
          "properties": {
            "value": {
              "anyOf": [
                {
                  "type": "string",
                  "pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "unit": {
              "type": "string",
              "enum": [
                "currency",
                "count",
                "currency_per_click",
                "currency_per_conversion",
                "ratio"
              ]
            },
            "availability": {
              "type": "string",
              "enum": [
                "available",
                "missing_input",
                "zero_denominator",
                "incompatible",
                "partial"
              ]
            },
            "reason": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 300
                },
                {
                  "type": "null"
                }
              ]
            },
            "input_refs": {
              "maxItems": 2000,
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 300
              }
            }
          },
          "required": [
            "value",
            "unit",
            "availability",
            "reason",
            "input_refs"
          ]
        },
        "attributed_roas": {
          "type": "object",
          "properties": {
            "value": {
              "anyOf": [
                {
                  "type": "string",
                  "pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "unit": {
              "type": "string",
              "enum": [
                "currency",
                "count",
                "currency_per_click",
                "currency_per_conversion",
                "ratio"
              ]
            },
            "availability": {
              "type": "string",
              "enum": [
                "available",
                "missing_input",
                "zero_denominator",
                "incompatible",
                "partial"
              ]
            },
            "reason": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 300
                },
                {
                  "type": "null"
                }
              ]
            },
            "input_refs": {
              "maxItems": 2000,
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 300
              }
            }
          },
          "required": [
            "value",
            "unit",
            "availability",
            "reason",
            "input_refs"
          ]
        }
      },
      "required": [
        "spend",
        "clicks",
        "conversions",
        "attributed_revenue",
        "cpc",
        "cpa",
        "attributed_roas"
      ]
    },
    "gaps": {
      "maxItems": 1000,
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 300
      }
    },
    "suggestions": {
      "maxItems": 3,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "rule_id": {
            "type": "string",
            "enum": [
              "supply_revenue",
              "review_comparable_creative_test",
              "complete_coverage"
            ]
          },
          "rule_version": {
            "type": "number",
            "const": 1
          },
          "proposal": {
            "type": "string",
            "maxLength": 600
          },
          "input_refs": {
            "maxItems": 2000,
            "type": "array",
            "items": {
              "type": "string",
              "maxLength": 300
            }
          },
          "limitations": {
            "type": "string",
            "const": "Observational comparison only; no causal uplift or profitability claim. Human review required."
          }
        },
        "required": [
          "rule_id",
          "rule_version",
          "proposal",
          "input_refs",
          "limitations"
        ]
      }
    },
    "advertising_account_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "next_cursor": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2048
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "contract_version",
    "source_id",
    "source_sha256",
    "identity_verification",
    "currency",
    "timezone",
    "selection",
    "complete",
    "rows",
    "totals",
    "gaps",
    "suggestions",
    "advertising_account_id",
    "next_cursor"
  ]
}

Erros e repetições seguras

Confira o status HTTP e o corpo da resposta. Um erro de validação 400 pode conter ZodError; erros do handler usam os campos error, message e code. Guarde request_id ou x-request-id para diagnóstico, sem credenciais. Corrija erros de acesso 401/403 antes de tentar novamente e siga Retry-After para 429. Se uma gravação for incerta ou retornar 5xx, consulte primeiro o resultado existente. Reutilize uma chave de idempotência somente quando houver suporte; o comportamento de repetição varia por operação e não garante entrega exatamente uma vez.

Guia de solução de problemas

Exemplos

Estes exemplos usam valores fictícios verificados conforme os schemas. Substitua os IDs por aqueles que você tem autorização para usar, a mídia por ativos prontos e as datas pelo horário de publicação confirmado. Confira a elegibilidade da conta antes de enviar uma gravação. Esta página não envia requisições de API.

Defina SOSOAPI_ACCESS_TOKEN no servidor como uma credencial aceita por esta operação e mantenha-a fora do código do navegador. Para agentes de IA, use sosoapi auth login para entrar pelo navegador e deixe a CLI renovar suas credenciais.

request.json

{
  "workspace_id": "11111111-1111-4111-8111-111111111111",
  "advertising_account_id": "11111111-1111-4111-8111-111111111111",
  "level": "campaign",
  "start_date": "2099-01-15",
  "end_date": "2099-01-15",
  "action_attribution_windows": [
    "1d_click"
  ],
  "action_report_time": "impression",
  "conversion_action_type": "example",
  "revenue_action_type": "example"
}

cURL

curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/advertising-api/insights/query" \
  -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

JavaScript

// Server-side JavaScript. Do not print tokens or credential-bearing responses.
const token = process.env.SOSOAPI_ACCESS_TOKEN;
if (!token) throw new Error("Set an accepted credential for this operation");
const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/advertising-api/insights/query", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
  body: JSON.stringify({
  "workspace_id": "11111111-1111-4111-8111-111111111111",
  "advertising_account_id": "11111111-1111-4111-8111-111111111111",
  "level": "campaign",
  "start_date": "2099-01-15",
  "end_date": "2099-01-15",
  "action_attribution_windows": [
    "1d_click"
  ],
  "action_report_time": "impression",
  "conversion_action_type": "example",
  "revenue_action_type": "example"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.

CLI

npx sosoapi api post /advertising-api/insights/query < request.json

Exemplo de resposta sintética

{
  "contract_version": "ad-performance/v1",
  "source_id": "example",
  "source_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "identity_verification": "customer_supplied",
  "currency": "USD",
  "timezone": "UTC",
  "selection": {
    "provider_api_version": "v26.0",
    "provider_account_id": "12345",
    "currency": "USD",
    "timezone": "UTC",
    "level": "campaign",
    "start_date": "2099-01-15",
    "end_date": "2099-01-15",
    "action_attribution_windows": [
      "1d_click"
    ],
    "action_report_time": "impression",
    "conversion_action_type": "example",
    "revenue_action_type": "example"
  },
  "complete": false,
  "rows": [],
  "totals": {
    "spend": {
      "value": null,
      "unit": "currency",
      "availability": "available",
      "reason": null,
      "input_refs": []
    },
    "clicks": {
      "value": null,
      "unit": "currency",
      "availability": "available",
      "reason": null,
      "input_refs": []
    },
    "conversions": {
      "value": null,
      "unit": "currency",
      "availability": "available",
      "reason": null,
      "input_refs": []
    },
    "attributed_revenue": {
      "value": null,
      "unit": "currency",
      "availability": "available",
      "reason": null,
      "input_refs": []
    },
    "cpc": {
      "value": null,
      "unit": "currency",
      "availability": "available",
      "reason": null,
      "input_refs": []
    },
    "cpa": {
      "value": null,
      "unit": "currency",
      "availability": "available",
      "reason": null,
      "input_refs": []
    },
    "attributed_roas": {
      "value": null,
      "unit": "currency",
      "availability": "available",
      "reason": null,
      "input_refs": []
    }
  },
  "gaps": [],
  "suggestions": [],
  "advertising_account_id": "11111111-1111-4111-8111-111111111111",
  "next_cursor": null
}

MCP: sosoapi_ads_insights_query

Todas as operações da APIAutenticação e permissões