Referência da API

Conta, pacote, âmbitos da chave e limites

Saldo de créditos

Utilização diária da conta

Atualiza as preferências de email do Monitorização de Prompts

{
    "digest": false,
    "dry_run": false
}

Pacotes, painel e site de cada um, lugares livres

Lista ferramentas com o custo em créditos

Executa uma ferramenta. Exige o cabeçalho Idempotency-Key, gasta créditos

{
    "url": "https://example.com/",
    "dry_run": false
}

Lista execuções

Consulta: tool status since until target limit cursor

Devolve uma execução

Lista encomendas de relatórios premium

Devolve uma encomenda

Relatório entregue em HTML

Lista painéis

Devolve um painel

Lista prompts

Consulta: active topic

Resultados por motor de um prompt

Consulta: runs from to

Visibilidade por medição

Consulta: runs from to

Respostas de IA. O Starter recebe excertos em lista e texto completo com filtro de prompt

Consulta: prompt engine limit cursor

Fontes citadas

Concorrentes

Oportunidades de fontes

Alertas

Eventos do painel

Ações

Exportação CSV, uma vez por minuto por chave

Consulta: tab format

Estado de configuração de um rascunho com prompts candidatos

Posição, primeiro lugar e sentimento por prompt

Mapa do mercado

Imagem da marca e verificação do site

Recomendações e prompts em foco

Taxas de funcionalidades por motor

Fontes que citam rivais mas não a sua marca

Consultas do Search Console

Consulta: sort

Visitas de assistentes de IA

Estado das integrações e endereço de ligação

Ligações de partilha

Cria um painel num pacote Pro livre e devolve um rascunho

{
    "brand": "Acme Ltd",
    "website": "https://example.com/",
    "competitors": [
        "Rival One"
    ],
    "country": "pt",
    "language": "en",
    "dry_run": true
}

Altera país, idioma e motores. Remover um motor apaga os dados e exige confirm true

{
    "country": "tr",
    "language": "tr",
    "engines": [
        "chatgpt",
        "gemini"
    ],
    "confirm": false,
    "dry_run": true
}

Apaga um painel e os dados. Exige confirm true

{
    "confirm": true,
    "dry_run": true
}

Adiciona prompts, no máximo 20 por chamada

{
    "prompts": [
        {
            "text": "best ai visibility tools for agencies",
            "topic": "tools",
            "tags": [
                "agency"
            ],
            "category": "compare",
            "critical": false
        }
    ],
    "dry_run": true
}

Ativa ou desativa até 150 prompts

{
    "ids": [
        "promptid0000"
    ],
    "active": false,
    "dry_run": true
}

Adiciona um concorrente

{
    "name": "Example Ltd",
    "domain": "example.com",
    "aliases": [
        "Example"
    ],
    "dry_run": true
}

Adiciona uma ação a partir de uma recomendação

{
    "key": "invisible_prompts",
    "status": "todo",
    "due": "2026-12-01",
    "remind": true
}

Atualiza um prompt. O texto não muda

{
    "active": true,
    "topic": "tools",
    "tags": [
        "agency"
    ],
    "category": "buy",
    "critical": true
}

Desativa um prompt. O histórico mantém-se

Remove um concorrente. Exige confirm true

{
    "confirm": true
}

Substitui os nomes adicionais da marca, no máximo 10

{
    "aliases": [
        "Former Name",
        "second-domain.com"
    ]
}

Marca uma ação como concluída

Remove uma ação

Marca uma oportunidade

{
    "url": "https://forum.example/thread/1",
    "state": "added"
}

Edita um rascunho

{
    "description": "What the business does.",
    "services": [
        "Service"
    ],
    "sector": "Software",
    "competitors": [
        {
            "name": "Rival One",
            "aliases": [
                "Rival"
            ]
        }
    ],
    "aliases": [
        "Former Name"
    ]
}

Cria uma ligação protegida

{
    "label": "Agency",
    "password": "at-least-8-chars",
    "sections": [
        "kpi",
        "rivals"
    ]
}

Adiciona um tópico e gera prompts candidatos

{
    "topic": "Pricing"
}

Ativa o painel e inicia a primeira medição. Exige confirm true

{
    "prompt_ids": [
        "promptid0000"
    ],
    "critical_ids": [],
    "extra": [
        "another prompt"
    ],
    "engines": [
        "chatgpt"
    ],
    "confirm": true
}

Pausa as medições

Retoma as medições

Altera a data

{
    "due": "2026-12-15"
}

Oculta ou mostra um nome no mapa

{
    "name": "Example",
    "undo": false
}

Confirma um item da verificação

{
    "id": "0000000000000000000000000000000000000000"
}

Revoga uma ligação. Exige confirm true

{
    "confirm": true
}

Atualiza dados gsc ou ga4

Desliga gsc ou ga4. Exige confirm true

{
    "confirm": true
}