{
  "info": {
    "name": "IzeAds API",
    "description": "API REST para gestão de anúncios na IzeAds: métricas, campanhas, trackers, cloakers, biblioteca de criativos e ingestão de conversões.\n\nA autenticação é feita por chave de API no header `Authorization`. As permissões de cada chave são definidas por escopos. Gere e gerencie suas chaves no painel, em **Integrações → API**.",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "auth": {
    "type": "bearer",
    "bearer": [
      {
        "key": "token",
        "value": "{{token}}",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://api.izeads.com/api/partner/v1",
      "type": "string"
    },
    {
      "key": "token",
      "value": "izeads_live_xxxx",
      "type": "string"
    }
  ],
  "item": [
    {
      "name": "Métricas",
      "item": [
        {
          "name": "Indicadores da conta",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/metrics",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "metrics"
              ],
              "query": [
                {
                  "key": "period",
                  "value": "",
                  "description": "Período de referência.",
                  "disabled": true
                }
              ]
            },
            "description": "Retorna os indicadores agregados da conta no período — investimento, ROAS, faturamento, vendas e leads — já com conversão de moeda. Correspondem aos números exibidos no painel."
          }
        },
        {
          "name": "Listar campanhas",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/campaigns",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "campaigns"
              ],
              "query": [
                {
                  "key": "accountIds",
                  "value": "",
                  "description": "IDs de conta separados por vírgula (ex.: act_123,act_456).",
                  "disabled": true
                },
                {
                  "key": "datePreset",
                  "value": "",
                  "description": "Período de referência (ex.: last_30d).",
                  "disabled": true
                },
                {
                  "key": "status",
                  "value": "",
                  "description": "Filtro de status (ex.: ACTIVE, PAUSED).",
                  "disabled": true
                }
              ]
            },
            "description": "Lista as campanhas com suas métricas no período. Pode ser filtrada por contas e status."
          }
        },
        {
          "name": "Detalhar campanha",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/campaigns/{campaignId}",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "campaigns",
                "{campaignId}"
              ],
              "query": [
                {
                  "key": "datePreset",
                  "value": "",
                  "description": "Período de referência.",
                  "disabled": true
                }
              ]
            },
            "description": "Retorna os detalhes e as métricas de uma campanha específica."
          }
        },
        {
          "name": "Listar conjuntos de anúncios",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/adsets",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "adsets"
              ],
              "query": [
                {
                  "key": "accountIds",
                  "value": "",
                  "description": "IDs de conta separados por vírgula.",
                  "disabled": true
                },
                {
                  "key": "campaignIds",
                  "value": "",
                  "description": "IDs de campanha separados por vírgula.",
                  "disabled": true
                },
                {
                  "key": "datePreset",
                  "value": "",
                  "description": "Período de referência.",
                  "disabled": true
                },
                {
                  "key": "status",
                  "value": "",
                  "description": "Filtro de status.",
                  "disabled": true
                }
              ]
            },
            "description": "Lista os conjuntos de anúncios com suas métricas. Pode ser filtrada por contas e campanhas."
          }
        },
        {
          "name": "Listar anúncios",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/ads",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "ads"
              ],
              "query": [
                {
                  "key": "accountIds",
                  "value": "",
                  "description": "IDs de conta separados por vírgula.",
                  "disabled": true
                },
                {
                  "key": "campaignIds",
                  "value": "",
                  "description": "IDs de campanha separados por vírgula.",
                  "disabled": true
                },
                {
                  "key": "adsetIds",
                  "value": "",
                  "description": "IDs de conjunto separados por vírgula.",
                  "disabled": true
                },
                {
                  "key": "datePreset",
                  "value": "",
                  "description": "Período de referência.",
                  "disabled": true
                }
              ]
            },
            "description": "Lista os anúncios com suas métricas. Pode ser filtrada por contas, campanhas e conjuntos."
          }
        },
        {
          "name": "Status das contas de anúncio",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/accounts/status",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "accounts",
                "status"
              ],
              "query": [
                {
                  "key": "scope",
                  "value": "",
                  "description": "`monitored`: apenas as contas monitoradas. `all`: todas as contas (cada uma com o campo `monitored`).",
                  "disabled": true
                }
              ]
            },
            "description": "Retorna a situação das contas de anúncio (ativa, com problema, limites de gasto)."
          }
        }
      ]
    },
    {
      "name": "Campanhas",
      "item": [
        {
          "name": "Criar campanha",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/campaigns/batch",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "campaigns",
                "batch"
              ]
            },
            "description": "Cria uma ou mais campanhas na conta de anúncios informada. O processamento é assíncrono: a resposta retorna um `jobId`, que pode ser consultado em `GET /campaigns/job/{jobId}` para acompanhar o progresso.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"accountId\": \"act_945665201591231\",\n  \"pageId\": \"900083133197256\",\n  \"campaigns\": [\n    {\n      \"name\": \"Campanha de Tráfego\",\n      \"objective\": \"OUTCOME_TRAFFIC\",\n      \"status\": \"PAUSED\",\n      \"budgetLevel\": \"campaign\",\n      \"budgetType\": \"daily_budget\",\n      \"dailyBudget\": 5000,\n      \"adSets\": [\n        {\n          \"name\": \"Conjunto\",\n          \"billingEvent\": \"IMPRESSIONS\",\n          \"optimizationGoal\": \"LINK_CLICKS\",\n          \"targeting\": {\n            \"geo_locations\": {\n              \"countries\": [\n                \"BR\"\n              ]\n            }\n          },\n          \"ads\": [\n            {\n              \"name\": \"Anúncio\",\n              \"status\": \"PAUSED\",\n              \"creative\": {\n                \"type\": \"image\",\n                \"mediaUrl\": \"https://cdn.exemplo.com/img.png\",\n                \"primaryText\": \"Texto do anúncio\",\n                \"headline\": \"Título\",\n                \"link\": \"https://site.com\",\n                \"callToAction\": \"LEARN_MORE\"\n              }\n            }\n          ]\n        }\n      ]\n    }\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Consultar job de criação",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/campaigns/job/{jobId}",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "campaigns",
                "job",
                "{jobId}"
              ]
            },
            "description": "Retorna o progresso de uma solicitação de criação de campanha."
          }
        },
        {
          "name": "Dados de edição da campanha",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/campaigns/{id}/edit-data",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "campaigns",
                "{id}",
                "edit-data"
              ]
            },
            "description": "Retorna a estrutura editável da campanha (campos que podem ser alterados)."
          }
        },
        {
          "name": "Editar campanha",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/campaigns/{id}",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "campaigns",
                "{id}"
              ]
            },
            "description": "Aplica alterações em uma campanha existente.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Novo nome da campanha\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Alterar veiculação",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/toggle/{type}/{id}",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "toggle",
                "{type}",
                "{id}"
              ]
            },
            "description": "Altera o status de veiculação (`ACTIVE` ou `PAUSED`) de uma campanha, conjunto de anúncios ou anúncio.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"status\": \"PAUSED\",\n  \"accountId\": \"act_123456\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Alterar orçamento",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/budget/{type}/{id}",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "budget",
                "{type}",
                "{id}"
              ]
            },
            "description": "Atualiza o orçamento diário ou vitalício de uma campanha ou conjunto de anúncios. O valor é informado em centavos.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"budget\": 5000,\n  \"budgetType\": \"daily_budget\",\n  \"accountId\": \"act_123456\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        }
      ]
    },
    {
      "name": "Trackers",
      "item": [
        {
          "name": "Listar trackers",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/trackers",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "trackers"
              ]
            },
            "description": "Lista os trackers da conta (identificador, nome, token de webhook e URLs)."
          }
        },
        {
          "name": "Listar configurações de tracker",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/tracker/configs",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "tracker",
                "configs"
              ]
            },
            "description": "Lista as configurações de tracker da conta."
          }
        },
        {
          "name": "Criar tracker",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/tracker/configs",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "tracker",
                "configs"
              ]
            },
            "description": "Cria um tracker de site/pixel.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Meu tracker\",\n  \"domainId\": 1,\n  \"pixelIds\": [\n    \"123\"\n  ],\n  \"objective\": \"purchase\",\n  \"offerUrl\": \"https://oferta.com\",\n  \"trackingMode\": \"snippet\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Estatísticas dos trackers",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/tracker/stats-all",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "tracker",
                "stats-all"
              ],
              "query": [
                {
                  "key": "period",
                  "value": "",
                  "description": "Período de referência.",
                  "disabled": true
                }
              ]
            },
            "description": "Retorna as estatísticas de todos os trackers no período (eventos, vendas e receita por tracker)."
          }
        },
        {
          "name": "Listar domínios",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/tracker/domains",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "tracker",
                "domains"
              ]
            },
            "description": "Lista os domínios de rastreamento da conta e seus status."
          }
        }
      ]
    },
    {
      "name": "Cloaker",
      "item": [
        {
          "name": "Listar cloakers",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/cloaker/campaigns",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "cloaker",
                "campaigns"
              ]
            },
            "description": "Lista as campanhas de cloaker da conta."
          }
        },
        {
          "name": "Criar cloaker",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/cloaker/campaigns",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "cloaker",
                "campaigns"
              ]
            },
            "description": "Cria uma campanha de cloaker.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Cloaker - Oferta X\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Ativar/desativar cloaker",
          "request": {
            "method": "PUT",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/cloaker/campaigns/{id}/toggle",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "cloaker",
                "campaigns",
                "{id}",
                "toggle"
              ]
            },
            "description": "Alterna o status (ativo/inativo) de uma campanha de cloaker."
          }
        }
      ]
    },
    {
      "name": "Biblioteca",
      "item": [
        {
          "name": "Listar ofertas",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/offers",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "offers"
              ]
            },
            "description": "Lista as ofertas/produtos da conta."
          }
        },
        {
          "name": "Listar criativos",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/creatives",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "creatives"
              ]
            },
            "description": "Lista os criativos (imagens e vídeos) da biblioteca."
          }
        },
        {
          "name": "Listar pastas",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/creatives/folders",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "creatives",
                "folders"
              ]
            },
            "description": "Lista as pastas da biblioteca de criativos."
          }
        },
        {
          "name": "Criar pasta",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/creatives/folders",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "creatives",
                "folders"
              ]
            },
            "description": "Cria uma pasta na biblioteca de criativos.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Criativos IA\",\n  \"color\": \"#6366f1\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Adicionar criativo por URL",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/creatives/from-url",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "creatives",
                "from-url"
              ]
            },
            "description": "Importa uma imagem ou vídeo a partir de uma URL pública e o salva na biblioteca, opcionalmente dentro de uma pasta.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"url\": \"https://cdn.exemplo.com/img.png\",\n  \"name\": \"Meu criativo\",\n  \"folderId\": 40\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        }
      ]
    },
    {
      "name": "Conversões",
      "item": [
        {
          "name": "Registrar conversão",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/events",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "events"
              ]
            },
            "description": "Registra uma conversão na conta. A venda é atribuída à campanha de origem pelo `sck`/`src` ou pelos parâmetros UTM, e deduplicada por `transaction_id`. Requer o escopo `events:write`.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"event\": \"Purchase\",\n  \"transaction_id\": \"seu-id-unico\",\n  \"value\": 199.9,\n  \"currency\": \"BRL\",\n  \"sck\": \"sck_xxx\",\n  \"utm_campaign\": \"120200000012345\",\n  \"email\": \"cliente@exemplo.com\",\n  \"name\": \"João Silva\",\n  \"product_name\": \"Produto\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        }
      ]
    },
    {
      "name": "Agência",
      "item": [
        {
          "name": "Listar clientes",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/agency-clients",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "agency-clients"
              ]
            },
            "description": "Lista os clientes da agência. Disponível apenas para contas do tipo agência."
          }
        },
        {
          "name": "Ativos de um cliente",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/agency-clients/{id}/assets",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "agency-clients",
                "{id}",
                "assets"
              ]
            },
            "description": "Retorna os ativos de um cliente: contas de anúncio, BMs, páginas, pixels, trackers e cloakers."
          }
        }
      ]
    }
  ]
}