{ "openapi": "3.1.0", "info": { "title": "Telegram Ads owned connections and hosted reads", "version": "0.1.0" }, "paths": { "/health": { "get": { "security": [], "responses": { "200": { "description": "Process liveness" } } } }, "/v1/connections": { "get": { "security": [ { "personalBearer": [] } ], "x-required-scopes": ["connections:read"], "responses": { "200": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionList" } } } }, "400": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "security": [ { "personalBearer": [] } ], "x-required-scopes": ["connections:write"], "responses": { "201": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionView" } } } }, "400": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConnection" } } } } } }, "/v1/connections/{id}": { "get": { "security": [ { "personalBearer": [] } ], "x-required-scopes": ["connections:read"], "responses": { "200": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionView" } } } }, "400": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] }, "delete": { "security": [ { "personalBearer": [] } ], "x-required-scopes": ["connections:write"], "responses": { "200": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionView" } } } }, "400": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisconnectConnection" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/v1/connections/{id}/credentials": { "put": { "security": [ { "personalBearer": [] } ], "x-required-scopes": ["connections:write"], "responses": { "200": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionView" } } } }, "400": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceCredentials" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/v1/connections/{id}/check": { "post": { "security": [ { "personalBearer": [] } ], "x-required-scopes": ["connections:read"], "responses": { "200": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionView" } } } }, "400": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Validated response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/v1/connections/{id}/api/accounts": { "get": { "operationId": "listAccounts", "security": [ { "personalBearer": [] } ], "responses": { "200": { "description": "Accessible accounts", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Operation forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource or data not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Request conflicts with current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request body exceeds limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Upstream rejected the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rate or concurrency limit reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Session credentials or browser unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "x-required-scopes": ["ads:read"] } }, "/v1/connections/{id}/api/accounts/{accountId}/ads": { "get": { "operationId": "listAds", "security": [ { "personalBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" } }, { "name": "cursor", "in": "query", "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" } } ], "responses": { "200": { "description": "Ads page", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdsPage" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Operation forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource or data not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Request conflicts with current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request body exceeds limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Upstream rejected the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rate or concurrency limit reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Session credentials or browser unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-required-scopes": ["ads:read"] } }, "/v1/connections/{id}/api/accounts/{accountId}/ads/{adId}": { "get": { "operationId": "getAd", "security": [ { "personalBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" } }, { "name": "adId", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Ad details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdDetails" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Operation forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource or data not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Request conflicts with current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request body exceeds limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Upstream rejected the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rate or concurrency limit reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Session credentials or browser unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-required-scopes": ["ads:read"] } }, "/v1/connections/{id}/api/accounts/{accountId}/budget": { "get": { "operationId": "getBudget", "security": [ { "personalBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" } } ], "responses": { "200": { "description": "Account budget and transactions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Budget" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Operation forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource or data not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Request conflicts with current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request body exceeds limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Upstream rejected the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rate or concurrency limit reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Session credentials or browser unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-required-scopes": ["ads:read"] } }, "/v1/connections/{id}/api/accounts/{accountId}/targets": { "get": { "operationId": "searchTarget", "security": [ { "personalBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" } }, { "name": "kind", "in": "query", "required": true, "schema": { "type": "string", "enum": ["channel", "bot", "query"] } }, { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 } } ], "responses": { "200": { "description": "Resolved target", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetResult" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Operation forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource or data not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Request conflicts with current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request body exceeds limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Upstream rejected the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rate or concurrency limit reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Session credentials or browser unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-required-scopes": ["ads:read"] } }, "/v1/connections/{id}/api/accounts/{accountId}/similar-channels": { "get": { "operationId": "getSimilarChannels", "security": [ { "personalBearer": [] } ], "description": "Recommendations for 1–9 distinct selected channel IDs. An empty result does not verify seed validity.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" } }, { "name": "channelIds", "in": "query", "required": true, "description": "1–9 distinct opaque IDs separated by semicolons; each ID is at most 256 characters.", "schema": { "type": "string", "minLength": 1, "maxLength": 2312, "pattern": "^[A-Za-z0-9_-]{1,256}(;[A-Za-z0-9_-]{1,256}){0,8}$" } }, { "name": "for", "in": "query", "schema": { "type": "string", "enum": ["channels", "exclude_channels"], "default": "channels" } } ], "responses": { "200": { "description": "Similar channel candidates", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimilarTargets" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Operation forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource or data not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Request conflicts with current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request body exceeds limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Upstream rejected the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rate or concurrency limit reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Session credentials or browser unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-required-scopes": ["ads:read"] } }, "/v1/connections/{id}/api/accounts/{accountId}/similar-bots": { "get": { "operationId": "getSimilarBots", "security": [ { "personalBearer": [] } ], "description": "Recommendations for 1–9 distinct selected bot IDs. An empty result does not verify seed validity.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" } }, { "name": "botIds", "in": "query", "required": true, "description": "1–9 distinct opaque IDs separated by semicolons; each ID is at most 256 characters.", "schema": { "type": "string", "minLength": 1, "maxLength": 2312, "pattern": "^[A-Za-z0-9_-]{1,256}(;[A-Za-z0-9_-]{1,256}){0,8}$" } } ], "responses": { "200": { "description": "Similar bot candidates", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimilarTargets" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Operation forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource or data not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Request conflicts with current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request body exceeds limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Upstream rejected the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rate or concurrency limit reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Session credentials or browser unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-required-scopes": ["ads:read"] } }, "/v1/connections/{id}/api/accounts/{accountId}/locations": { "get": { "operationId": "searchLocations", "security": [ { "personalBearer": [] } ], "description": "One page of location candidates for a country and one query character. This is not full-string search; # is empirical broad discovery, without geographic completeness guarantees. Region is a display label, not a parent ID; coordinates are not supplied.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" } }, { "name": "country", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[A-Z]{2}$" } }, { "name": "query", "in": "query", "required": true, "description": "Exactly one non-whitespace Unicode character; # is allowed.", "schema": { "type": "string", "minLength": 1, "maxLength": 1, "pattern": "^\\S$" } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "default": 0 } } ], "responses": { "200": { "description": "Location candidate page", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationPage" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Operation forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource or data not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Request conflicts with current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request body exceeds limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Upstream rejected the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rate or concurrency limit reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Session credentials or browser unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-required-scopes": ["ads:read"] } }, "/v1/connections/{id}/api/accounts/{accountId}/targeting-options": { "get": { "operationId": "getTargetingOptions", "security": [ { "personalBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" } } ], "responses": { "200": { "description": "Available targeting options and limits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetingOptions" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Operation forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource or data not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Request conflicts with current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request body exceeds limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Upstream rejected the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rate or concurrency limit reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Session credentials or browser unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-required-scopes": ["ads:read"] } }, "/v1/connections/{id}/api/accounts/{accountId}/stats": { "get": { "operationId": "getAccountStats", "security": [ { "personalBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" } }, { "name": "period", "in": "query", "schema": { "type": "string", "enum": ["day", "5min"] } }, { "name": "month", "in": "query", "schema": { "type": "string", "pattern": "^20\\d{2}(0[1-9]|1[0-2])$" } } ], "responses": { "200": { "description": "Account statistics", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Stats" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Operation forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource or data not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Request conflicts with current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request body exceeds limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Upstream rejected the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rate or concurrency limit reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Session credentials or browser unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-required-scopes": ["ads:read"] } }, "/v1/connections/{id}/api/accounts/{accountId}/ads/{adId}/stats": { "get": { "operationId": "getAdStats", "security": [ { "personalBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" } }, { "name": "adId", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "period", "in": "query", "schema": { "type": "string", "enum": ["day", "5min"] } }, { "name": "month", "in": "query", "schema": { "type": "string", "pattern": "^20\\d{2}(0[1-9]|1[0-2])$" } } ], "responses": { "200": { "description": "Ad statistics", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Stats" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Operation forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource or data not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Request conflicts with current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request body exceeds limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Upstream rejected the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rate or concurrency limit reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Session credentials or browser unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-required-scopes": ["ads:read"] } }, "/v1/connections/{id}/api/accounts/{accountId}/report": { "get": { "operationId": "getAccountMonthlyReport", "security": [ { "personalBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" } }, { "name": "month", "in": "query", "schema": { "type": "string", "pattern": "^20\\d{2}(0[1-9]|1[0-2])$" }, "required": true } ], "responses": { "200": { "description": "Parsed monthly account report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonthlyReport" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Operation forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource or data not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Request conflicts with current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request body exceeds limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Upstream rejected the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rate or concurrency limit reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Session credentials or browser unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-required-scopes": ["ads:read"] } }, "/v1/connections/{id}/api/accounts/{accountId}/ads/{adId}/report": { "get": { "operationId": "getAdMonthlyReport", "security": [ { "personalBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" } }, { "name": "adId", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "month", "in": "query", "schema": { "type": "string", "pattern": "^20\\d{2}(0[1-9]|1[0-2])$" }, "required": true } ], "responses": { "200": { "description": "Parsed monthly ad report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonthlyReport" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Operation forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource or data not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Request conflicts with current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request body exceeds limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Upstream rejected the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rate or concurrency limit reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Session credentials or browser unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-required-scopes": ["ads:read"] } }, "/v1/connections/{id}/api/accounts/{accountId}/stats.csv": { "get": { "operationId": "getAccountStatsCsv", "security": [ { "personalBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" } }, { "name": "kind", "in": "query", "required": true, "schema": { "enum": ["count", "budget"] } }, { "name": "period", "in": "query", "schema": { "type": "string", "enum": ["day", "5min"] } }, { "name": "month", "in": "query", "schema": { "type": "string", "pattern": "^20\\d{2}(0[1-9]|1[0-2])$" } } ], "responses": { "200": { "description": "CSV data", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Operation forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource or data not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Request conflicts with current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request body exceeds limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Upstream rejected the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rate or concurrency limit reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Session credentials or browser unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-required-scopes": ["ads:read"] } }, "/v1/connections/{id}/api/accounts/{accountId}/ads/{adId}/stats.csv": { "get": { "operationId": "getAdStatsCsv", "security": [ { "personalBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" } }, { "name": "adId", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "kind", "in": "query", "required": true, "schema": { "enum": ["count", "budget"] } }, { "name": "period", "in": "query", "schema": { "type": "string", "enum": ["day", "5min"] } }, { "name": "month", "in": "query", "schema": { "type": "string", "pattern": "^20\\d{2}(0[1-9]|1[0-2])$" } } ], "responses": { "200": { "description": "CSV data", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Operation forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource or data not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Request conflicts with current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request body exceeds limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Upstream rejected the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rate or concurrency limit reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Session credentials or browser unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-required-scopes": ["ads:read"] } }, "/v1/connections/{id}/api/accounts/{accountId}/report.csv": { "get": { "operationId": "getAccountReport", "security": [ { "personalBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" } }, { "name": "month", "in": "query", "schema": { "type": "string", "pattern": "^20\\d{2}(0[1-9]|1[0-2])$" }, "required": true } ], "responses": { "200": { "description": "CSV data", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Operation forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource or data not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Request conflicts with current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request body exceeds limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Upstream rejected the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rate or concurrency limit reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Session credentials or browser unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-required-scopes": ["ads:read"] } }, "/v1/connections/{id}/api/accounts/{accountId}/ads/{adId}/report.csv": { "get": { "operationId": "getAdReport", "security": [ { "personalBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" } }, { "name": "adId", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "month", "in": "query", "schema": { "type": "string", "pattern": "^20\\d{2}(0[1-9]|1[0-2])$" }, "required": true } ], "responses": { "200": { "description": "CSV data", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Operation forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource or data not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Request conflicts with current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request body exceeds limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Upstream rejected the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rate or concurrency limit reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Session credentials or browser unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-required-scopes": ["ads:read"] } }, "/v1/connections/{id}/api/accounts/{accountId}/ad-preview": { "post": { "operationId": "checkAdPost", "description": "Validate and preview text-only channel-post advertising without creating, saving or editing an ad. POST keeps ad text out of the query string; the read credential is sufficient. Empty or malformed promotion URLs may return an invalid result.", "security": [ { "personalBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdPreviewInput" } } } }, "responses": { "200": { "description": "Ad post validation result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdPreviewResult" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Operation forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource or data not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Request conflicts with current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request body exceeds limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Upstream rejected the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rate or concurrency limit reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Session credentials or browser unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-required-scopes": ["ads:read"] } }, "/v1/connections/{id}/mcp": { "post": { "security": [ { "personalBearer": [] } ], "x-required-scopes": ["mcp:read", "ads:read"], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "description": "Stateless Streamable HTTP MCP with personal bearer authentication. Automatic OAuth discovery is not provided.", "responses": { "200": { "description": "MCP JSON-RPC response" }, "202": { "description": "MCP notification accepted" } } } } }, "components": { "securitySchemes": { "personalBearer": { "type": "http", "scheme": "bearer", "description": "Operator-provisioned personal token; not OAuth" } }, "schemas": { "Health": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "status": { "type": "string", "const": "ok" }, "revision": { "type": "string" } }, "required": ["status", "revision"], "additionalProperties": false }, "Ready": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "status": { "type": "string", "const": "ready" } }, "required": ["status"], "additionalProperties": false }, "Account": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "id": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" }, "name": { "type": "string", "minLength": 1 } }, "required": ["id", "name"], "additionalProperties": false }, "Accounts": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" }, "name": { "type": "string", "minLength": 1 } }, "required": ["id", "name"], "additionalProperties": false } }, "Ad": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ad_id": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "title": { "type": "string" }, "text": { "type": "string" }, "trg_type": { "type": "string" }, "views": { "type": "number", "minimum": 0 }, "opens": { "type": ["number", "null"] }, "clicks": { "type": ["number", "null"] }, "actions": { "type": ["number", "null"] }, "action": { "type": "string" }, "date": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "ctr": { "type": ["number", "null"] }, "cvr": { "type": ["number", "null"] }, "cpm": { "type": "number" }, "budget": { "type": "number" }, "spent": { "type": "number" }, "cpc": { "type": ["number", "null"] }, "cpa": { "type": ["number", "null"] }, "daily_budget": { "type": ["number", "null"] }, "daily_spent": { "type": ["number", "null"] }, "target": { "type": "string" }, "tme_path": { "type": "string" }, "status": { "type": "string" } }, "required": [ "ad_id", "title", "text", "trg_type", "views", "opens", "clicks", "actions", "action", "date", "ctr", "cvr", "cpm", "budget", "spent", "cpc", "cpa", "daily_budget", "daily_spent", "target", "tme_path", "status" ], "additionalProperties": false }, "AdsPage": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "ad_id": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "title": { "type": "string" }, "text": { "type": "string" }, "trg_type": { "type": "string" }, "views": { "type": "number", "minimum": 0 }, "opens": { "type": ["number", "null"] }, "clicks": { "type": ["number", "null"] }, "actions": { "type": ["number", "null"] }, "action": { "type": "string" }, "date": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "ctr": { "type": ["number", "null"] }, "cvr": { "type": ["number", "null"] }, "cpm": { "type": "number" }, "budget": { "type": "number" }, "spent": { "type": "number" }, "cpc": { "type": ["number", "null"] }, "cpa": { "type": ["number", "null"] }, "daily_budget": { "type": ["number", "null"] }, "daily_spent": { "type": ["number", "null"] }, "target": { "type": "string" }, "tme_path": { "type": "string" }, "status": { "type": "string" } }, "required": [ "ad_id", "title", "text", "trg_type", "views", "opens", "clicks", "actions", "action", "date", "ctr", "cvr", "cpm", "budget", "spent", "cpc", "cpa", "daily_budget", "daily_spent", "target", "tme_path", "status" ], "additionalProperties": false } }, "nextCursor": { "anyOf": [ { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" }, { "type": "null" } ] } }, "required": ["items", "nextCursor"], "additionalProperties": false }, "AdDetails": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "accountId": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" }, "adId": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "fields": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "text": { "type": "string" }, "promote_url": { "type": "string" }, "button": { "type": "string" }, "website_name": { "type": "string" }, "ad_info": { "type": "string" }, "cpm": { "type": "string" }, "budget": { "type": "string" }, "daily_budget": { "type": "string" }, "active": { "type": "string" }, "views_per_user": { "type": "string" }, "target_type": { "type": "string" }, "placement": { "type": "string" }, "device": { "type": "string" }, "channels": { "type": "string" }, "bots": { "type": "string" }, "langs": { "type": "string" }, "topics": { "type": "string" }, "exclude_topics": { "type": "string" }, "exclude_channels": { "type": "string" }, "countries": { "type": "string" }, "locations": { "type": "string" }, "target_query": { "type": "string" }, "user_langs": { "type": "string" }, "user_topics": { "type": "string" }, "exclude_user_topics": { "type": "string" }, "user_channels": { "type": "string" }, "exclude_user_channels": { "type": "string" }, "search_queries": { "type": "string" }, "schedule": { "type": "string" }, "schedule_tz": { "type": "string" }, "schedule_tz_custom": { "type": "string" }, "use_schedule": { "type": "string" }, "ad_activate_date": { "type": "string" }, "ad_activate_time": { "type": "string" }, "ad_deactivate_date": { "type": "string" }, "ad_deactivate_time": { "type": "string" } }, "required": ["title"], "additionalProperties": false }, "targeting": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": ["channel", "bot"] }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 } }, "required": ["kind", "id", "name"], "additionalProperties": false } }, "creative": { "type": "object", "properties": { "text": { "type": "string" }, "buttonText": { "type": "string" }, "destinationUrl": { "type": "string" }, "hasMedia": { "type": "boolean" } }, "required": ["text", "hasMedia"], "additionalProperties": false } }, "required": ["accountId", "adId", "fields", "targeting"], "additionalProperties": false }, "Budget": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "accountId": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" }, "balance": { "type": "string", "pattern": "^-?\\d+(?:\\.\\d+)?$" }, "displayDecimals": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "transactions": { "type": "array", "items": { "type": "array", "items": { "type": "string" } }, "description": "Legacy visible transaction cells; monetary semantics are not inferred." }, "transactionTable": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "string" } }, "rows": { "type": "array", "items": { "type": "object", "properties": { "cells": { "type": "array", "items": { "type": "string" } } }, "required": ["cells"], "additionalProperties": false } } }, "required": ["columns", "rows"], "additionalProperties": false, "description": "Visible labels and cell text in display order; not a typed financial ledger." } }, "required": [ "accountId", "balance", "displayDecimals", "transactions", "transactionTable" ], "additionalProperties": false }, "Stats": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "accountId": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" }, "adId": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "period": { "type": "string", "enum": ["day", "5min"] }, "timezone": { "type": "string", "const": "UTC" }, "status": { "type": "string", "enum": ["available", "empty"] }, "graphs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "timestamps": { "type": "array", "items": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "series": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "values": { "type": "array", "items": { "type": ["number", "null"] } } }, "required": ["id", "name", "values"], "additionalProperties": false } }, "unit": { "type": ["string", "null"] }, "scale": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["id", "timestamps", "series", "unit", "scale"], "additionalProperties": false } } }, "required": ["accountId", "period", "timezone", "status", "graphs"], "additionalProperties": false }, "TargetResult": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "kind": { "type": "string", "enum": ["channel", "bot", "query"] }, "target": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "username": { "type": "string" }, "photo": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } }, "required": ["kind", "target"], "additionalProperties": false }, "TargetingOptions": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "accountId": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" }, "languages": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } }, "topics": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } }, "countries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } }, "userTopics": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } }, "limits": { "type": "object", "properties": { "channels": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "bots": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "searchQueries": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "textLength": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["channels", "bots", "searchQueries", "textLength"], "additionalProperties": false } }, "required": [ "accountId", "languages", "topics", "countries", "userTopics", "limits" ], "additionalProperties": false }, "Error": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "required": ["error"], "additionalProperties": false }, "MonthlyReport": { "$schema": "https://json-schema.org/draft/2020-12/schema", "oneOf": [ { "type": "object", "properties": { "month": { "type": "string", "pattern": "^20\\d{2}(0[1-9]|1[0-2])$" }, "currency": { "type": "string", "minLength": 1 }, "total": { "type": "object", "properties": { "views": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "amount": { "type": "string", "pattern": "^\\d+(?:\\.\\d+)?$" } }, "required": ["views", "amount"], "additionalProperties": false }, "scope": { "type": "string", "const": "account" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "views": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "amount": { "type": "string", "pattern": "^\\d+(?:\\.\\d+)?$" }, "adId": { "type": "string", "pattern": "^AD\\d+$" }, "title": { "type": "string" } }, "required": ["views", "amount", "adId", "title"], "additionalProperties": false } } }, "required": ["month", "currency", "total", "scope", "rows"], "additionalProperties": false }, { "type": "object", "properties": { "month": { "type": "string", "pattern": "^20\\d{2}(0[1-9]|1[0-2])$" }, "currency": { "type": "string", "minLength": 1 }, "total": { "type": "object", "properties": { "views": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "amount": { "type": "string", "pattern": "^\\d+(?:\\.\\d+)?$" } }, "required": ["views", "amount"], "additionalProperties": false }, "scope": { "type": "string", "const": "ad" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "views": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "amount": { "type": "string", "pattern": "^\\d+(?:\\.\\d+)?$" }, "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": ["views", "amount", "date"], "additionalProperties": false } } }, "required": ["month", "currency", "total", "scope", "rows"], "additionalProperties": false } ] }, "SimilarTargets": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "accountId": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" }, "kind": { "type": "string", "enum": ["channel", "bot"] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "username": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } } }, "required": ["accountId", "kind", "items"], "additionalProperties": false }, "LocationPage": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "accountId": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" }, "country": { "type": "string", "pattern": "^[A-Z]{2}$" }, "query": { "type": "string", "pattern": "^\\S$" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" }, "country": { "type": "string", "pattern": "^[A-Z]{2}$" }, "region": { "type": "string" } }, "required": ["id", "name", "country"], "additionalProperties": false } }, "nextOffset": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": ["accountId", "country", "query", "items", "nextOffset"], "additionalProperties": false }, "AdPreviewInput": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "text": { "type": "string", "maxLength": 4096 }, "promoteUrl": { "type": "string", "maxLength": 2048 }, "channelIds": { "minItems": 1, "maxItems": 9, "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" } } }, "required": ["text", "promoteUrl"], "additionalProperties": false }, "AdPreviewResult": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "accountId": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" }, "result": { "oneOf": [ { "type": "object", "properties": { "status": { "type": "string", "const": "ready", "description": "Preview generated; this does not guarantee createAd acceptance or moderation approval." }, "promoteUrl": { "type": "string", "maxLength": 2048, "pattern": "^(?:https:\\/\\/)?t\\.me\\/[A-Za-z0-9_+/?=&%.-]+$" }, "preview": { "type": "object", "properties": { "from": { "type": "string" }, "description": { "type": "string" }, "text": { "type": "string" }, "buttonText": { "type": "string" }, "destinationUrl": { "type": "string", "maxLength": 2048, "pattern": "^(?:https:\\/\\/)?t\\.me\\/[A-Za-z0-9_+/?=&%.-]+$" }, "hasPhoto": { "type": "boolean" }, "hasMedia": { "type": "boolean" }, "picture": { "type": "boolean" } }, "required": [ "from", "description", "text", "buttonText", "destinationUrl", "hasPhoto", "hasMedia", "picture" ], "additionalProperties": false }, "exclusionSuggestion": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } }, "required": ["status", "promoteUrl", "preview"], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "invalid" }, "field": { "type": "string", "enum": ["text", "promoteUrl", "channelIds"] } }, "required": ["status", "field"], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "pending", "description": "Telegram requested a later preview check. Source-observed behavior with synthetic coverage; no live pending sample yet. No automatic retry." } }, "required": ["status"], "additionalProperties": false } ] } }, "required": ["accountId", "result"], "additionalProperties": false }, "CreateTestAd": { "type": "object", "additionalProperties": false, "required": ["requestId", "title", "text", "promoteUrl", "channelIds"], "properties": { "requestId": { "type": "string", "format": "uuid" }, "title": { "type": "string", "minLength": 1, "maxLength": 45 }, "text": { "type": "string", "minLength": 1, "maxLength": 160 }, "promoteUrl": { "type": "string", "pattern": "^(?:https://)?t\\.me/" }, "channelIds": { "type": "array", "minItems": 1, "maxItems": 100, "items": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" } } } }, "RenameTestAd": { "type": "object", "additionalProperties": false, "required": ["title"], "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 45 } } }, "CreatedTestAd": { "type": "object", "additionalProperties": false, "required": ["accountId", "adId", "title", "requestId"], "properties": { "accountId": { "type": "string" }, "adId": { "type": "integer", "minimum": 1 }, "title": { "type": "string" }, "requestId": { "type": "string", "format": "uuid" } } }, "ConnectionView": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "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)$" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": ["active", "expired", "disconnected"] }, "accounts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" }, "name": { "type": "string", "minLength": 1 } }, "required": ["id", "name"], "additionalProperties": false } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "lastCheckedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "name", "version", "status", "accounts", "createdAt", "updatedAt", "lastCheckedAt" ], "additionalProperties": false }, "ConnectionList": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "connections": { "type": "array", "items": { "type": "object", "properties": { "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)$" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": ["active", "expired", "disconnected"] }, "accounts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,256}$" }, "name": { "type": "string", "minLength": 1 } }, "required": ["id", "name"], "additionalProperties": false } }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "lastCheckedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "name", "version", "status", "accounts", "createdAt", "updatedAt", "lastCheckedAt" ], "additionalProperties": false } } }, "required": ["connections"], "additionalProperties": false }, "CreateConnection": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "cookies": { "type": "object", "properties": { "stel_token": { "type": "string", "minLength": 1, "maxLength": 4096, "pattern": "^[\\x21\\x23-\\x2B\\x2D-\\x3A\\x3C-\\x5B\\x5D-\\x7E]+$" }, "stel_adowner": { "type": "string", "minLength": 1, "maxLength": 4096, "pattern": "^[\\x21\\x23-\\x2B\\x2D-\\x3A\\x3C-\\x5B\\x5D-\\x7E]+$" } }, "required": ["stel_token", "stel_adowner"], "additionalProperties": false } }, "required": ["name", "cookies"], "additionalProperties": false }, "ReplaceCredentials": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "cookies": { "type": "object", "properties": { "stel_token": { "type": "string", "minLength": 1, "maxLength": 4096, "pattern": "^[\\x21\\x23-\\x2B\\x2D-\\x3A\\x3C-\\x5B\\x5D-\\x7E]+$" }, "stel_adowner": { "type": "string", "minLength": 1, "maxLength": 4096, "pattern": "^[\\x21\\x23-\\x2B\\x2D-\\x3A\\x3C-\\x5B\\x5D-\\x7E]+$" } }, "required": ["stel_token", "stel_adowner"], "additionalProperties": false } }, "required": ["version", "cookies"], "additionalProperties": false }, "DisconnectConnection": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["version"], "additionalProperties": false } } } }