{ "openapi": "3.1.0", "info": { "title": "MessGEO API", "version": "1.0.0", "description": "Public API of MessGEO. See https://docs.messgeo.com" }, "servers": [ { "url": "https://api.messgeo.com" } ], "components": { "securitySchemes": { "bearer": { "type": "http", "scheme": "bearer" } }, "schemas": { "Envelope": { "type": "object", "properties": { "data": {}, "meta": { "type": "object", "properties": { "request_id": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] } } } } }, "Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "fields": { "type": "array", "items": { "type": "string" } }, "reason": { "type": "string" }, "remaining": { "type": "integer" } }, "required": [ "code", "message" ] } } } } }, "paths": { "/v1/me": { "get": { "tags": [ "account" ], "summary": "Account, package, key scopes and limits", "x-summary": { "en": "Account, package, key scopes and limits", "tr": "Hesap, paket, anahtar yetkileri ve sınırlar", "pt": "Conta, pacote, âmbitos da chave e limites" }, "x-scope": "account:read", "security": [ { "bearer": [] } ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/me/credits": { "get": { "tags": [ "account" ], "summary": "Credit balance", "x-summary": { "en": "Credit balance", "tr": "Kredi bakiyesi", "pt": "Saldo de créditos" }, "x-scope": "account:read", "security": [ { "bearer": [] } ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/me/usage": { "get": { "tags": [ "account" ], "summary": "Daily usage of the account", "x-summary": { "en": "Daily usage of the account", "tr": "Hesabın günlük kullanımı", "pt": "Utilização diária da conta" }, "x-scope": "account:read", "security": [ { "bearer": [] } ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/me/alert-prefs": { "patch": { "tags": [ "account" ], "summary": "Update Prompt Tracking mail preferences", "x-summary": { "en": "Update Prompt Tracking mail preferences", "tr": "Prompt Takibi mail tercihlerini günceller", "pt": "Atualiza as preferências de email do Monitorização de Prompts" }, "x-scope": "account:write", "security": [ { "bearer": [] } ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-body": { "digest": false, "dry_run": false }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "digest": false, "dry_run": false } } } } } }, "/v1/tools": { "get": { "tags": [ "tools" ], "summary": "List tools with credit cost", "x-summary": { "en": "List tools with credit cost", "tr": "Araçları kredi bedeliyle listeler", "pt": "Lista ferramentas com o custo em créditos" }, "x-scope": "account:read", "security": [ { "bearer": [] } ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/tools/{slug}/runs": { "post": { "tags": [ "tools" ], "summary": "Run a tool. Needs an Idempotency-Key header, spends credits", "x-summary": { "en": "Run a tool. Needs an Idempotency-Key header, spends credits", "tr": "Aracı çalıştırır. Idempotency-Key başlığı ister, kredi harcar", "pt": "Executa uma ferramenta. Exige o cabeçalho Idempotency-Key, gasta créditos" }, "x-scope": "tools:run", "security": [ { "bearer": [] } ], "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-body": { "url": "https://example.com/", "dry_run": false }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "url": "https://example.com/", "dry_run": false } } } } } }, "/v1/runs": { "get": { "tags": [ "tools" ], "summary": "List runs", "x-summary": { "en": "List runs", "tr": "Çalıştırmaları listeler", "pt": "Lista execuções" }, "x-scope": "tools:read", "security": [ { "bearer": [] } ], "parameters": [ { "name": "tool", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "target", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/runs/{run_id}": { "get": { "tags": [ "tools" ], "summary": "Get a run", "x-summary": { "en": "Get a run", "tr": "Çalıştırma sonucunu döndürür", "pt": "Devolve uma execução" }, "x-scope": "tools:read", "security": [ { "bearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/orders": { "get": { "tags": [ "orders" ], "summary": "List premium report orders", "x-summary": { "en": "List premium report orders", "tr": "Premium rapor siparişlerini listeler", "pt": "Lista encomendas de relatórios premium" }, "x-scope": "tools:orders", "security": [ { "bearer": [] } ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/orders/{order_id}": { "get": { "tags": [ "orders" ], "summary": "Get an order", "x-summary": { "en": "Get an order", "tr": "Siparişi döndürür", "pt": "Devolve uma encomenda" }, "x-scope": "tools:orders", "security": [ { "bearer": [] } ], "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/orders/{order_id}/report": { "get": { "tags": [ "orders" ], "summary": "Delivered report as HTML", "x-summary": { "en": "Delivered report as HTML", "tr": "Teslim edilen raporu HTML olarak döndürür", "pt": "Relatório entregue em HTML" }, "x-scope": "tools:orders", "security": [ { "bearer": [] } ], "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/panels": { "get": { "tags": [ "pt" ], "summary": "List panels", "x-summary": { "en": "List panels", "tr": "Panelleri listeler", "pt": "Lista painéis" }, "x-scope": "pt:read", "security": [ { "bearer": [] } ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "ptw" ], "summary": "Create a panel on a free Pro package. Returns a draft", "x-summary": { "en": "Create a panel on a free Pro package. Returns a draft", "tr": "Boş Pro paketinde panel oluşturur, taslak döndürür", "pt": "Cria um painel num pacote Pro livre e devolve um rascunho" }, "x-scope": "pt:write", "security": [ { "bearer": [] } ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-pro": true, "x-body": { "brand": "Acme Ltd", "website": "https://example.com/", "competitors": [ "Rival One" ], "country": "pt", "language": "en", "dry_run": true }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "brand": "Acme Ltd", "website": "https://example.com/", "competitors": [ "Rival One" ], "country": "pt", "language": "en", "dry_run": true } } } } } }, "/v1/panels/{panel_id}": { "get": { "tags": [ "pt" ], "summary": "Get a panel", "x-summary": { "en": "Get a panel", "tr": "Paneli döndürür", "pt": "Devolve um painel" }, "x-scope": "pt:read", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "ptw" ], "summary": "Change country, language and engines. Removing an engine deletes its data and needs confirm true", "x-summary": { "en": "Change country, language and engines. Removing an engine deletes its data and needs confirm true", "tr": "Ülke, dil ve motorları değiştirir. Motor kaldırmak verisini siler, confirm true ister", "pt": "Altera país, idioma e motores. Remover um motor apaga os dados e exige confirm true" }, "x-scope": "pt:write", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-pro": true, "x-body": { "country": "tr", "language": "tr", "engines": [ "chatgpt", "gemini" ], "confirm": false, "dry_run": true }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "country": "tr", "language": "tr", "engines": [ "chatgpt", "gemini" ], "confirm": false, "dry_run": true } } } } }, "delete": { "tags": [ "ptw" ], "summary": "Delete a panel and its data. Needs confirm true", "x-summary": { "en": "Delete a panel and its data. Needs confirm true", "tr": "Paneli ve verisini siler. confirm true ister", "pt": "Apaga um painel e os dados. Exige confirm true" }, "x-scope": "pt:write", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-pro": true, "x-body": { "confirm": true, "dry_run": true }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "confirm": true, "dry_run": true } } } } } }, "/v1/panels/{panel_id}/prompts": { "get": { "tags": [ "pt" ], "summary": "List prompts", "x-summary": { "en": "List prompts", "tr": "Promptları listeler", "pt": "Lista prompts" }, "x-scope": "pt:read", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "active", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "topic", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "ptw" ], "summary": "Add prompts, at most 20 per call", "x-summary": { "en": "Add prompts, at most 20 per call", "tr": "Prompt ekler, çağrı başına en çok 20", "pt": "Adiciona prompts, no máximo 20 por chamada" }, "x-scope": "pt:write", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-pro": true, "x-body": { "prompts": [ { "text": "best ai visibility tools for agencies", "topic": "tools", "tags": [ "agency" ], "category": "compare", "critical": false } ], "dry_run": true }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "prompts": [ { "text": "best ai visibility tools for agencies", "topic": "tools", "tags": [ "agency" ], "category": "compare", "critical": false } ], "dry_run": true } } } } }, "patch": { "tags": [ "ptw" ], "summary": "Turn up to 150 prompts on or off", "x-summary": { "en": "Turn up to 150 prompts on or off", "tr": "En çok 150 promptu açar ya da kapatır", "pt": "Ativa ou desativa até 150 prompts" }, "x-scope": "pt:write", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-pro": true, "x-body": { "ids": [ "promptid0000" ], "active": false, "dry_run": true }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "ids": [ "promptid0000" ], "active": false, "dry_run": true } } } } } }, "/v1/panels/{panel_id}/prompts/{prompt_id}/results": { "get": { "tags": [ "pt" ], "summary": "Per engine results of one prompt", "x-summary": { "en": "Per engine results of one prompt", "tr": "Bir promptun motor bazında sonuçları", "pt": "Resultados por motor de um prompt" }, "x-scope": "pt:read", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "prompt_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runs", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/panels/{panel_id}/stats": { "get": { "tags": [ "pt" ], "summary": "Visibility per measurement", "x-summary": { "en": "Visibility per measurement", "tr": "Ölçüm başına görünürlük", "pt": "Visibilidade por medição" }, "x-scope": "pt:read", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runs", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/panels/{panel_id}/answers": { "get": { "tags": [ "pt" ], "summary": "AI answers. Starter gets excerpts in bulk, full text with prompt filter", "x-summary": { "en": "AI answers. Starter gets excerpts in bulk, full text with prompt filter", "tr": "Yapay zeka cevapları. Başlangıç pakette toplu listede özet, prompt süzgeciyle tam metin", "pt": "Respostas de IA. O Starter recebe excertos em lista e texto completo com filtro de prompt" }, "x-scope": "pt:read", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "prompt", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "engine", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/panels/{panel_id}/sources": { "get": { "tags": [ "pt" ], "summary": "Cited sources", "x-summary": { "en": "Cited sources", "tr": "Alıntılanan kaynaklar", "pt": "Fontes citadas" }, "x-scope": "pt:read", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/panels/{panel_id}/competitors": { "get": { "tags": [ "pt" ], "summary": "Competitors", "x-summary": { "en": "Competitors", "tr": "Rakipler", "pt": "Concorrentes" }, "x-scope": "pt:read", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "ptw" ], "summary": "Add a competitor", "x-summary": { "en": "Add a competitor", "tr": "Rakip ekler", "pt": "Adiciona um concorrente" }, "x-scope": "pt:write", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-pro": true, "x-body": { "name": "Example Ltd", "domain": "example.com", "aliases": [ "Example" ], "dry_run": true }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "name": "Example Ltd", "domain": "example.com", "aliases": [ "Example" ], "dry_run": true } } } } } }, "/v1/panels/{panel_id}/opportunities": { "get": { "tags": [ "pt" ], "summary": "Source opportunities", "x-summary": { "en": "Source opportunities", "tr": "Kaynak fırsatları", "pt": "Oportunidades de fontes" }, "x-scope": "pt:read", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/panels/{panel_id}/alerts": { "get": { "tags": [ "pt" ], "summary": "Alerts", "x-summary": { "en": "Alerts", "tr": "Uyarılar", "pt": "Alertas" }, "x-scope": "pt:read", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/panels/{panel_id}/events": { "get": { "tags": [ "pt" ], "summary": "Panel events", "x-summary": { "en": "Panel events", "tr": "Panel olayları", "pt": "Eventos do painel" }, "x-scope": "pt:read", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/panels/{panel_id}/actions": { "get": { "tags": [ "pt" ], "summary": "Actions", "x-summary": { "en": "Actions", "tr": "Aksiyonlar", "pt": "Ações" }, "x-scope": "pt:read", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "ptw" ], "summary": "Add an action from a recommendation card", "x-summary": { "en": "Add an action from a recommendation card", "tr": "Öneri kartından aksiyon ekler", "pt": "Adiciona uma ação a partir de uma recomendação" }, "x-scope": "pt:write", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-pro": true, "x-body": { "key": "invisible_prompts", "status": "todo", "due": "2026-12-01", "remind": true }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "key": "invisible_prompts", "status": "todo", "due": "2026-12-01", "remind": true } } } } } }, "/v1/panels/{panel_id}/export": { "get": { "tags": [ "pt" ], "summary": "CSV export, once per minute per key", "x-summary": { "en": "CSV export, once per minute per key", "tr": "CSV dışa aktarma, anahtar başına dakikada bir", "pt": "Exportação CSV, uma vez por minuto por chave" }, "x-scope": "pt:read", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tab", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/panels/{panel_id}/prompts/{prompt_id}": { "patch": { "tags": [ "ptw" ], "summary": "Update a prompt. The text cannot change", "x-summary": { "en": "Update a prompt. The text cannot change", "tr": "Promptu günceller. Metin değişmez", "pt": "Atualiza um prompt. O texto não muda" }, "x-scope": "pt:write", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "prompt_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-pro": true, "x-body": { "active": true, "topic": "tools", "tags": [ "agency" ], "category": "buy", "critical": true }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "active": true, "topic": "tools", "tags": [ "agency" ], "category": "buy", "critical": true } } } } }, "delete": { "tags": [ "ptw" ], "summary": "Turn a prompt off. History stays", "x-summary": { "en": "Turn a prompt off. History stays", "tr": "Promptu kapatır. Geçmiş kalır", "pt": "Desativa um prompt. O histórico mantém-se" }, "x-scope": "pt:write", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "prompt_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-pro": true } }, "/v1/panels/{panel_id}/competitors/{competitor_id}": { "delete": { "tags": [ "ptw" ], "summary": "Remove a competitor. Needs confirm true", "x-summary": { "en": "Remove a competitor. Needs confirm true", "tr": "Rakibi kaldırır. confirm true ister", "pt": "Remove um concorrente. Exige confirm true" }, "x-scope": "pt:write", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "competitor_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-pro": true, "x-body": { "confirm": true }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "confirm": true } } } } } }, "/v1/panels/{panel_id}/aliases": { "put": { "tags": [ "ptw" ], "summary": "Replace extra brand names, at most 10", "x-summary": { "en": "Replace extra brand names, at most 10", "tr": "Ek marka adlarını değiştirir, en çok 10", "pt": "Substitui os nomes adicionais da marca, no máximo 10" }, "x-scope": "pt:write", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-pro": true, "x-body": { "aliases": [ "Former Name", "second-domain.com" ] }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "aliases": [ "Former Name", "second-domain.com" ] } } } } } }, "/v1/panels/{panel_id}/actions/{action_id}/done": { "post": { "tags": [ "ptw" ], "summary": "Mark an action done", "x-summary": { "en": "Mark an action done", "tr": "Aksiyonu yapıldı olarak işaretler", "pt": "Marca uma ação como concluída" }, "x-scope": "pt:write", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "action_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-pro": true } }, "/v1/panels/{panel_id}/actions/{action_id}/undo": { "post": { "tags": [ "ptw" ], "summary": "Remove an action", "x-summary": { "en": "Remove an action", "tr": "Aksiyonu kaldırır", "pt": "Remove uma ação" }, "x-scope": "pt:write", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "action_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-pro": true } }, "/v1/panels/{panel_id}/opportunities/mark": { "post": { "tags": [ "ptw" ], "summary": "Mark an opportunity", "x-summary": { "en": "Mark an opportunity", "tr": "Fırsatı işaretler", "pt": "Marca uma oportunidade" }, "x-scope": "pt:write", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-pro": true, "x-body": { "url": "https://forum.example/thread/1", "state": "added" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "url": "https://forum.example/thread/1", "state": "added" } } } } } }, "/v1/me/packages": { "get": { "tags": [ "account" ], "summary": "Packages, which panel and site each one is bound to, free slots", "x-summary": { "en": "Packages, which panel and site each one is bound to, free slots", "tr": "Paketler, her birinin bağlı olduğu panel ve site, boş haklar", "pt": "Pacotes, painel e site de cada um, lugares livres" }, "x-scope": "account:read", "security": [ { "bearer": [] } ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/panels/{panel_id}/setup": { "get": { "tags": [ "pt" ], "summary": "Setup state of a draft panel with prompt candidates", "x-summary": { "en": "Setup state of a draft panel with prompt candidates", "tr": "Taslak panelin kurulum durumu ve aday promptlar", "pt": "Estado de configuração de um rascunho com prompts candidatos" }, "x-scope": "pt:read", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "ptw" ], "summary": "Edit a draft panel", "x-summary": { "en": "Edit a draft panel", "tr": "Taslak paneli düzenler", "pt": "Edita um rascunho" }, "x-scope": "pt:write", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-pro": true, "x-body": { "description": "What the business does.", "services": [ "Service" ], "sector": "Software", "competitors": [ { "name": "Rival One", "aliases": [ "Rival" ] } ], "aliases": [ "Former Name" ] }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "description": "What the business does.", "services": [ "Service" ], "sector": "Software", "competitors": [ { "name": "Rival One", "aliases": [ "Rival" ] } ], "aliases": [ "Former Name" ] } } } } } }, "/v1/panels/{panel_id}/prompts/metrics": { "get": { "tags": [ "pt" ], "summary": "Rank, first place rate and sentiment per prompt", "x-summary": { "en": "Rank, first place rate and sentiment per prompt", "tr": "Prompt başına sıra, birincilik ve duygu", "pt": "Posição, primeiro lugar e sentimento por prompt" }, "x-scope": "pt:read", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/panels/{panel_id}/market": { "get": { "tags": [ "pt" ], "summary": "Market map", "x-summary": { "en": "Market map", "tr": "Pazar haritası", "pt": "Mapa do mercado" }, "x-scope": "pt:read", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/panels/{panel_id}/brand": { "get": { "tags": [ "pt" ], "summary": "Brand image and site check", "x-summary": { "en": "Brand image and site check", "tr": "Marka imajı ve site uyum denetimi", "pt": "Imagem da marca e verificação do site" }, "x-scope": "pt:read", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/panels/{panel_id}/insights": { "get": { "tags": [ "pt" ], "summary": "Recommendation cards and focus prompts", "x-summary": { "en": "Recommendation cards and focus prompts", "tr": "Öneri kartları ve odak promptlar", "pt": "Recomendações e prompts em foco" }, "x-scope": "pt:read", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/panels/{panel_id}/engines": { "get": { "tags": [ "pt" ], "summary": "Feature rates per engine", "x-summary": { "en": "Feature rates per engine", "tr": "Motor başına özellik oranları", "pt": "Taxas de funcionalidades por motor" }, "x-scope": "pt:read", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/panels/{panel_id}/sources/gaps": { "get": { "tags": [ "pt" ], "summary": "Sources that cite rivals but not you", "x-summary": { "en": "Sources that cite rivals but not you", "tr": "Rakipleri alıntılayıp sizi alıntılamayan kaynaklar", "pt": "Fontes que citam rivais mas não a sua marca" }, "x-scope": "pt:read", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/panels/{panel_id}/gsc": { "get": { "tags": [ "pt" ], "summary": "Search Console queries", "x-summary": { "en": "Search Console queries", "tr": "Search Console sorguları", "pt": "Consultas do Search Console" }, "x-scope": "pt:read", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/panels/{panel_id}/ga4": { "get": { "tags": [ "pt" ], "summary": "Visits from AI assistants", "x-summary": { "en": "Visits from AI assistants", "tr": "Yapay zeka asistanlarından gelen ziyaretler", "pt": "Visitas de assistentes de IA" }, "x-scope": "pt:read", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/panels/{panel_id}/integrations": { "get": { "tags": [ "pt" ], "summary": "Integration status and connect address", "x-summary": { "en": "Integration status and connect address", "tr": "Bağlantı durumu ve bağlama adresi", "pt": "Estado das integrações e endereço de ligação" }, "x-scope": "pt:read", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/panels/{panel_id}/shares": { "get": { "tags": [ "pt" ], "summary": "Share links", "x-summary": { "en": "Share links", "tr": "Takip bağlantıları", "pt": "Ligações de partilha" }, "x-scope": "pt:read", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "ptw" ], "summary": "Create a password protected share link", "x-summary": { "en": "Create a password protected share link", "tr": "Şifreli takip bağlantısı oluşturur", "pt": "Cria uma ligação protegida" }, "x-scope": "pt:write", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-pro": true, "x-body": { "label": "Agency", "password": "at-least-8-chars", "sections": [ "kpi", "rivals" ] }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "label": "Agency", "password": "at-least-8-chars", "sections": [ "kpi", "rivals" ] } } } } } }, "/v1/panels/{panel_id}/setup/topics": { "post": { "tags": [ "ptw" ], "summary": "Add a topic to a draft, generates prompt candidates", "x-summary": { "en": "Add a topic to a draft, generates prompt candidates", "tr": "Taslağa konu ekler, aday prompt üretir", "pt": "Adiciona um tópico e gera prompts candidatos" }, "x-scope": "pt:write", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-pro": true, "x-body": { "topic": "Pricing" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "topic": "Pricing" } } } } } }, "/v1/panels/{panel_id}/setup/approve": { "post": { "tags": [ "ptw" ], "summary": "Activate the panel and start the first measurement. Needs confirm true", "x-summary": { "en": "Activate the panel and start the first measurement. Needs confirm true", "tr": "Paneli açar ve ilk ölçümü başlatır. confirm true ister", "pt": "Ativa o painel e inicia a primeira medição. Exige confirm true" }, "x-scope": "pt:write", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-pro": true, "x-body": { "prompt_ids": [ "promptid0000" ], "critical_ids": [], "extra": [ "another prompt" ], "engines": [ "chatgpt" ], "confirm": true }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "prompt_ids": [ "promptid0000" ], "critical_ids": [], "extra": [ "another prompt" ], "engines": [ "chatgpt" ], "confirm": true } } } } } }, "/v1/panels/{panel_id}/pause": { "post": { "tags": [ "ptw" ], "summary": "Pause measurements", "x-summary": { "en": "Pause measurements", "tr": "Ölçümleri duraklatır", "pt": "Pausa as medições" }, "x-scope": "pt:write", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-pro": true } }, "/v1/panels/{panel_id}/resume": { "post": { "tags": [ "ptw" ], "summary": "Resume measurements", "x-summary": { "en": "Resume measurements", "tr": "Ölçümleri sürdürür", "pt": "Retoma as medições" }, "x-scope": "pt:write", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-pro": true } }, "/v1/panels/{panel_id}/actions/{action_id}": { "patch": { "tags": [ "ptw" ], "summary": "Change the due date", "x-summary": { "en": "Change the due date", "tr": "Tarihi değiştirir", "pt": "Altera a data" }, "x-scope": "pt:write", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "action_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-pro": true, "x-body": { "due": "2026-12-15" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "due": "2026-12-15" } } } } } }, "/v1/panels/{panel_id}/market/hide": { "post": { "tags": [ "ptw" ], "summary": "Hide or show a name on the market map", "x-summary": { "en": "Hide or show a name on the market map", "tr": "Pazar haritasında adı gizler ya da gösterir", "pt": "Oculta ou mostra um nome no mapa" }, "x-scope": "pt:write", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-pro": true, "x-body": { "name": "Example", "undo": false }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "name": "Example", "undo": false } } } } } }, "/v1/panels/{panel_id}/brand/confirm": { "post": { "tags": [ "ptw" ], "summary": "Confirm a site check item", "x-summary": { "en": "Confirm a site check item", "tr": "Site uyum maddesini onaylar", "pt": "Confirma um item da verificação" }, "x-scope": "pt:write", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-pro": true, "x-body": { "id": "0000000000000000000000000000000000000000" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "0000000000000000000000000000000000000000" } } } } } }, "/v1/panels/{panel_id}/shares/{share_id}": { "delete": { "tags": [ "ptw" ], "summary": "Revoke a share link. Needs confirm true", "x-summary": { "en": "Revoke a share link. Needs confirm true", "tr": "Bağlantıyı iptal eder. confirm true ister", "pt": "Revoga uma ligação. Exige confirm true" }, "x-scope": "pt:write", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "share_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-pro": true, "x-body": { "confirm": true }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "confirm": true } } } } } }, "/v1/panels/{panel_id}/integrations/{service}/sync": { "post": { "tags": [ "ptw" ], "summary": "Refresh gsc or ga4 data", "x-summary": { "en": "Refresh gsc or ga4 data", "tr": "gsc ya da ga4 verisini tazeler", "pt": "Atualiza dados gsc ou ga4" }, "x-scope": "pt:write", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "service", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-pro": true } }, "/v1/panels/{panel_id}/integrations/{service}/disconnect": { "post": { "tags": [ "ptw" ], "summary": "Disconnect gsc or ga4. Needs confirm true", "x-summary": { "en": "Disconnect gsc or ga4. Needs confirm true", "tr": "gsc ya da ga4 bağlantısını keser. confirm true ister", "pt": "Desliga gsc ou ga4. Exige confirm true" }, "x-scope": "pt:write", "security": [ { "bearer": [] } ], "parameters": [ { "name": "panel_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "service", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-pro": true, "x-body": { "confirm": true }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "confirm": true } } } } } } } }