{ "openapi": "3.0.0", "info": { "title": "API", "version": "4.1.0" }, "paths": { "/app/analyze/g/audit": { "post": { "tags": [ "App/Analyze/GoogleAds/Audit" ], "operationId": "appAnalyzeGoogleAdsAuditQueue", "requestBody": { "required": false, "content": { "application/json": { "schema": { "required": [ "linkingId", "campaignId", "scope" ], "properties": { "linkingId": { "type": "integer" }, "campaignId": { "type": "integer" }, "scope": { "type": "string", "enum": [ "CAMPAIGN", "SEARCH_ADS", "SEARCH_KEYWORDS", "SEARCH_TERMS", "P_MAX" ] } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdSchema" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/audit/{auditId}": { "get": { "tags": [ "App/Analyze/GoogleAds/Audit" ], "operationId": "appAnalyzeGoogleAdsAuditView", "parameters": [ { "name": "auditId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppAnalyzeGoogleAdsAuditSchema" } }, "type": "object" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/health": { "post": { "tags": [ "App/Analyze/GoogleAds/Health" ], "operationId": "appAnalyzeGoogleAdsHealthAnalyze", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "linking_id" ], "properties": { "linking_id": { "type": "integer" }, "period_days": { "type": "integer", "default": 30, "enum": [ 30, 60, 90 ] }, "channel": { "type": "string", "default": "PERFORMANCE_MAX", "enum": [ "PERFORMANCE_MAX", "SEARCH", "DEMAND_GEN" ] } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppAnalyzeGoogleAdsHealthReportSchema" } }, "type": "object" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/optimization/search-terms": { "post": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationAnalyze", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "linking_id", "campaign_id" ], "properties": { "linking_id": { "type": "integer" }, "campaign_id": { "type": "integer" } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/optimization/pmax-center/{optimizationId}/dg-changes/{mode}": { "post": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationDemandGenChange", "parameters": [ { "name": "optimizationId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "mode", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "preview", "apply" ] } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "action" ], "properties": { "action": { "type": "string", "enum": [ "MODIFY_CHANNEL_CONTROLS", "MODIFY_OPTIMIZED_TARGETING", "MODIFY_AUDIENCE", "MODIFY_BUDGET", "MODIFY_BIDDING_TARGET", "PAUSE_AD", "FIX_CONVERSION_SETUP" ] }, "payload": { "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Preview (before / after / requirements / validate_only) or the applied change log" } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/optimization/pmax-center/{optimizationId}/dg-changes": { "get": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationDemandGenChangeLog", "parameters": [ { "name": "optimizationId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Changes Optimyzee made for this run, newest first" } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/optimization/pmax-center/{optimizationId}/dg-changes/{logId}/undo": { "post": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationDemandGenChangeUndo", "parameters": [ { "name": "optimizationId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "logId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "The undo, itself logged" } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/optimization/pmax-center/{optimizationId}/dg-creative-draft": { "post": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationDemandGenCreativeDraft", "parameters": [ { "name": "optimizationId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "ad_group_id" ], "properties": { "ad_group_id": { "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "properties": { "ad_group": { "type": "object" }, "source_ad": { "type": "object" }, "low_performing_assets": { "type": "array", "items": { "type": "object" } }, "draft": { "type": "object" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/optimization/pmax-center/{optimizationId}/dg-creative-images": { "post": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationDemandGenCreativeImage", "parameters": [ { "name": "optimizationId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "required": [ "kind", "image" ], "properties": { "kind": { "type": "string", "enum": [ "marketing", "square", "portrait", "logo" ] }, "image": { "description": "A file from the computer, or", "type": "string", "format": "binary" }, "asset_id": { "description": "an image asset already in the account", "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "The uploaded Google Ads image asset (id, kind, size)" } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/optimization/pmax-center/{optimizationId}/diagnosis": { "get": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationCenterDiagnosis", "parameters": [ { "name": "optimizationId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "properties": { "status": { "type": "string", "nullable": true }, "goal": { "type": "string" }, "goal_label": { "type": "string" }, "goal_source": { "type": "string" }, "user_context": { "type": "string", "nullable": true }, "context": { "type": "object", "nullable": true }, "search_terms_pending": { "type": "boolean" }, "diagnosed_at": { "type": "string", "nullable": true }, "diagnosis": { "type": "object", "nullable": true } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "token": [] } ] }, "post": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationCenterDiagnosisRefresh", "parameters": [ { "name": "optimizationId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Re-queued; same shape as the GET" } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/optimization/pmax-center/{optimizationId}/plan/{recommendationKey}/status": { "post": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationEngineRecommendationStatus", "parameters": [ { "name": "optimizationId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "recommendationKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "applied", "dismissed", "proposed" ] } }, "type": "object" } } } }, "responses": { "200": { "description": "The optimization plan payload" } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/optimization/pmax-center/{optimizationId}/plan/{recommendationKey}/steps/{stepKey}": { "post": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationEngineTaskStep", "parameters": [ { "name": "optimizationId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "recommendationKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "stepKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "outcome" ], "properties": { "outcome": { "type": "string", "enum": [ "completed", "skipped", "undo" ] }, "terms": { "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "responses": { "200": { "description": "The optimization plan payload" } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/optimization/pmax-center/{optimizationId}/keyword-fix-apply": { "post": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationKeywordFixApply", "parameters": [ { "name": "optimizationId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "keywords" ], "properties": { "keywords": { "type": "array", "items": { "properties": { "ad_group_id": { "type": "integer" }, "criterion_id": { "type": "integer" }, "action": { "type": "string", "enum": [ "keep", "investigate", "add_exact", "exact", "pause" ] }, "negatives": { "type": "array", "items": { "type": "string" } }, "override_reason": { "type": "string", "nullable": true } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Applied (all or nothing)" }, "422": { "description": "Refused — a destructive change to a proven keyword without an override" } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/optimization/pmax-center/{optimizationId}/keyword-fix-plan": { "post": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationKeywordFixPlan", "parameters": [ { "name": "optimizationId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "keywords" ], "properties": { "keywords": { "type": "array", "items": { "properties": { "ad_group_id": { "type": "integer" }, "criterion_id": { "type": "integer" } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "properties": { "campaign": { "type": "object" }, "period": { "type": "object" }, "keywords": { "type": "array", "items": { "type": "object" } } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/optimization/pmax-center/{optimizationId}/keyword-isolate": { "post": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationKeywordIsolate", "parameters": [ { "name": "optimizationId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "ad_group_id", "criterion_id", "final_url", "headlines", "descriptions" ], "properties": { "ad_group_id": { "type": "integer" }, "criterion_id": { "type": "integer" }, "ad_group_name": { "type": "string" }, "final_url": { "type": "string" }, "path1": { "type": "string" }, "path2": { "type": "string" }, "headlines": { "type": "array", "items": { "type": "string" } }, "descriptions": { "type": "array", "items": { "type": "string" } }, "override_reason": { "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "properties": { "ad_group_id": { "type": "integer", "nullable": true } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/optimization/search-terms/results/mark": { "post": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationMarkResult", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "analysis_id", "result_ids", "action" ], "properties": { "analysis_id": { "type": "integer" }, "result_ids": { "type": "array", "items": { "type": "integer" } }, "action": { "type": "string", "enum": [ "negative", "keyword", "observe", "brand", "competitor", "ok", "relevant" ] }, "optimized": { "type": "boolean", "example": false } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful" } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/optimization/p-max": { "post": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationPMaxAnalyze", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "linking_id", "campaign_id" ], "properties": { "linking_id": { "type": "integer" }, "campaign_id": { "type": "integer" } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/optimization/pmax-center/{optimizationId}/asset-draft": { "post": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationPMaxCenterAssetDraft", "parameters": [ { "name": "optimizationId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "asset_group_id" ], "properties": { "asset_group_id": { "type": "integer" }, "recommendation": { "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/optimization/pmax-center/{optimizationId}/channel-priority": { "get": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationPMaxCenterChannelPriority", "parameters": [ { "name": "optimizationId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "token": [] } ] }, "post": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationPMaxCenterChannelPriorityApply", "parameters": [ { "name": "optimizationId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/optimization/pmax-center/deep-audit": { "post": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationPMaxCenterDeepAudit", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "linking_id", "campaign_id" ], "properties": { "linking_id": { "type": "integer" }, "campaign_id": { "type": "integer" }, "run_audit": { "type": "boolean", "default": true }, "run_search_intent": { "type": "boolean", "default": true }, "health_period_days": { "type": "integer", "default": 30, "enum": [ 30, 60, 90 ] }, "channel": { "type": "string", "default": "PERFORMANCE_MAX", "enum": [ "PERFORMANCE_MAX", "SEARCH", "DEMAND_GEN" ] }, "audit_scope": { "properties": { "performance": { "type": "boolean" }, "assetGroups": { "type": "boolean" }, "products": { "type": "boolean" }, "searchIntent": { "type": "boolean" }, "settings": { "type": "boolean" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "required": [ "optimization_id", "audit_id", "search_intent_analysis_id" ], "properties": { "optimization_id": { "type": "integer" }, "audit_id": { "type": "integer", "nullable": true }, "search_intent_analysis_id": { "type": "integer", "nullable": true }, "rsa_build_analysis_id": { "type": "integer", "nullable": true } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/optimization/pmax-center-latest": { "get": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationPMaxCenterLatest", "parameters": [ { "name": "linking_id", "in": "query", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Latest Optimization Center run per campaign of the account", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/optimization/pmax-center/{optimizationId}/promotion-draft": { "get": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationPMaxCenterPromotionDraftLatest", "parameters": [ { "name": "optimizationId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "token": [] } ] }, "post": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationPMaxCenterPromotionDraft", "parameters": [ { "name": "optimizationId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "properties": { "recommendation": { "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/optimization/pmax-center/{optimizationId}/search-theme-suggestions": { "post": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationPMaxCenterSearchThemeSuggestions", "parameters": [ { "name": "optimizationId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "asset_group_id" ], "properties": { "asset_group_id": { "type": "integer" }, "seed_terms": { "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/optimization/pmax-center/{optimizationId}/start": { "post": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationPMaxCenterStart", "parameters": [ { "name": "optimizationId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "required": [ "started" ], "properties": { "started": { "type": "boolean" } }, "type": "object" } }, "type": "object" } } } }, "403": { "description": "Monthly action limit reached / unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/optimization/pmax-center/{optimizationId}": { "get": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationPMaxCenterView", "parameters": [ { "name": "optimizationId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "required": [ "id", "linking_id", "campaign_id", "health_period_days", "audit_scope", "audit_id", "search_intent_analysis_id" ], "properties": { "id": { "type": "integer" }, "linking_id": { "type": "integer" }, "linking_customer_id": { "type": "integer" }, "linking_name": { "type": "string" }, "campaign_id": { "type": "integer" }, "campaign_name": { "type": "string", "nullable": true }, "channel": { "type": "string", "enum": [ "PERFORMANCE_MAX", "SEARCH", "DEMAND_GEN" ] }, "health_period_days": { "type": "integer", "enum": [ 30, 60, 90 ] }, "audit_scope": { "type": "object" }, "audit_id": { "type": "integer", "nullable": true }, "search_intent_analysis_id": { "type": "integer", "nullable": true }, "rsa_build_analysis_id": { "type": "integer", "nullable": true }, "started": { "type": "boolean" }, "created_at": { "type": "string", "nullable": true }, "updated_at": { "type": "string", "nullable": true } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/optimization/p-max/results/mark": { "post": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationPMaxMarkResult", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "analysis_id", "result_ids", "action" ], "properties": { "analysis_id": { "type": "integer" }, "result_ids": { "type": "array", "items": { "type": "integer" } }, "action": { "type": "string", "enum": [ "negative", "keyword", "observe", "brand", "competitor", "ok", "relevant" ] }, "optimized": { "type": "boolean", "example": false } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful" } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/optimization/p-max/{id}": { "get": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationPMaxView", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/optimization/search-terms/{id}": { "get": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationView", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/optimization/optimized-history": { "get": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationHistory", "parameters": [ { "name": "linkingId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "campaignId", "in": "query", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/optimization/recommendations": { "get": { "tags": [ "App/Analyze/GoogleAds/Optimization" ], "operationId": "appAnalyzeGoogleAdsOptimizationRecommendations", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "linking", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "linkings", "in": "query", "description": "Comma-separated linking ids (project scope)", "required": false, "schema": { "type": "string" } }, { "name": "perPage", "in": "query", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/reporting/editor": { "post": { "tags": [ "App/Analyze/GoogleAds/Reporting" ], "operationId": "appAnalyzeGoogleAdsReportingEditor", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "linkingId" ], "properties": { "linkingId": { "type": "integer" }, "delete": { "type": "array", "items": { "required": [ "resource", "payload" ], "properties": { "resource": { "type": "string" }, "payload": { "type": "object" } }, "type": "object" }, "nullable": true }, "update": { "type": "array", "items": { "required": [ "resource", "payload" ], "properties": { "resource": { "type": "string" }, "payload": { "type": "object" } }, "type": "object" }, "nullable": true }, "create": { "type": "array", "items": { "required": [ "resource", "payload" ], "properties": { "resource": { "type": "string" }, "payload": { "type": "object" } }, "type": "object" }, "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppAnalyzeGoogleAdsReportingEditorResponseSchema" } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorListSchema" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/analyze/g/reporting/querier": { "post": { "tags": [ "App/Analyze/GoogleAds/Reporting" ], "operationId": "appAnalyzeGoogleAdsReportingQuerier", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "linkingId", "resource", "select" ], "properties": { "linkingId": { "type": "integer" }, "resource": { "type": "string" }, "select": { "type": "array", "items": { "type": "string" } }, "where": { "type": "array", "items": { "required": [ "column" ], "properties": { "column": { "type": "string" }, "operator": { "type": "string", "enum": [ "=", "!=", "<", "<=", ">", ">=", "LIKE", "IN", "NOT_IN", "DURING" ], "nullable": true }, "value": { "nullable": true, "oneOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "number" }, { "type": "array", "items": { "oneOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "number" } ] }, "nullable": true } ] }, "boolean": { "type": "string", "enum": [ "AND", "OR" ], "nullable": true } }, "type": "object" }, "nullable": true }, "sort": { "type": "array", "items": { "required": [ "column" ], "properties": { "column": { "type": "string" }, "direction": { "type": "string", "enum": [ "ASC", "DESC" ], "nullable": true } }, "type": "object" }, "nullable": true }, "limit": { "type": "integer", "nullable": true }, "perPage": { "type": "integer", "nullable": true }, "cursor": { "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "items", "perPage", "next" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AppAnalyzeGoogleAdsReportingRowSchema" } }, "perPage": { "type": "integer" }, "next": { "type": "string", "nullable": true } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorListSchema" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/auth/email/resend": { "post": { "tags": [ "App/Auth/Email" ], "operationId": "appAuthEmailResend", "responses": { "204": { "description": "Successful" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/auth/email": { "post": { "tags": [ "App/Auth/Email" ], "operationId": "appAuthEmailUpdate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/auth/email/verify": { "post": { "tags": [ "App/Auth/Email" ], "operationId": "appAuthEmailVerify", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "code" ], "properties": { "code": { "type": "string" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/auth/gateway/email": { "post": { "tags": [ "App/Auth/Gateway" ], "operationId": "appAuthGatewayEmail", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "email", "password" ], "properties": { "email": { "type": "string" }, "password": { "type": "string" }, "device": { "type": "string", "nullable": true }, "otp": { "type": "string", "nullable": true }, "otpRecoveryCode": { "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppAuthGatewayTokenSchema" } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "400": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/app/auth/gateway/emailSignup": { "post": { "tags": [ "App/Auth/Gateway" ], "operationId": "appAuthGatewayEmailSignup", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "email", "password" ], "properties": { "email": { "type": "string" }, "password": { "type": "string" }, "device": { "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppAuthGatewayTokenSchema" } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "400": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/app/auth/gateway/facebook": { "post": { "tags": [ "App/Auth/Gateway" ], "operationId": "appAuthGatewayFacebook", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "accessToken" ], "properties": { "accessToken": { "type": "string" }, "device": { "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppAuthGatewayTokenSchema" } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "400": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/app/auth/gateway/facebookSignup": { "post": { "tags": [ "App/Auth/Gateway" ], "operationId": "appAuthGatewayFacebookSignup", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "accessToken" ], "properties": { "accessToken": { "type": "string" }, "device": { "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppAuthGatewayTokenSchema" } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "400": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/app/auth/gateway/google": { "post": { "tags": [ "App/Auth/Gateway" ], "operationId": "appAuthGatewayGoogle", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "accessToken" ], "properties": { "accessToken": { "type": "string" }, "device": { "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppAuthGatewayTokenSchema" } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "400": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/app/auth/gateway/googleSignup": { "post": { "tags": [ "App/Auth/Gateway" ], "operationId": "appAuthGatewayGoogleSignup", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "accessToken" ], "properties": { "accessToken": { "type": "string" }, "device": { "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppAuthGatewayTokenSchema" } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "400": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/app/auth/gateway/refresh": { "post": { "tags": [ "App/Auth/Gateway" ], "operationId": "appAuthGatewayRefresh", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "device": { "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppAuthGatewayTokenSchema" } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/auth/gateway/revoke": { "post": { "tags": [ "App/Auth/Gateway" ], "operationId": "appAuthGatewayRevoke", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "device": { "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/auth/password/reset": { "post": { "tags": [ "App/Auth/Password" ], "operationId": "appAuthPasswordReset", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "email", "token", "password" ], "properties": { "email": { "type": "string" }, "token": { "type": "string" }, "password": { "type": "string" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/app/auth/password/sendResetLink": { "post": { "tags": [ "App/Auth/Password" ], "operationId": "appAuthPasswordSendResetLink", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "email" ], "properties": { "email": { "type": "string" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/app/auth/profile": { "get": { "tags": [ "App/Auth/Profile" ], "operationId": "appAuthProfile", "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppAuthProfileSchema" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] }, "put": { "tags": [ "App/Auth/Profile" ], "operationId": "appAuthProfileUpdate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [], "properties": { "name": { "type": "string", "nullable": true }, "position": { "type": "string", "nullable": true }, "spend": { "type": "string", "nullable": true }, "goal": { "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/auth/tfa/disable": { "post": { "tags": [ "App/Auth/Tfa" ], "operationId": "appAuthTfaDisable", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [], "properties": { "otp": { "type": "string", "nullable": true }, "otpRecoveryCode": { "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/auth/tfa/enable": { "post": { "tags": [ "App/Auth/Tfa" ], "operationId": "appAuthTfaEnable", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "otp" ], "properties": { "otp": { "type": "string" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/auth/tfa/issue": { "post": { "tags": [ "App/Auth/Tfa" ], "operationId": "appAuthTfaIssue", "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppAuthTfaCredentialsSchema" } }, "type": "object" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/auth/trustedDevice": { "get": { "tags": [ "App/Auth/TrustedDevice" ], "operationId": "appAuthTrustedDeviceQuery", "parameters": [ { "name": "perPage", "in": "query", "schema": { "type": "integer", "nullable": true } }, { "name": "cursor", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "items", "perPage", "next", "previous" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AppAuthTrustedDeviceSchema" } }, "perPage": { "type": "integer" }, "previous": { "type": "string", "nullable": true }, "next": { "type": "string", "nullable": true } }, "type": "object" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] }, "post": { "tags": [ "App/Auth/TrustedDevice" ], "operationId": "appAuthTrustedDeviceCreate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "guid" ], "properties": { "guid": { "type": "string" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/auth/trustedDevice/current": { "post": { "tags": [ "App/Auth/TrustedDevice" ], "operationId": "appAuthTrustedDeviceCurrent", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "guid" ], "properties": { "guid": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Current device is trusted", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppAuthTrustedDeviceSchema" } }, "type": "object" } } } }, "204": { "description": "Current device is not trusted" }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/auth/trustedDevice/{trustedDeviceId}": { "get": { "tags": [ "App/Auth/TrustedDevice" ], "operationId": "appAuthTrustedDeviceView", "parameters": [ { "name": "trustedDeviceId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppAuthTrustedDeviceSchema" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] }, "delete": { "tags": [ "App/Auth/TrustedDevice" ], "operationId": "appAuthTrustedDeviceDelete", "parameters": [ { "name": "trustedDeviceId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Successful" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/automations/{automationId}": { "delete": { "tags": [ "App Automation" ], "summary": "Delete an automation", "operationId": "8a4d6eaf33c6a8399451f759169cfa31", "parameters": [ { "name": "automationId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No Content" } } } }, "/app/automations/interpret": { "post": { "tags": [ "App Automation" ], "summary": "Interpret a natural-language intent into proposed automations", "operationId": "9cee8dd5e43b406f87a6d7785d79c22f", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "intent" ], "properties": { "intent": { "type": "string" }, "context": { "type": "object", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppAutomationSpecSchema" } } } } } } } }, "/app/automations": { "get": { "tags": [ "App Automation" ], "summary": "List the current user's automations", "operationId": "ea27e985d6ee2548d8dcc475dddcc4db", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppAutomationSchema" } } } } } } }, "post": { "tags": [ "App Automation" ], "summary": "Enable (persist) an automation", "operationId": "ca27bcedfbe5f11307e47810b1b2a0b9", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppAutomationSchema" } } } } } } }, "/app/automations/runs": { "get": { "tags": [ "App Automations" ], "summary": "List automation execution history for the current user", "operationId": "aeeca8c46e345b931240e55f10d4fd26", "parameters": [ { "name": "automationId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppAutomationRunSchema" } } } } } } } }, "/app/billing/subscription/cancel": { "post": { "tags": [ "App/Billing/Subscription" ], "operationId": "appBillingSubscriptionCancel", "responses": { "204": { "description": "Successful" }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/billing/subscription/charge": { "post": { "tags": [ "App/Billing/Subscription" ], "operationId": "appBillingSubscriptionCharge", "responses": { "204": { "description": "Successful" }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/billing/subscription": { "get": { "tags": [ "App/Billing/Subscription" ], "operationId": "appBillingSubscriptionQuery", "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppBillingSubscriptionSchema" } } }, "type": "object" } } } } } }, "post": { "tags": [ "App/Billing/Subscription" ], "operationId": "appBillingSubscriptionSubscribe", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "subscriptionId", "successUrl", "cancelUrl" ], "properties": { "subscriptionId": { "type": "integer" }, "successUrl": { "type": "string" }, "cancelUrl": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppBillingSubscriptionCheckoutSchema" } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/billing/subscription/session": { "post": { "tags": [ "App/Billing/Subscription" ], "operationId": "appBillingSubscriptionSession", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "returnUrl" ], "properties": { "returnUrl": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppBillingSubscriptionSessionSchema" } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/billing/subscription/skip": { "post": { "tags": [ "App/Billing/Subscription" ], "operationId": "appBillingSubscriptionSkip", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "subscriptionId" ], "properties": { "subscriptionId": { "type": "integer" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/campaign/{campaignId}/activate": { "post": { "tags": [ "App/Campaign" ], "operationId": "appCampaignActivate", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Successful" }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/campaign/free-limit-check": { "get": { "tags": [ "App/FreeLimit" ], "operationId": "appFreeLimitCheck", "parameters": [ { "name": "action_key", "in": "query", "description": "Ex: publish.campaign, start.optimization, report.generate...", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful check", "content": { "application/json": { "schema": { "required": [ "available" ], "properties": { "available": { "type": "boolean" } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/campaign/{campaignId}": { "get": { "tags": [ "App/Campaign" ], "operationId": "appCampaignView", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppCampaignSchema" } }, "type": "object" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] }, "delete": { "tags": [ "App/Campaign" ], "operationId": "appCampaignDelete", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Successful" }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/campaign/{campaignId}/optimization": { "post": { "tags": [ "App/Campaign" ], "operationId": "appCampaignOptimization", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/campaign/{campaignId}/pause": { "post": { "tags": [ "App/Campaign" ], "operationId": "appCampaignPause", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Successful" }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/campaign": { "get": { "tags": [ "App/Campaign" ], "operationId": "appCampaignQuery", "parameters": [ { "name": "googleAdsLinkingId", "in": "query", "schema": { "type": "integer" } }, { "name": "googleAdsCampaignId", "in": "query", "schema": { "type": "integer" } }, { "name": "perPage", "in": "query", "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "items", "perPage", "next", "previous" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AppCampaignSchema" } }, "perPage": { "type": "integer" }, "previous": { "type": "string", "nullable": true }, "next": { "type": "string", "nullable": true } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/campaign/activity/apply/{taskId}": { "post": { "tags": [ "App/Campaign/Activity" ], "operationId": "appCampaignActivityApply", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Successful" }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/campaign/activity/dismiss/{taskId}": { "post": { "tags": [ "App/Campaign/Activity" ], "operationId": "appCampaignActivityDismiss", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/campaign/activity/{campaignId}": { "get": { "tags": [ "App/Campaign/Activity" ], "operationId": "appCampaignActivityQuery", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "statuses", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "DRAFT", "RECOMMENDATION", "BLOCKED", "PENDING", "PROCESSING", "DONE", "GOAL" ] }, "nullable": true } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "items", "perPage", "next", "previous" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AppCampaignActivityTaskSchema" } }, "perPage": { "type": "integer" }, "previous": { "type": "string", "nullable": true }, "next": { "type": "string", "nullable": true } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/campaign/googleAds/{campaignId}/access": { "post": { "tags": [ "App/Campaign/GoogleAds" ], "operationId": "appCampaignGoogleAdsAccess", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Successful" }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/campaign/googleAds": { "post": { "tags": [ "App/Campaign/GoogleAds" ], "operationId": "appCampaignGoogleAdsCreate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "linkingId", "campaignId" ], "properties": { "linkingId": { "type": "integer" }, "campaignId": { "type": "integer" } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdSchema" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/campaign/googleAds/{campaignId}/metrics": { "get": { "tags": [ "App/Campaign/GoogleAds" ], "operationId": "appCampaignGoogleAdsMetrics", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppCampaignGoogleAdsMetricsReportSchema" } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/campaign/googleAds/{campaignId}/refresh": { "post": { "tags": [ "App/Campaign/GoogleAds" ], "operationId": "appCampaignGoogleAdsRefresh", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Successful" }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/demand-gen/{draftId}/regenerate": { "post": { "tags": [ "App/Create/GoogleAds/DemandGenCreation" ], "summary": "Queue an AI rewrite of one ad group's signals and/or texts.", "operationId": "appCreateGoogleAdsDemandGenCreationRegenerate", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "adGroup", "parts" ], "properties": { "adGroup": { "type": "object" }, "adFormat": { "type": "string", "enum": [ "single_image", "carousel", "video" ] }, "parts": { "type": "array", "items": { "type": "string", "enum": [ "signals", "texts" ] } } }, "type": "object" } } } }, "responses": { "200": { "description": "Queued", "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "token": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/demand-gen/{draftId}/regenerate/{token}": { "get": { "tags": [ "App/Create/GoogleAds/DemandGenCreation" ], "operationId": "appCreateGoogleAdsDemandGenCreationRegenerationStatus", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "token": { "type": "string" }, "status": { "type": "string", "enum": [ "processing", "completed", "failed" ] }, "result": { "type": "object", "nullable": true }, "error": { "type": "string", "nullable": true } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "Not found or expired" } }, "security": [ { "token": [] } ] } }, "/app/create/g/keywordPlanner/{plannerId}/export": { "get": { "tags": [ "App/Create/GoogleAds/KeywordPlanner" ], "operationId": "appCreateGoogleAdsKeywordPlannerExport", "parameters": [ { "name": "plannerId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "text/csv": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/keywordPlanner": { "post": { "tags": [ "App/Create/GoogleAds/KeywordPlanner" ], "operationId": "appCreateGoogleAdsKeywordPlannerQueue", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "url" ], "properties": { "url": { "type": "string" }, "prompt": { "type": "string", "nullable": true }, "language": { "type": "integer", "nullable": true }, "locations": { "type": "array", "items": { "type": "integer" }, "nullable": true } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/keywordPlanner/{plannerId}/reprocess": { "post": { "tags": [ "App/Create/GoogleAds/KeywordPlanner" ], "operationId": "appCreateGoogleAdsKeywordPlannerReprocess", "parameters": [ { "name": "plannerId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "url" ], "properties": { "url": { "type": "string" }, "prompt": { "type": "string", "nullable": true }, "language": { "type": "integer", "nullable": true }, "locations": { "type": "array", "items": { "type": "integer" }, "nullable": true } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/keywordPlanner/{plannerId}": { "get": { "tags": [ "App/Create/GoogleAds/KeywordPlanner" ], "operationId": "appCreateGoogleAdsKeywordPlannerView", "parameters": [ { "name": "plannerId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppCreateGoogleAdsKeywordPlannerSchema" } }, "type": "object" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] }, "put": { "tags": [ "App/Create/GoogleAds/KeywordPlanner" ], "operationId": "appCreateGoogleAdsKeywordPlannerUpdate", "parameters": [ { "name": "plannerId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "selected" ], "properties": { "selected": { "type": "array", "items": { "type": "integer" } } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/p-max/{draftId}/campaign-name": { "post": { "tags": [ "App/Create/GoogleAds/PMaxCreation" ], "operationId": "appCreateGoogleAdsPMaxCreationCampaignName", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string", "nullable": true }, "linkingId": { "type": "integer", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "desiredName": { "type": "string" }, "name": { "type": "string" }, "changed": { "type": "boolean" } }, "type": "object" } }, "type": "object" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/p-max/{draftId}/regenerate": { "post": { "tags": [ "App/Create/GoogleAds/PMaxCreation" ], "summary": "Queue an AI rewrite of one asset group's signals and/or texts.", "operationId": "appCreateGoogleAdsPMaxCreationRegenerate", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "assetGroup", "parts" ], "properties": { "assetGroup": { "type": "object" }, "parts": { "type": "array", "items": { "type": "string", "enum": [ "signals", "texts" ] } } }, "type": "object" } } } }, "responses": { "200": { "description": "Queued", "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "token": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/p-max/{draftId}/regenerate/{token}": { "get": { "tags": [ "App/Create/GoogleAds/PMaxCreation" ], "operationId": "appCreateGoogleAdsPMaxCreationRegenerationStatus", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "token": { "type": "string" }, "status": { "type": "string", "enum": [ "processing", "completed", "failed" ] }, "result": { "type": "object", "nullable": true }, "error": { "type": "string", "nullable": true } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "Not found or expired" } }, "security": [ { "token": [] } ] } }, "/app/create/g/rsaBuilder/{builderId}/export": { "get": { "tags": [ "App/Create/GoogleAds/RsaBuilder" ], "operationId": "appCreateGoogleAdsRsaBuilderExport", "parameters": [ { "name": "builderId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "text/csv": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/rsaBuilder": { "post": { "tags": [ "App/Create/GoogleAds/RsaBuilder" ], "operationId": "appCreateGoogleAdsRsaBuilderQueue", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "url" ], "properties": { "url": { "type": "string" }, "prompt": { "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/rsaBuilder/{builderId}/reprocess": { "post": { "tags": [ "App/Create/GoogleAds/RsaBuilder" ], "operationId": "appCreateGoogleAdsRsaBuilderReprocess", "parameters": [ { "name": "builderId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "url" ], "properties": { "url": { "type": "string" }, "prompt": { "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/rsaBuilder/{builderId}": { "get": { "tags": [ "App/Create/GoogleAds/RsaBuilder" ], "operationId": "appCreateGoogleAdsRsaBuilderView", "parameters": [ { "name": "builderId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppCreateGoogleAdsRsaBuilderSchema" } }, "type": "object" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] }, "put": { "tags": [ "App/Create/GoogleAds/RsaBuilder" ], "operationId": "appCreateGoogleAdsRsaBuilderUpdate", "parameters": [ { "name": "builderId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "headlines", "descriptions" ], "properties": { "headlines": { "type": "array", "items": { "type": "string" } }, "descriptions": { "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/searchCreation": { "post": { "tags": [ "App/Create/GoogleAds/SearchCreation" ], "operationId": "appCreateGoogleAdsSearchCreationCreate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "url" ], "properties": { "url": { "type": "string" }, "linkingId": { "type": "integer", "nullable": true }, "rsaBuilderId": { "type": "integer", "nullable": true }, "keywordPlannerId": { "type": "integer", "nullable": true }, "languages": { "type": "array", "items": { "type": "integer" }, "nullable": true }, "locations": { "type": "array", "items": { "type": "integer" }, "nullable": true }, "budgetAmount": { "type": "integer", "nullable": true } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdSchema" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/searchCreation/{draftId}/campaign-name": { "post": { "tags": [ "App/Create/GoogleAds/SearchCreation" ], "operationId": "appCreateGoogleAdsSearchCreationCampaignName", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "properties": { "linkingId": { "type": "integer", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "desiredName": { "type": "string" }, "name": { "type": "string" }, "changed": { "type": "boolean" } }, "type": "object" } }, "type": "object" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/searchCreation/{draftId}/publish": { "post": { "tags": [ "App/Create/GoogleAds/SearchCreation" ], "operationId": "appCreateGoogleAdsSearchCreationPublish", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Successful" }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/searchCreation/{draftId}/rebuild": { "post": { "tags": [ "App/Create/GoogleAds/SearchCreation" ], "operationId": "appCreateGoogleAdsSearchCreationRebuild", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [], "properties": { "url": { "type": "string", "nullable": true }, "prompt": { "type": "string", "nullable": true }, "languages": { "type": "array", "items": { "type": "integer" }, "nullable": true }, "locations": { "type": "array", "items": { "type": "integer" }, "nullable": true } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/searchCreation/{draftId}/status": { "get": { "tags": [ "App/Create/GoogleAds/SearchCreation" ], "operationId": "appCreateGoogleAdsSearchCreationStatus", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppCreateGoogleAdsSearchCreationStatusSchema" } }, "type": "object" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/searchCreation/{draftId}": { "get": { "tags": [ "App/Create/GoogleAds/SearchCreation" ], "operationId": "appCreateGoogleAdsSearchCreationView", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppCreateGoogleAdsSearchCreationDraftSchema" } }, "type": "object" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] }, "patch": { "tags": [ "App/Create/GoogleAds/SearchCreation" ], "operationId": "appCreateGoogleAdsSearchCreationUpdate", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [], "properties": { "linkingId": { "type": "integer", "nullable": true }, "url": { "type": "string", "nullable": true }, "languages": { "type": "array", "items": { "type": "integer" }, "nullable": true }, "locations": { "type": "array", "items": { "type": "integer" }, "nullable": true }, "headlines": { "type": "array", "items": { "type": "string" }, "nullable": true }, "descriptions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "keywords": { "type": "array", "items": { "type": "integer" }, "nullable": true }, "budgetAmount": { "type": "integer", "nullable": true } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/searchCreationAi/{draftId}/keywordPlanner": { "post": { "tags": [ "App/Create/GoogleAds/SearchCreationAi" ], "operationId": "appCreateGoogleAdsSearchCreationAiBuildKeywordPlanner", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "source" ], "properties": { "source": { "type": "string", "enum": [ "ai", "manual", "merge" ], "example": "ai" }, "manualKeywords": { "type": "array", "items": { "type": "string" }, "example": [ "emergency plumber near me", "water heater installation" ], "nullable": true } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdSchema" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/searchCreationAi/{draftId}/rsa-builder": { "post": { "tags": [ "App/Create/GoogleAds/SearchCreationAi" ], "operationId": "appCreateGoogleAdsSearchCreationAiBuildRsaAds", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/searchCreationAi/{draftId}/stag-builder": { "post": { "tags": [ "App/Create/GoogleAds/SearchCreationAi" ], "operationId": "appCreateGoogleAdsSearchCreationAiBuildStagStructure", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "keyword_ids", "campaign_type" ], "properties": { "keyword_ids": { "type": "array", "items": { "type": "integer" } }, "campaign_type": { "type": "string", "enum": [ "high_intent", "competitor_brands" ] }, "campaign_name": { "type": "string", "nullable": true }, "max_cpc": { "type": "number", "format": "float", "nullable": true }, "landing_page_url": { "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdSchema" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/searchCreationAi": { "post": { "tags": [ "App/Create/GoogleAds/SearchCreationAi" ], "operationId": "appCreateGoogleAdsSearchCreationAiCreate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "url" ], "properties": { "url": { "type": "string" }, "linkingId": { "type": "integer", "nullable": true }, "verticalId": { "type": "string", "nullable": true }, "languages": { "type": "array", "items": { "type": "integer" }, "nullable": true }, "locations": { "type": "array", "items": { "type": "integer" }, "nullable": true }, "excludedLocations": { "type": "array", "items": { "type": "integer" }, "nullable": true }, "proximities": { "type": "array", "items": { "required": [ "latitude", "longitude", "radius", "radius_units" ], "properties": { "latitude": { "type": "number" }, "longitude": { "type": "number" }, "radius": { "type": "number" }, "radius_units": { "type": "string", "enum": [ "MILES", "KILOMETERS" ] }, "label": { "type": "string", "nullable": true }, "geo_target_id": { "type": "integer", "nullable": true } }, "type": "object" }, "nullable": true }, "knownCompetitors": { "type": "array", "items": { "type": "string" }, "nullable": true }, "exclusions": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdSchema" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/searchCreationAi/{draftId}/seed-keywords": { "delete": { "tags": [ "App/Create/GoogleAds/SearchCreationAi" ], "operationId": "appCreateGoogleAdsSearchCreationAiDeleteSeedKeyword", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "keyword" ], "properties": { "keyword": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/searchCreationAi/{draftId}/status": { "get": { "tags": [ "App/Create/GoogleAds/SearchCreationAi" ], "operationId": "appCreateGoogleAdsSearchCreationAiStatus", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/searchCreationAi/{draftId}/analysis": { "patch": { "tags": [ "App/Create/GoogleAds/SearchCreationAi" ], "operationId": "appCreateGoogleAdsSearchCreationAiUpdateAnalysis", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "advertised_services" ], "properties": { "business_summary": { "type": "string", "nullable": true }, "core_offer": { "type": "string", "nullable": true }, "target_audience": { "type": "string", "nullable": true }, "advertised_services": { "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/searchCreationAi/{draftId}": { "get": { "tags": [ "App/Create/GoogleAds/SearchCreationAi" ], "operationId": "appCreateGoogleAdsSearchCreationAiView", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/sitelinkBuilder/{builderId}/export": { "get": { "tags": [ "App/Create/GoogleAds/SitelinkBuilder" ], "operationId": "appCreateGoogleAdsSitelinkBuilderExport", "parameters": [ { "name": "builderId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "text/csv": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/sitelinkBuilder": { "post": { "tags": [ "App/Create/GoogleAds/SitelinkBuilder" ], "operationId": "appCreateGoogleAdsSitelinkBuilderQueue", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "url" ], "properties": { "url": { "type": "string" } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/sitelinkBuilder/{builderId}/reprocess": { "post": { "tags": [ "App/Create/GoogleAds/SitelinkBuilder" ], "operationId": "appCreateGoogleAdsSitelinkBuilderReprocess", "parameters": [ { "name": "builderId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "url" ], "properties": { "url": { "type": "string" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/create/g/sitelinkBuilder/{builderId}": { "get": { "tags": [ "App/Create/GoogleAds/SitelinkBuilder" ], "operationId": "appCreateGoogleAdsSitelinkBuilderView", "parameters": [ { "name": "builderId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppCreateGoogleAdsSitelinkBuilderSchema" } }, "type": "object" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] }, "put": { "tags": [ "App/Create/GoogleAds/SitelinkBuilder" ], "operationId": "appCreateGoogleAdsSitelinkBuilderUpdate", "parameters": [ { "name": "builderId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "sitelinks" ], "properties": { "sitelinks": { "type": "array", "items": { "required": [ "finalUrl", "linkText" ], "properties": { "finalUrl": { "type": "string" }, "linkText": { "type": "string" }, "description1": { "type": "string", "nullable": true }, "description2": { "type": "string", "nullable": true } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/linking/g/{linkingId}": { "get": { "tags": [ "App/Linking/GoogleAds" ], "operationId": "appLinkingGoogleAdsView", "parameters": [ { "name": "linkingId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppLinkingGoogleAdsSchema" } }, "type": "object" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] }, "delete": { "tags": [ "App/Linking/GoogleAds" ], "operationId": "appLinkingGoogleAdsDelete", "parameters": [ { "name": "linkingId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Successful" }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/linking/g/hierarchy": { "get": { "tags": [ "App/Linking/GoogleAds" ], "operationId": "appLinkingGoogleAdsHierarchy", "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppLinkingGoogleAdsHierarchySchema" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/linking/g": { "get": { "tags": [ "App/Linking/GoogleAds" ], "operationId": "appLinkingGoogleAdsQuery", "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "isManager", "in": "query", "schema": { "type": "integer", "enum": [ 0, 1 ], "nullable": true } }, { "name": "perPage", "in": "query", "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "items", "perPage", "next", "previous" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AppLinkingGoogleAdsSchema" } }, "perPage": { "type": "integer" }, "previous": { "type": "string", "nullable": true }, "next": { "type": "string", "nullable": true } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] }, "post": { "tags": [ "App/Linking/GoogleAds" ], "operationId": "appLinkingGoogleAdsIssue", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "code", "redirectUri" ], "properties": { "code": { "type": "string" }, "redirectUri": { "type": "string" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "400": { "description": "Failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] }, "delete": { "tags": [ "App/Linking/GoogleAds" ], "operationId": "appLinkingGoogleAdsReset", "responses": { "204": { "description": "Successful" }, "401": { "description": "Unauthenticated" } }, "security": [ { "token": [] } ] } }, "/app/linking/g/{linkingId}/ping": { "get": { "tags": [ "App/Linking/GoogleAds" ], "operationId": "appLinkingGoogleAdsPing", "parameters": [ { "name": "linkingId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Successful" }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorListSchema" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/linking/g/uri": { "get": { "tags": [ "App/Linking/GoogleAds" ], "operationId": "appLinkingGoogleAdsUri", "parameters": [ { "name": "redirectUri", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "uri" ], "properties": { "uri": { "type": "string" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/linking/meta/{linkingId}/accounts": { "get": { "tags": [ "App/Linking/Meta" ], "operationId": "appLinkingMetaAccounts", "parameters": [ { "name": "linkingId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppLinkingMetaAccountSchema" } } }, "type": "object" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/linking/meta/{linkingId}": { "get": { "tags": [ "App/Linking/Meta" ], "operationId": "appLinkingMetaView", "parameters": [ { "name": "linkingId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppLinkingMetaSchema" } }, "type": "object" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] }, "delete": { "tags": [ "App/Linking/Meta" ], "operationId": "appLinkingMetaDelete", "parameters": [ { "name": "linkingId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Successful" }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/linking/meta/{linkingId}/ping": { "get": { "tags": [ "App/Linking/Meta" ], "operationId": "appLinkingMetaPing", "parameters": [ { "name": "linkingId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Successful" }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/linking/meta": { "get": { "tags": [ "App/Linking/Meta" ], "operationId": "appLinkingMetaQuery", "parameters": [ { "name": "perPage", "in": "query", "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "items", "perPage", "next", "previous" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AppLinkingMetaSchema" } }, "perPage": { "type": "integer" }, "previous": { "type": "string", "nullable": true }, "next": { "type": "string", "nullable": true } }, "type": "object" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/linking/meta/{linkingId}/select": { "post": { "tags": [ "App/Linking/Meta" ], "operationId": "appLinkingMetaSelectAccount", "parameters": [ { "name": "linkingId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "accountId" ], "properties": { "accountId": { "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AppLinkingMetaAccountSchema" } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/linking/meta/uri": { "get": { "tags": [ "App/Linking/Meta" ], "operationId": "appLinkingMetaUri", "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "uri" ], "properties": { "uri": { "type": "string" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/lookup/g/campaign": { "get": { "tags": [ "App/Lookup/GoogleAds/Campaign" ], "operationId": "appLookupGoogleAdsCampaignQuery", "parameters": [ { "name": "linkingId", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "q", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "advertisingChannelType", "in": "query", "schema": { "type": "string", "enum": [ "SEARCH", "PERFORMANCE_MAX", "DEMAND_GEN" ], "nullable": true } }, { "name": "advertisingChannelTypes[]", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "SEARCH", "PERFORMANCE_MAX", "DEMAND_GEN" ] }, "nullable": true } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppLookupGoogleAdsCampaignSchema" } } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/app/lookup/g/geoTargetConstant/bulk": { "post": { "tags": [ "App/Lookup/GoogleAds/GeoTargetConstant" ], "operationId": "appLookupGoogleAdsGeoTargetConstantBulkResolve", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "string" } }, "countryCode": { "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "required": [ "matched", "unmatched" ], "properties": { "matched": { "type": "array", "items": { "required": [ "input", "location" ], "properties": { "input": { "type": "string" }, "location": { "$ref": "#/components/schemas/AppLookupGoogleAdsGeoTargetConstantSchema" } }, "type": "object" } }, "unmatched": { "type": "array", "items": { "type": "string" } } }, "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/app/lookup/g/geoTargetConstant/place": { "get": { "tags": [ "App/Lookup/GoogleAds/GeoTargetConstant" ], "operationId": "appLookupGoogleAdsGeoTargetConstantPlace", "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "required": [ "label", "latitude", "longitude" ], "properties": { "label": { "type": "string" }, "latitude": { "type": "number" }, "longitude": { "type": "number" } }, "type": "object" } } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } } } } }, "/app/lookup/g/geoTargetConstant": { "get": { "tags": [ "App/Lookup/GoogleAds/GeoTargetConstant" ], "operationId": "appLookupGoogleAdsGeoTargetConstantQuery", "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "ids", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "resourceNames", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppLookupGoogleAdsGeoTargetConstantSchema" } } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/app/lookup/g/languageConstant": { "get": { "tags": [ "App/Lookup/GoogleAds/LanguageConstant" ], "operationId": "appLookupGoogleAdsLanguageConstantQuery", "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppLookupGoogleAdsLanguageConstantSchema" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/app/lookup/g/merchant-center": { "get": { "tags": [ "App/Lookup/GoogleAds/MerchantCenter" ], "operationId": "appLookupGoogleAdsMerchantCenterQuery", "parameters": [ { "name": "linkingId", "in": "query", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/app/projects/{project}/accounts": { "post": { "tags": [ "App Project" ], "summary": "Attach a channel account (Google Ads / Yelp / Meta) to a project", "operationId": "5a93f638300b6b1608d0a61e545026d3", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "channel", "accountable_id" ], "properties": { "channel": { "type": "string", "enum": [ "google_ads", "yelp", "meta" ] }, "accountable_id": { "type": "integer" }, "role": { "type": "string", "enum": [ "primary", "secondary" ], "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppProjectSchema" } } } }, "404": { "description": "Project or account not found" }, "409": { "description": "Account already attached" } } } }, "/app/projects": { "get": { "tags": [ "App Project" ], "summary": "List the current user's projects (channel-agnostic clients) with attached accounts", "operationId": "75b49ba8cb81d5a39ab5a19bda63b7b5", "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "vertical", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppProjectSchema" } } } } } } }, "post": { "tags": [ "App Project" ], "summary": "Create a project (channel-agnostic client)", "operationId": "ff022ac931c8d1305e8bf090232cf2c4", "requestBody": { "content": { "application/json": { "schema": { "required": [ "name" ], "properties": { "name": { "type": "string" }, "vertical_id": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppProjectSchema" } } } } } } }, "/app/projects/distribute": { "post": { "tags": [ "App Project" ], "summary": "Build the user's projects from their connected accounts (welcome/accept flow)", "operationId": "8a6e69862d15096dd0f4863ac54b45b1", "responses": { "200": { "description": "OK" } } } }, "/app/projects/{project}/favorite": { "put": { "tags": [ "App Project" ], "summary": "Add or remove a project from favorites", "description": "Star / unstar a project in the viewer's personal watchlist (Agency Overview\nFavorites). Only the viewer sees their favorites.", "operationId": "a0ac4e3da0c42079293eecfb0ce7266f", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "favorite" ], "properties": { "favorite": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK" } } } }, "/app/projects/{project}/kpis": { "get": { "tags": [ "App Project" ], "summary": "List conversion-type KPIs", "description": "Per-conversion-type KPIs of a project (the primary KPI lives on the project row and\nis edited via PATCH /targets).", "operationId": "7cad60168f478594924dc75116db37c5", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "App Project" ], "summary": "Create or update the KPI for one conversion filter", "operationId": "0f501fe3ea8e6fa3ed2d87c8a294ef67", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "conversion_filter" ], "properties": { "conversion_filter": { "type": "string" }, "target_leads": { "type": "integer", "nullable": true }, "target_cpl": { "type": "number", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "OK" } } } }, "/app/projects/{project}/kpis/{kpi}": { "delete": { "tags": [ "App Project" ], "summary": "Delete a conversion-type KPI", "operationId": "6fc0789d1e1d27d89d32dba8d0218d48", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "kpi", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" } } } }, "/app/projects/{project}/link-suggestions": { "get": { "tags": [ "App Project" ], "summary": "Suggest same-business accounts of a channel to link to this project", "operationId": "2657f16a18711fae90161cd2d80fd823", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "channel", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "google_ads", "yelp", "meta" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppProjectLinkSuggestionSchema" } } } } } } } }, "/app/projects/{project}/manager": { "put": { "tags": [ "App Project" ], "summary": "Set the project manager", "description": "Assign the team member responsible for a project (Agency Overview \"Manager\").\nNull clears it — the project creator is shown again.", "operationId": "787efa318e99ca4b46cbdbc2c384f70e", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "manager_user_id": { "type": "integer", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "OK" } } } }, "/app/projects/overview": { "get": { "tags": [ "App Project" ], "summary": "Agency Overview project meta + previous-period totals", "description": "Agency Overview (General page) data that the portfolio reporting snapshot does not\ncarry: each project's manager and the viewer's favorites, plus the totals of the\nwindow right before the selected one (for the CPA trend). Performance itself comes\nfrom GET /app/reporting.", "operationId": "6f2724ada42678d32e52fe27990eca4b", "parameters": [ { "name": "dateFrom", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "dateTo", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK" } } } }, "/app/projects/{project}": { "get": { "tags": [ "App Project" ], "summary": "View one project with its channel accounts", "operationId": "0160b4fbcfb9a042a615d0bb9ecfd762", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppProjectSchema" } } } }, "404": { "description": "Not found" } } }, "patch": { "tags": [ "App Project" ], "summary": "Update a project draft", "operationId": "40e6aacb477b0135f60812589b949383", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "name" ], "properties": { "name": { "type": "string" }, "vertical_id": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppProjectSchema" } } } }, "404": { "description": "Project not found" } } } }, "/app/projects/{project}/targets": { "patch": { "tags": [ "App Project" ], "summary": "Set a project's monthly budget and target CPL", "operationId": "3681bffc83691fbf457c85081dae1789", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "monthly_budget", "target_cpa", "target_leads" ], "properties": { "monthly_budget": { "type": "number", "nullable": true }, "target_cpa": { "type": "number", "nullable": true }, "target_leads": { "type": "integer", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppProjectSchema" } } } }, "404": { "description": "Project not found" } } } }, "/app/projects/{project}/vertical-context": { "get": { "tags": [ "App Project" ], "summary": "Niche benchmarks + negatives assembled for a project's vertical (for UI + prompt grounding)", "operationId": "810b27cc297eb05c1f0a6c0a37590b24", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not found" } } } }, "/app/projects/verticals": { "get": { "tags": [ "App Project" ], "summary": "List selectable project verticals (id + label) for manual override", "operationId": "6786f6cd34c3d59d4f14b075e4601625", "responses": { "200": { "description": "OK" } } } }, "/app/recommendations": { "get": { "tags": [ "App Recommendation" ], "summary": "List the current user's stored recommendations", "operationId": "a0beb9202425004a1461d531cc8378af", "parameters": [ { "name": "businessId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "domain", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppRecommendationSchema" } } } } } } } }, "/app/recommendations/{recommendationId}": { "patch": { "tags": [ "App Recommendation" ], "summary": "Update a recommendation status", "operationId": "02b67b9bb321e6ea93f11dd324815378", "parameters": [ { "name": "recommendationId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "status" ], "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppRecommendationSchema" } } } } } } }, "/app/reporting": { "get": { "tags": [ "App Reporting" ], "summary": "Read the prepared global reporting snapshot from Postgres", "operationId": "2a05cda5b0077012c51a16385f2cb797", "parameters": [ { "name": "projectId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "periodDays", "in": "query", "required": false, "schema": { "type": "integer", "enum": [ 7, 30, 60, 90 ] } }, { "name": "refresh", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } } } }, "/app/signals/dayparting": { "get": { "tags": [ "App Signal" ], "summary": "Data-moat dayparting demand curves (by day, by hour) for a vertical", "operationId": "7afa26a6e5563a456dc7f4bbbe83dc2f", "parameters": [ { "name": "vertical", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "city", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppDaypartingCurveSchema" } } } } } } }, "/app/signals/market": { "get": { "tags": [ "App Signal" ], "summary": "Data-moat market curves (cost/lead by location, demand by temperature) for a vertical", "operationId": "c801411627bd54094ff4b98db4eeba3b", "parameters": [ { "name": "vertical", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppMarketInsightsSchema" } } } } } } }, "/app/signals": { "get": { "tags": [ "App Signal" ], "summary": "Live readings from every registered signal connector", "operationId": "cf53c6cd627e8de50d4805cf385fe540", "parameters": [ { "name": "city", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "vertical", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppSignalReadingSchema" } } } } } } } }, "/app/support/beta": { "post": { "tags": [ "App/Support" ], "operationId": "appSupportBeta", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "feature" ], "properties": { "feature": { "type": "string" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/support/bug": { "post": { "tags": [ "App/Support" ], "operationId": "appSupportBug", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "description" ], "properties": { "description": { "type": "string" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/support/contact": { "post": { "tags": [ "App/Support" ], "operationId": "appSupportContact", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "name", "email", "message" ], "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/app/support/sales": { "post": { "tags": [ "App/Support" ], "operationId": "appSupportSales", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "subscriptionId", "companyEmail", "message" ], "properties": { "subscriptionId": { "type": "integer" }, "companyEmail": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/support": { "post": { "tags": [ "App/Support" ], "operationId": "appSupport", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/app/team/invitations/token/{token}/accept": { "post": { "tags": [ "App Team" ], "summary": "Accept a team invitation as the signed-in user", "operationId": "2f3f41b05db27af6bd2929544a89506d", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppTeamSchema" } } } } } } }, "/app/team/invitations": { "get": { "tags": [ "App Team" ], "summary": "List pending invitations for the current team (admins and owner only)", "operationId": "218b1521c08013993ec05549dc28b830", "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "App Team" ], "summary": "Invite someone to the current team by email (admins and owner only)", "operationId": "b6f3422e646618db78c587f90bef9185", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppTeamInvitationSchema" } } } } } } }, "/app/team/invitations/{invitation}": { "delete": { "tags": [ "App Team" ], "summary": "Revoke a pending invitation (admins and owner only)", "operationId": "9e2bf545093782be2d5425994ba34bba", "responses": { "200": { "description": "OK" } } } }, "/app/team/invitations/token/{token}": { "get": { "tags": [ "App Team" ], "summary": "Preview an invitation by token (unauthenticated accept page)", "operationId": "454c54a9f885328270f3f46fe4d19048", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppTeamInvitationPublicSchema" } } } } } } }, "/app/team/members/{userId}": { "delete": { "tags": [ "App Team" ], "summary": "Remove a member from the current team (admins and owner only)", "operationId": "79f343f7027fcbaa8116b2e8459972e1", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppTeamSchema" } } } } } }, "patch": { "tags": [ "App Team" ], "summary": "Change a member's role (admins and owner only)", "operationId": "24dd405aa04646eb7a9a23580967fcd2", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppTeamSchema" } } } } } } }, "/app/team/leave": { "post": { "tags": [ "App Team" ], "summary": "Leave the current team (owner must transfer ownership first)", "operationId": "5c54b33d38546e7b099d2d109c2137dd", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppTeamSchema" } } } } } } }, "/app/team/list": { "get": { "tags": [ "App Team" ], "summary": "List every team the current user belongs to (for the switcher)", "operationId": "ed4b99767a082ce323b05476c5489767", "responses": { "200": { "description": "OK" } } } }, "/app/team": { "get": { "tags": [ "App Team" ], "summary": "View the current team with its members", "operationId": "d209ece7ec967eb082a4e668c5540100", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppTeamSchema" } } } } } }, "patch": { "tags": [ "App Team" ], "summary": "Rename the current team (admins and owner only)", "operationId": "808157c9a65fb6baf5c90fac1869afed", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppTeamSchema" } } } } } } }, "/app/team/switch": { "post": { "tags": [ "App Team" ], "summary": "Switch the current user's active team", "operationId": "20ca7972c795d163f88deb931701758e", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppTeamSchema" } } } } } } }, "/app/team/transfer": { "post": { "tags": [ "App Team" ], "summary": "Transfer ownership of the current team (owner only)", "operationId": "791ab6f50541bec196a1cb9ec6f2323f", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppTeamSchema" } } } } } } }, "/app/yelp/ads-jobs/manual": { "post": { "tags": [ "App Yelp" ], "summary": "Enqueue a manual guarded Yelp ads job (create/pause/resume/edit budget)", "operationId": "87a8e2fc068a01b14ca946663945073f", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "action" ], "properties": { "programRef": { "type": "string", "nullable": true }, "businessRef": { "type": "string", "nullable": true }, "action": { "type": "string", "enum": [ "create_program", "edit_program", "update_features", "pause", "resume", "end_program", "edit_budget" ] }, "programName": { "type": "string", "enum": [ "CPC", "BP", "EP", "RCA", "CTA", "SLIDESHOW", "BH", "VL", "LOGO", "PORTFOLIO" ] }, "direction": { "type": "string", "enum": [ "increase", "decrease" ] }, "deltaPct": { "type": "integer" }, "budgetCents": { "type": "integer" }, "maxBidCents": { "type": "integer", "nullable": true }, "pacingMethod": { "type": "string", "enum": [ "paced", "unpaced" ], "nullable": true }, "startDate": { "type": "string", "format": "date", "nullable": true }, "endDate": { "type": "string", "format": "date", "nullable": true }, "futureBudgetDate": { "type": "string", "format": "date", "nullable": true }, "promotionCode": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true }, "isAutobid": { "type": "boolean", "nullable": true }, "feePeriod": { "type": "string", "enum": [ "CALENDAR_MONTH", "ROLLING_MONTH" ], "nullable": true }, "adCategories": { "type": "array", "items": { "type": "string" } }, "features": { "type": "object", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppYelpAdsJobSchema" } } } } } } }, "/app/yelp/ads-jobs/poll": { "post": { "tags": [ "App Yelp" ], "summary": "Poll in-flight Yelp ads jobs for the current user", "operationId": "87e84717ae80361cbe40994a7068c859", "responses": { "200": { "description": "OK" } } } }, "/app/yelp/ads-jobs": { "get": { "tags": [ "App Yelp" ], "summary": "List guarded Yelp ads jobs for the current user", "operationId": "93361097964ed54685cf6995e1f8693f", "parameters": [ { "name": "businessId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "programRef", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppYelpAdsJobSchema" } } } } } } } }, "/app/yelp/autopilots/{programRef}": { "get": { "tags": [ "App Yelp" ], "summary": "Get a Yelp program's AutoPilot config (defaults when none is saved yet)", "operationId": "aa20e58555f17fb8583d942c3ccf28e1", "parameters": [ { "name": "programRef", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppYelpProgramAutopilotSchema" } } } } } }, "put": { "tags": [ "App Yelp" ], "summary": "Save a Yelp program's AutoPilot rules (end-of-month boost, pause days, manual pause dates)", "operationId": "68f635a7ad9f0e03884a8f11b811d5b4", "parameters": [ { "name": "programRef", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "eomBoostEnabled", "pauseDaysEnabled", "manualPauseEnabled" ], "properties": { "eomBoostEnabled": { "type": "boolean" }, "eomBoostDays": { "type": "integer", "maximum": 27, "minimum": 1, "nullable": true }, "pauseDaysEnabled": { "type": "boolean" }, "pauseWeekdays": { "type": "array", "items": { "type": "integer", "maximum": 6, "minimum": 0 } }, "manualPauseEnabled": { "type": "boolean" }, "manualPauseDates": { "type": "array", "items": { "type": "string", "format": "date" } }, "priority": { "type": "string", "enum": [ "boost", "pause" ], "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppYelpProgramAutopilotSchema" } } } } } }, "delete": { "tags": [ "App Yelp" ], "summary": "Remove a Yelp program's AutoPilot config (the program's current state is left as is)", "operationId": "e49a33c26b51717c1db1b27daa2f7e3c", "parameters": [ { "name": "programRef", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/app/yelp/autopilots": { "get": { "tags": [ "App Yelp" ], "summary": "List the team's Yelp program AutoPilot configs (scheduled pause/resume rules)", "operationId": "b47af3fc78de0e54ac91748df2fdf8eb", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppYelpProgramAutopilotSchema" } } } } } } } }, "/app/yelp/autoresponders/runs/build": { "post": { "tags": [ "App Yelp" ], "summary": "Build a local Yelp autoresponder reply queue from synced leads", "operationId": "ccee741c8bbc30958794d6eb13ccf59f", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppYelpAutoresponderRunSchema" } } } } } } } }, "/app/yelp/autoresponders/{businessId}/calendar": { "delete": { "tags": [ "App Yelp" ], "summary": "Disconnect Google Calendar from a Yelp conversation agent", "operationId": "f646886bc14766d8059d31f0140f7f8f", "responses": { "200": { "description": "OK" } } } }, "/app/yelp/autoresponders/calendar/oauth/callback": { "get": { "tags": [ "App Yelp" ], "summary": "Google Calendar OAuth redirect URI", "description": "Google redirects here after the business authorizes Calendar access. The app\nuser and Yelp business are resolved from the cached OAuth state.", "operationId": "2acaddd157e07f7073aea6cb59813525", "responses": { "302": { "description": "Redirect back to the app" } } } }, "/app/yelp/autoresponders/{businessId}/calendar/oauth/start": { "post": { "tags": [ "App Yelp" ], "summary": "Begin Google Calendar OAuth for a Yelp conversation agent", "operationId": "d78808651f97cde5faa99a24d8944773", "responses": { "200": { "description": "OK" } } } }, "/app/yelp/autoresponders/{businessId}/calendar/status": { "get": { "tags": [ "App Yelp" ], "summary": "Read Google Calendar readiness for a Yelp conversation agent", "operationId": "e577efa74c7f0841bc1a6652735a7530", "responses": { "200": { "description": "OK" } } } }, "/app/yelp/autoresponders/check-status": { "post": { "tags": [ "App Yelp" ], "summary": "Refresh local Yelp autoresponder status from synced rows", "operationId": "aa2c0af5abf4c029443b22adcfb56d96", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppYelpAutoresponderSchema" } } } } } } } }, "/app/yelp/autoresponders/integrations/status": { "get": { "tags": [ "App Yelp" ], "summary": "Read safe Yelp lead integration readiness without exposing webhook secrets", "operationId": "0103e80001c6474b1ddb562b19b5267e", "responses": { "200": { "description": "OK" } } } }, "/app/yelp/autoresponders/{businessId}/messages/{messageId}": { "delete": { "tags": [ "App Yelp" ], "summary": "Delete a local Yelp autoresponder response-flow message", "operationId": "37787a868dbb00c7ad4eaa83ee3223d3", "responses": { "204": { "description": "No Content" } } }, "patch": { "tags": [ "App Yelp" ], "summary": "Update a local Yelp autoresponder response-flow message", "operationId": "5a02874e694cb5ec2ce2cb6faccea1f5", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppYelpAutoresponderMessageSchema" } } } } } } }, "/app/yelp/autoresponders/{businessId}/messages": { "get": { "tags": [ "App Yelp" ], "summary": "List local Yelp autoresponder response-flow messages", "operationId": "9a4691d8ca51168cfd3c2b186b0d1528", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppYelpAutoresponderMessageSchema" } } } } } } }, "post": { "tags": [ "App Yelp" ], "summary": "Create a local Yelp autoresponder response-flow message", "operationId": "e72aba2c38e7af3d587a2a41932c561c", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppYelpAutoresponderMessageSchema" } } } } } } }, "/app/yelp/autoresponders": { "get": { "tags": [ "App Yelp" ], "summary": "List local Yelp autoresponder configurations", "operationId": "e934e579f8bfe2a64b031d9ef810835f", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppYelpAutoresponderSchema" } } } } } } }, "post": { "tags": [ "App Yelp" ], "summary": "Create a local Yelp autoresponder configuration", "operationId": "ebf1b7b3e8851d51d81c766dca7cfb48", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppYelpAutoresponderSchema" } } } } } } }, "/app/yelp/autoresponders/runs": { "get": { "tags": [ "App Yelp" ], "summary": "List local Yelp autoresponder queue runs", "operationId": "3940ff7c46484278c47889d3cf6a67dd", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppYelpAutoresponderRunSchema" } } } } } } } }, "/app/yelp/autoresponders/runs/{runId}/send": { "post": { "tags": [ "App Yelp" ], "summary": "Attempt to send an approved Yelp AI reply through the guarded outbound gateway", "operationId": "552a77744799ac6cae012edcb03f1183", "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppYelpAutoresponderRunSendPayload" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppYelpAutoresponderRunSchema" } } } } } } }, "/app/yelp/autoresponders/runs/{runId}": { "patch": { "tags": [ "App Yelp" ], "summary": "Approve or reject a local Yelp autoresponder run", "operationId": "49aca5f15c0b1d22c9b48246d2792540", "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppYelpAutoresponderRunUpdatePayload" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppYelpAutoresponderRunSchema" } } } } } } }, "/app/yelp/autoresponders/{businessId}/telegram": { "delete": { "tags": [ "App Yelp" ], "summary": "Disconnect Telegram from a Yelp conversation agent", "operationId": "2aab4aeec2be01190af5a1552c8b4213", "responses": { "200": { "description": "OK" } } } }, "/app/yelp/autoresponders/{businessId}/telegram/link": { "post": { "tags": [ "App Yelp" ], "summary": "Ensure a Telegram connect link for a Yelp conversation agent", "operationId": "10b57b34d107318c696701420078844d", "responses": { "200": { "description": "OK" } } } }, "/app/yelp/telegram/webhook/{secret}": { "post": { "tags": [ "App Yelp" ], "summary": "Telegram bot webhook — captures which chat a client connected", "operationId": "246038b2132490d3af9e8b6ee9c70103", "responses": { "200": { "description": "OK" } } } }, "/app/yelp/autoresponders/{businessId}": { "patch": { "tags": [ "App Yelp" ], "summary": "Update a local Yelp autoresponder configuration", "operationId": "9cdfe4982af3c6a7e9d45c3f013663e3", "parameters": [ { "name": "businessId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppYelpAutoresponderSchema" } } } } } } }, "/app/yelp/businesses/categories/search": { "get": { "tags": [ "App Yelp" ], "summary": "Search the Yelp category taxonomy (Fusion GET /v3/categories)", "operationId": "db4b3ef86e09718f673db8cb929f00b4", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "US", "CA" ] } } ], "responses": { "200": { "description": "OK" } } } }, "/app/yelp/businesses/{businessRef}/enabled": { "put": { "tags": [ "App Yelp" ], "summary": "Enable or disable a synced Yelp business in Optimyzee", "operationId": "60ca6307070f29120e417aea9afce6b6", "parameters": [ { "name": "businessRef", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppYelpBusinessSchema" } } } } } } }, "/app/yelp/businesses/{businessRef}/listing-update": { "post": { "tags": [ "App Yelp" ], "summary": "Submit a Yelp Data Ingestion listing update job", "operationId": "e6117c19ba4538068b1efa1570b25a30", "parameters": [ { "name": "businessRef", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/app/yelp/businesses/{businessRef}/listing-update/status": { "post": { "tags": [ "App Yelp" ], "summary": "Poll Yelp Data Ingestion and return the latest listing update job", "operationId": "ad011be1e3905635998c3605a1256c76", "parameters": [ { "name": "businessRef", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/app/yelp/businesses/{businessRef}/profile": { "put": { "tags": [ "App Yelp" ], "summary": "Update the editable AI business profile", "operationId": "a84c16ea96c1b0cc81b900e360d5c4e0", "parameters": [ { "name": "businessRef", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppYelpBusinessSchema" } } } } } } }, "/app/yelp/businesses": { "get": { "tags": [ "App Yelp" ], "summary": "List Yelp businesses synced for the current user", "operationId": "d18ce74a465956e45c007b8981ee6629", "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppYelpBusinessSchema" } } } } } } } }, "/app/yelp/businesses/{businessRef}/signal-settings": { "get": { "tags": [ "App Yelp" ], "summary": "List signal eligibility settings for a Yelp business", "operationId": "4d8b164d24c20e418c08fbbdd235f5d5", "parameters": [ { "name": "businessRef", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppYelpBusinessSignalSettingSchema" } } } } } } } }, "/app/yelp/businesses/{businessRef}/signal-settings/{signal}": { "put": { "tags": [ "App Yelp" ], "summary": "Update one signal eligibility setting for a Yelp business", "operationId": "eaa5519d341275e6aad70f99e4bc1095", "parameters": [ { "name": "businessRef", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "signal", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppYelpBusinessSignalSettingSchema" } } } } } } }, "/app/yelp/businesses/{businessRef}": { "get": { "tags": [ "App Yelp" ], "summary": "View a synced Yelp business", "operationId": "2b56d5bce97b82d148ba1be79d3b2410", "parameters": [ { "name": "businessRef", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppYelpBusinessSchema" } } } } } } }, "/app/yelp/connection": { "get": { "tags": [ "App Yelp" ], "summary": "View the current user's Yelp Partner connection", "operationId": "31452efe96c7bfeecf72d13ab99ebacb", "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "App Yelp" ], "summary": "Create or update the current user's Yelp Partner connection", "operationId": "fea28f05944c841001d6611b02043301", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppYelpConnectionSchema" } } } } } }, "delete": { "tags": [ "App Yelp" ], "summary": "Delete the current user's Yelp Partner connection", "operationId": "722d186d7cd38b8f28cdbf2a7d07e34a", "responses": { "204": { "description": "No Content" } } } }, "/app/yelp/connection/test": { "post": { "tags": [ "App Yelp" ], "summary": "Validate the stored Yelp partner credentials against the Partner API", "operationId": "14a434b2ed966dc7289ee6b0864f3337", "responses": { "200": { "description": "OK" } } } }, "/app/yelp/leads/google/backfill": { "post": { "tags": [ "App Yelp" ], "summary": "Append all existing leads to the team Google Sheet (owner/admin)", "description": "Adds every existing team lead that is not in the team sheet yet (deduped).\nBounded per call; the response says whether to run it again.", "operationId": "10b8d83b89b24736116900c78c639945", "responses": { "200": { "description": "OK" } } } }, "/app/yelp/leads/google": { "delete": { "tags": [ "App Yelp" ], "summary": "Disconnect the team's Google Sheets connection (owner/admin)", "operationId": "a1020e2ed74cf2da9c3e3039e56ea73e", "responses": { "200": { "description": "OK" } } } }, "/app/yelp/leads/google/export": { "post": { "tags": [ "App Yelp" ], "summary": "Export the given leads table into a new Google Sheet", "operationId": "df04aeba6e20ec445e277832212ec6cb", "responses": { "200": { "description": "OK" } } } }, "/app/yelp/leads/google/oauth/callback": { "get": { "tags": [ "App Yelp" ], "summary": "Google Sheets OAuth redirect URI", "description": "Google redirects the user's browser here (top-level, no app session) after\nthey authorize. The user is identified from the signed `state`; we exchange\nthe code, then bounce the browser back into the SPA leads page.", "operationId": "081830d9516311a12405015ac66a87c8", "responses": { "302": { "description": "Redirect back to the app" } } } }, "/app/yelp/leads/google/oauth/start": { "post": { "tags": [ "App Yelp" ], "summary": "Begin the team Google Sheets OAuth flow (owner/admin) — returns the authorize URL", "operationId": "d80dc83827433ecf5d917569fc9cd8e1", "responses": { "200": { "description": "OK" } } } }, "/app/yelp/leads/google/settings": { "patch": { "tags": [ "App Yelp" ], "summary": "Update the team Google Sheet settings (auto-add new leads) — owner/admin", "operationId": "7b4f2258ab8a349cf436d677e3491830", "responses": { "200": { "description": "OK" } } } }, "/app/yelp/leads/google/share": { "post": { "tags": [ "App Yelp" ], "summary": "Re-share the team Google Sheet (writer) with every active team member", "operationId": "507b5b42ad442381bf98cf5d30bfb3bc", "responses": { "200": { "description": "OK" } } } }, "/app/yelp/leads/google/status": { "get": { "tags": [ "App Yelp" ], "summary": "Team Google Sheets connection + shared sheet status for the current team", "operationId": "e7fb3747d2570bcae8fb534545c519c7", "responses": { "200": { "description": "OK" } } } }, "/app/yelp/leads/oauth/callback": { "get": { "tags": [ "App Yelp" ], "summary": "Yelp Leads OAuth redirect URI", "description": "Yelp redirects the business owner's browser here (top-level, no app session)\nafter they authorize. We identify the connection from the signed `state`,\nexchange the code, then bounce the browser back into the SPA.", "operationId": "ef54a335bea1d4263f4b7c93b3ac7764", "responses": { "302": { "description": "Redirect back to the app" } } } }, "/app/yelp/leads/oauth/start": { "post": { "tags": [ "App Yelp" ], "summary": "Begin the Yelp Leads OAuth flow — returns the Yelp authorize URL", "operationId": "dd489432efb9fc9b14e9935eb4e85f56", "responses": { "200": { "description": "OK" } } } }, "/app/yelp/leads": { "get": { "tags": [ "App Yelp" ], "summary": "List synced Yelp leads for the current user", "operationId": "bfebb54edfd97bd47c0aef794c9307d3", "parameters": [ { "name": "businessId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppYelpLeadSchema" } } } } } } } }, "/app/yelp/leads/{leadId}/reply-draft": { "post": { "tags": [ "App Yelp" ], "summary": "Generate a guarded AI reply draft for a synced Yelp lead", "operationId": "7172e519476825ed8f04e76993d08d14", "parameters": [ { "name": "leadId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppYelpLeadSchema" } } } } } } }, "/app/yelp/leads/summary": { "get": { "tags": [ "App Yelp" ], "summary": "Lead totals (count, reply rate, avg response) over all stored leads in scope", "operationId": "1341e6d40303cad66176fa60c2f2d1ef", "parameters": [ { "name": "businessId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK" } } } }, "/app/yelp/leads/webhook": { "get": { "tags": [ "App Yelp" ], "summary": "Yelp Leads webhook verification endpoint", "operationId": "3b904b591b2f6708261a8adf5ec9508c", "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "App Yelp" ], "summary": "Receive Yelp Leads webhook events", "operationId": "361f0202076ab358cd3f26f4bdf0c6a1", "responses": { "202": { "description": "Accepted" } } } }, "/app/yelp/programs": { "get": { "tags": [ "App Yelp" ], "summary": "List Yelp advertising programs synced for the current user", "operationId": "1a7c641667c9959a035781d6bf708ba7", "parameters": [ { "name": "businessId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppYelpProgramSchema" } } } } } } } }, "/app/yelp/programs/{programRef}": { "patch": { "tags": [ "App Yelp" ], "summary": "Rename a Yelp program (local title only, nothing is sent to Yelp)", "operationId": "1625dc61d0523f6796210fdcc3fdce53", "parameters": [ { "name": "programRef", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "title": { "type": "string", "maxLength": 80, "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppYelpProgramSchema" } } } } } } }, "/app/yelp/reporting": { "get": { "tags": [ "App Yelp" ], "summary": "View aggregated synced Yelp reporting metrics", "operationId": "c69aa2a2d91077e38abba5dde0fd5e89", "parameters": [ { "name": "businessId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppYelpReportingSchema" } } } } } } }, "/app/yelp/businesses/add": { "post": { "tags": [ "App Yelp" ], "summary": "Onboard a Yelp business by id/URL from Business Info (no ad program required)", "operationId": "521e3218d0bfa8afd4657e571b32ef98", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppYelpBusinessSchema" } } } } } } }, "/app/yelp/sync-runs": { "get": { "tags": [ "App Yelp" ], "summary": "List Yelp sync/import runs for the current user", "operationId": "fe2e1cadf35748e63a49477cbef7f6fd", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "source", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppYelpSyncRunSchema" } } } } } } } }, "/app/yelp/reporting/poll": { "post": { "tags": [ "App Yelp" ], "summary": "Poll outstanding Yelp report requests and import ready ones", "operationId": "4dafd96fc7ba7be5e11747fae649862b", "responses": { "200": { "description": "OK" } } } }, "/app/yelp/reporting/request": { "post": { "tags": [ "App Yelp" ], "summary": "Request a Yelp daily metrics report (async)", "operationId": "645e20a5c5ceefb632bcff1faf1d72b5", "responses": { "200": { "description": "OK" } } } }, "/app/yelp/sync": { "post": { "tags": [ "App Yelp" ], "summary": "Pull live businesses + programs from the Yelp Partner API", "operationId": "3ebada6ee2d7944c984d3868d728448a", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppYelpSyncRunSchema" } } } } } } }, "/operations/admin": { "get": { "tags": [ "Operations/Admin" ], "operationId": "operationsAdminQuery", "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "permissions", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "MANAGE_USERS", "MANAGE_BILLING_SUBSCRIPTIONS", "MANAGE_CAMPAIGNS", "MANAGE_ADMINS" ] }, "nullable": true } }, { "name": "perPage", "in": "query", "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "items", "perPage", "next", "previous" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/OperationsAdminSchema" } }, "perPage": { "type": "integer" }, "previous": { "type": "string", "nullable": true }, "next": { "type": "string", "nullable": true } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } }, "post": { "tags": [ "Operations/Admin" ], "operationId": "operationsAdminCreate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "email", "name", "permissions" ], "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "MANAGE_USERS", "MANAGE_BILLING_SUBSCRIPTIONS", "MANAGE_CAMPAIGNS", "MANAGE_ADMINS" ] } } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/operations/admin/{adminId}": { "get": { "tags": [ "Operations/Admin" ], "operationId": "operationsAdminView", "parameters": [ { "name": "adminId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OperationsAdminSchema" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } }, "put": { "tags": [ "Operations/Admin" ], "operationId": "operationsAdminUpdate", "parameters": [ { "name": "adminId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "name", "permissions" ], "properties": { "name": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "MANAGE_USERS", "MANAGE_BILLING_SUBSCRIPTIONS", "MANAGE_CAMPAIGNS", "MANAGE_ADMINS" ] } } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } }, "delete": { "tags": [ "Operations/Admin" ], "operationId": "operationsAdminDelete", "parameters": [ { "name": "adminId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Successful" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/operations/admin/{adminId}/reset": { "post": { "tags": [ "Operations/Admin" ], "operationId": "operationsAdminReset", "parameters": [ { "name": "adminId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Successful" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/operations/auth/gateway": { "post": { "tags": [ "Operations/Auth/Gateway" ], "operationId": "operationsAuthGateway", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "email", "password" ], "properties": { "email": { "type": "string" }, "password": { "type": "string" }, "otp": { "type": "string", "nullable": true }, "otpRecoveryCode": { "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OperationsAuthGatewayTokenSchema" } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "400": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/operations/auth/gateway/refresh": { "post": { "tags": [ "Operations/Auth/Gateway" ], "operationId": "operationsAuthGatewayRefresh", "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OperationsAuthGatewayTokenSchema" } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/operations/auth/gateway/revoke": { "post": { "tags": [ "Operations/Auth/Gateway" ], "operationId": "operationsAuthGatewayRevoke", "responses": { "204": { "description": "Successful" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/operations/auth/profile": { "get": { "tags": [ "Operations/Auth/Profile" ], "operationId": "operationsAuthProfile", "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OperationsAuthProfileSchema" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/operations/billing/subscription": { "get": { "tags": [ "Operations/Billing/Subscription" ], "operationId": "operationsBillingSubscriptionQuery", "parameters": [ { "name": "legacy", "in": "query", "schema": { "type": "integer", "enum": [ 0, 1 ], "nullable": true } }, { "name": "perPage", "in": "query", "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "items", "perPage", "next", "previous" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/OperationsBillingSubscriptionSchema" } }, "perPage": { "type": "integer" }, "previous": { "type": "string", "nullable": true }, "next": { "type": "string", "nullable": true } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } }, "post": { "tags": [ "Operations/Billing/Subscription" ], "operationId": "operationsBillingSubscriptionCreate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "plan", "description", "features", "featured", "stripePriceId", "annual", "amount", "sales", "legacy" ], "properties": { "plan": { "type": "string", "enum": [ "STARTUP", "BUSINESS", "PROFESSIONAL" ] }, "description": { "type": "string" }, "features": { "type": "array", "items": { "type": "string" } }, "featured": { "type": "boolean" }, "stripePriceId": { "type": "string" }, "annual": { "type": "boolean" }, "amount": { "type": "number" }, "trial": { "type": "number", "nullable": true }, "sales": { "type": "boolean" }, "legacy": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/operations/billing/subscription/{subscriptionId}": { "get": { "tags": [ "Operations/Billing/Subscription" ], "operationId": "operationsBillingSubscriptionView", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OperationsBillingSubscriptionSchema" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } }, "put": { "tags": [ "Operations/Billing/Subscription" ], "operationId": "operationsBillingSubscriptionUpdate", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "plan", "description", "features", "featured", "stripePriceId", "annual", "amount", "sales", "legacy" ], "properties": { "plan": { "type": "string", "enum": [ "STARTUP", "BUSINESS", "PROFESSIONAL" ] }, "description": { "type": "string" }, "features": { "type": "array", "items": { "type": "string" } }, "featured": { "type": "boolean" }, "stripePriceId": { "type": "string" }, "annual": { "type": "boolean" }, "amount": { "type": "number" }, "trial": { "type": "number", "nullable": true }, "sales": { "type": "boolean" }, "legacy": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } }, "delete": { "tags": [ "Operations/Billing/Subscription" ], "operationId": "operationsBillingSubscriptionDelete", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Successful" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/operations/campaign": { "get": { "tags": [ "Operations/Campaign" ], "operationId": "operationsCampaignQuery", "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "adminId", "in": "query", "schema": { "type": "integer", "nullable": true } }, { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "ACCESS_PENDING_REQUEST", "ACCESS_PENDING_GRANT", "ACTIVE", "PAUSED" ], "nullable": true } }, { "name": "orderBy", "in": "query", "schema": { "type": "string", "enum": [ "lastManagedAt", "createdAt" ], "nullable": true } }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": [ "ASC", "DESC" ], "nullable": true } }, { "name": "perPage", "in": "query", "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "items", "perPage", "next", "previous" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/OperationsCampaignSchema" } }, "perPage": { "type": "integer" }, "previous": { "type": "string", "nullable": true }, "next": { "type": "string", "nullable": true } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] } }, "/operations/campaign/{campaignId}": { "get": { "tags": [ "Operations/Campaign" ], "operationId": "operationsCampaignView", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OperationsCampaignSchema" } }, "type": "object" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] }, "put": { "tags": [ "Operations/Campaign" ], "operationId": "operationsCampaignUpdate", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "name", "status", "analyzing" ], "properties": { "adminId": { "type": "integer", "nullable": true }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "ACCESS_PENDING_REQUEST", "ACCESS_PENDING_GRANT", "ACTIVE", "PAUSED" ] }, "analyzing": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/operations/campaign/log": { "get": { "tags": [ "Operations/Campaign/Log" ], "operationId": "operationsCampaignLogQuery", "parameters": [ { "name": "campaignId", "in": "query", "schema": { "type": "integer" } }, { "name": "taskId", "in": "query", "schema": { "type": "integer" } }, { "name": "perPage", "in": "query", "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "items", "perPage", "next", "previous" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/OperationsCampaignLogSchema" } }, "perPage": { "type": "integer" }, "previous": { "type": "string", "nullable": true }, "next": { "type": "string", "nullable": true } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] }, "post": { "tags": [ "Operations/Campaign/Log" ], "operationId": "operationsCampaignLogCreate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "taskId", "message", "createdAt" ], "properties": { "taskId": { "type": "integer" }, "message": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/operations/campaign/log/{logId}": { "get": { "tags": [ "Operations/Campaign/Log" ], "operationId": "operationsCampaignLogView", "parameters": [ { "name": "logId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OperationsCampaignLogSchema" } }, "type": "object" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] }, "put": { "tags": [ "Operations/Campaign/Log" ], "operationId": "operationsCampaignLogUpdate", "parameters": [ { "name": "logId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "taskId", "message", "createdAt" ], "properties": { "taskId": { "type": "integer" }, "message": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } }, "delete": { "tags": [ "Operations/Campaign/Log" ], "operationId": "operationsCampaignLogDelete", "parameters": [ { "name": "logId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Successful" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/operations/campaign/task": { "get": { "tags": [ "Operations/Campaign/Task" ], "operationId": "operationsCampaignTaskQuery", "parameters": [ { "name": "campaignId", "in": "query", "schema": { "type": "integer" } }, { "name": "parentId", "in": "query", "schema": { "type": "integer" } }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "DRAFT", "RECOMMENDATION", "BLOCKED", "PENDING", "PROCESSING", "DONE", "GOAL" ] } }, { "name": "perPage", "in": "query", "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "items", "perPage", "next", "previous" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/OperationsCampaignTaskSchema" } }, "perPage": { "type": "integer" }, "previous": { "type": "string", "nullable": true }, "next": { "type": "string", "nullable": true } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] }, "post": { "tags": [ "Operations/Campaign/Task" ], "operationId": "operationsCampaignTaskCreate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "campaignId", "title", "status", "order" ], "properties": { "campaignId": { "type": "integer" }, "parentId": { "type": "integer", "nullable": true }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": [ "DRAFT", "RECOMMENDATION", "BLOCKED", "PENDING", "PROCESSING", "DONE", "GOAL" ] }, "startedAt": { "type": "string", "format": "date-time", "nullable": true }, "finishedAt": { "type": "string", "format": "date-time", "nullable": true }, "order": { "type": "integer" } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/operations/campaign/task/{taskId}": { "get": { "tags": [ "Operations/Campaign/Task" ], "operationId": "operationsCampaignTaskView", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OperationsCampaignTaskSchema" } }, "type": "object" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "security": [ { "token": [] } ] }, "put": { "tags": [ "Operations/Campaign/Task" ], "operationId": "operationsCampaignTaskUpdate", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "campaignId", "title", "status", "order" ], "properties": { "campaignId": { "type": "integer" }, "parentId": { "type": "integer", "nullable": true }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": [ "DRAFT", "RECOMMENDATION", "BLOCKED", "PENDING", "PROCESSING", "DONE", "GOAL" ] }, "startedAt": { "type": "string", "format": "date-time", "nullable": true }, "finishedAt": { "type": "string", "format": "date-time", "nullable": true }, "order": { "type": "integer" } }, "type": "object" } } } }, "responses": { "204": { "description": "Successful" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } }, "delete": { "tags": [ "Operations/Campaign/Task" ], "operationId": "operationsCampaignTaskDelete", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Successful" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/operations/user/{userId}": { "get": { "tags": [ "Operations/User" ], "operationId": "operationsUserView", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OperationsUserSchema" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } }, "delete": { "tags": [ "Operations/User" ], "operationId": "operationsUserDelete", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Successful" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/operations/user/{userId}/impersonate": { "post": { "tags": [ "Operations/User" ], "operationId": "operationsUserImpersonate", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/OperationsUserTokenSchema" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } }, "/operations/user": { "get": { "tags": [ "Operations/User" ], "operationId": "operationsUserQuery", "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "perPage", "in": "query", "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "required": [ "items", "perPage", "next", "previous" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/OperationsUserSchema" } }, "perPage": { "type": "integer" }, "previous": { "type": "string", "nullable": true }, "next": { "type": "string", "nullable": true } }, "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBagSchema" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } } } } }, "components": { "schemas": { "ErrorBagSchema": { "required": [ "errors" ], "properties": { "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "type": "object" }, "ErrorListSchema": { "required": [ "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorSchema" } } }, "type": "object" }, "ErrorSchema": { "required": [ "errors" ], "properties": { "error": { "type": "string" }, "message": { "type": "string", "nullable": true } }, "type": "object" }, "IdSchema": { "required": [ "id" ], "properties": { "id": { "type": "integer" } }, "type": "object" }, "AppAnalyzeGoogleAdsAuditSchema": { "required": [ "id", "name", "linkingId", "linkingCustomerId", "linkingName", "campaignId", "status", "auditedAt", "results" ], "properties": { "id": { "type": "integer" }, "linkingId": { "type": "integer" }, "linkingCustomerId": { "type": "integer" }, "linkingName": { "type": "string" }, "campaignId": { "type": "integer" }, "campaignName": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": [ "QUEUED", "PROCESSING", "SUCCESSFUL" ] }, "scope": { "type": "string", "enum": [ "CAMPAIGN", "SEARCH_ADS", "SEARCH_KEYWORDS", "SEARCH_TERMS", "P_MAX" ] }, "auditedAt": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AppAnalyzeGoogleAdsAuditResultSchema" } } }, "type": "object" }, "AppAnalyzeGoogleAdsAuditResultSchema": { "required": [ "id", "status", "title", "description", "scoreValue", "scoreMaxValue", "category", "details" ], "properties": { "id": { "type": "integer" }, "status": { "type": "string", "enum": [ "PASSED", "FAILED", "WARNING", "ERROR" ] }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "scoreValue": { "type": "integer" }, "scoreMaxValue": { "type": "integer" }, "category": { "type": "string", "nullable": true }, "summary": { "type": "string", "nullable": true }, "details": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "nullable": true } }, "type": "object" }, "AppAnalyzeGoogleAdsHealthAccountSchema": { "required": [ "campaignCount", "hasConversionValue", "totals" ], "properties": { "campaignCount": { "type": "integer" }, "hasConversionValue": { "type": "boolean" }, "totals": { "$ref": "#/components/schemas/AppAnalyzeGoogleAdsHealthMetricsSchema" } }, "type": "object" }, "AppAnalyzeGoogleAdsHealthCampaignSchema": { "required": [ "campaignId", "campaignName", "goalType", "status", "trend", "score", "topIssue", "current", "previous", "deltas", "flags" ], "properties": { "campaignId": { "type": "integer" }, "campaignName": { "type": "string" }, "goalType": { "type": "string", "enum": [ "LEADGEN", "ECOMMERCE" ] }, "status": { "type": "string", "enum": [ "GOOD", "STABLE", "NEEDS_ATTENTION", "ISSUE", "INSUFFICIENT_DATA" ] }, "trend": { "type": "string", "enum": [ "IMPROVING", "STABLE", "DECLINING", "INSUFFICIENT_DATA" ] }, "score": { "type": "integer", "nullable": true }, "topIssue": { "type": "string", "nullable": true }, "current": { "$ref": "#/components/schemas/AppAnalyzeGoogleAdsHealthMetricsSchema" }, "previous": { "$ref": "#/components/schemas/AppAnalyzeGoogleAdsHealthMetricsSchema" }, "deltas": { "$ref": "#/components/schemas/AppAnalyzeGoogleAdsHealthDeltasSchema" }, "flags": { "type": "array", "items": { "$ref": "#/components/schemas/AppAnalyzeGoogleAdsHealthFlagSchema" } } }, "type": "object" }, "AppAnalyzeGoogleAdsHealthDeltasSchema": { "description": "Signed fractional change vs the previous period (0.25 = +25%).\nAny field may be null when the previous period had no comparable base.", "required": [ "cost", "conversions", "conversionValue", "cpa", "roas", "convRate", "ctr", "cpc" ], "properties": { "cost": { "type": "number", "format": "float", "nullable": true }, "conversions": { "type": "number", "format": "float", "nullable": true }, "conversionValue": { "type": "number", "format": "float", "nullable": true }, "cpa": { "type": "number", "format": "float", "nullable": true }, "roas": { "type": "number", "format": "float", "nullable": true }, "convRate": { "type": "number", "format": "float", "nullable": true }, "ctr": { "type": "number", "format": "float", "nullable": true }, "cpc": { "type": "number", "format": "float", "nullable": true } }, "type": "object" }, "AppAnalyzeGoogleAdsHealthFlagSchema": { "required": [ "level", "area", "message" ], "properties": { "level": { "type": "string", "enum": [ "GREEN", "YELLOW", "RED", "INSUFFICIENT_DATA" ] }, "area": { "type": "string" }, "message": { "type": "string" } }, "type": "object" }, "AppAnalyzeGoogleAdsHealthReportSchema": { "required": [ "linkingId", "linkingCustomerId", "linkingName", "periodDays", "account", "campaigns" ], "properties": { "linkingId": { "type": "integer" }, "linkingCustomerId": { "type": "integer" }, "linkingName": { "type": "string" }, "periodDays": { "type": "integer" }, "account": { "$ref": "#/components/schemas/AppAnalyzeGoogleAdsHealthAccountSchema" }, "campaigns": { "type": "array", "items": { "$ref": "#/components/schemas/AppAnalyzeGoogleAdsHealthCampaignSchema" } } }, "type": "object" }, "AppAnalyzeGoogleAdsHealthMetricsSchema": { "required": [ "cost", "clicks", "impressions", "conversions", "conversionValue", "cpa", "roas", "ctr", "cpc", "convRate" ], "properties": { "cost": { "type": "number", "format": "float" }, "clicks": { "type": "integer" }, "impressions": { "type": "integer" }, "conversions": { "type": "number", "format": "float" }, "conversionValue": { "type": "number", "format": "float" }, "cpa": { "type": "number", "format": "float" }, "roas": { "type": "number", "format": "float" }, "ctr": { "type": "number", "format": "float" }, "cpc": { "type": "number", "format": "float" }, "convRate": { "type": "number", "format": "float" } }, "type": "object" }, "AppAnalyzeGoogleAdsReportingEditorResponseSchema": { "required": [ "delete", "update", "create" ], "properties": { "delete": { "type": "array", "items": { "type": "integer" } }, "update": { "type": "array", "items": { "type": "integer" } }, "create": { "type": "array", "items": { "type": "integer" } } }, "type": "object" }, "AppAnalyzeGoogleAdsReportingRowSchema": { "type": "object", "additionalProperties": {} }, "AppAuthGatewayTokenSchema": { "required": [ "userId", "accessToken" ], "properties": { "userId": { "type": "integer" }, "accessToken": { "type": "string" } }, "type": "object" }, "AppAuthProfileSchema": { "required": [ "id", "hasPassword", "hasGoogle", "hasFacebook", "hasStripeCustomer", "hasStripeSubscription", "tfaEnabled", "email", "emailVerified", "name", "position", "spend", "goal", "subscriptionPlan", "subscriptionStatus", "subscriptionExpiresAt", "subscriptionAnnual", "subscriptionSkipped" ], "properties": { "id": { "type": "integer" }, "hasPassword": { "type": "boolean" }, "hasGoogle": { "type": "boolean" }, "hasFacebook": { "type": "boolean" }, "hasStripeCustomer": { "type": "boolean" }, "hasStripeSubscription": { "type": "boolean" }, "tfaEnabled": { "type": "boolean" }, "email": { "type": "string", "nullable": true }, "emailVerified": { "type": "boolean" }, "name": { "type": "string", "nullable": true }, "position": { "type": "string", "nullable": true }, "spend": { "type": "string", "nullable": true }, "goal": { "type": "string", "nullable": true }, "subscriptionPlan": { "type": "string", "enum": [ "FREE", "STARTUP", "BUSINESS", "PROFESSIONAL" ] }, "subscriptionStatus": { "type": "string", "enum": [ "TRIAL", "ACTIVE", "CANCELLED" ] }, "subscriptionExpiresAt": { "type": "string", "format": "date-time", "nullable": true }, "subscriptionAnnual": { "type": "boolean", "nullable": true }, "subscriptionSkipped": { "type": "boolean" } }, "type": "object" }, "AppAuthTfaCredentialsSchema": { "required": [ "qr", "secretKey", "recoveryCodes" ], "properties": { "qr": { "type": "string" }, "secretKey": { "type": "string" }, "recoveryCodes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "AppAuthTrustedDeviceSchema": { "required": [ "id", "userId", "userAgent", "validTo", "ip" ], "properties": { "id": { "type": "integer" }, "userId": { "type": "integer" }, "userAgent": { "type": "string", "nullable": true }, "ip": { "type": "string", "nullable": true }, "validTo": { "type": "string", "format": "date-time" } }, "type": "object" }, "AppAutomationConfigFieldSchema": { "required": [ "label", "value", "filledByAi" ], "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "filledByAi": { "type": "boolean" } }, "type": "object" }, "AppAutomationRunSchema": { "required": [ "id", "automationId", "businessId", "automationTitle", "status", "signal", "signalStatus", "signalLabel", "locationLabel", "recommendationId", "recommendationCount", "skipReason", "startedAt", "finishedAt" ], "properties": { "id": { "type": "integer" }, "automationId": { "type": "integer", "nullable": true }, "businessId": { "type": "string", "nullable": true }, "automationTitle": { "type": "string", "nullable": true }, "status": { "type": "string" }, "signal": { "type": "string", "nullable": true }, "signalStatus": { "type": "string", "nullable": true }, "signalLabel": { "type": "string", "nullable": true }, "locationLabel": { "type": "string", "nullable": true }, "recommendationId": { "type": "integer", "nullable": true }, "recommendationCount": { "type": "integer" }, "skipReason": { "type": "string", "nullable": true }, "startedAt": { "type": "string", "nullable": true }, "finishedAt": { "type": "string", "nullable": true } }, "type": "object" }, "AppAutomationSchema": { "required": [ "id", "businessId", "title", "summary", "signal", "trigger", "direction", "deltaPct", "target", "scope", "channels", "guardrails", "confidence", "status", "createdAt" ], "properties": { "id": { "type": "integer" }, "businessId": { "type": "string", "nullable": true }, "title": { "type": "string" }, "summary": { "type": "string", "nullable": true }, "signal": { "type": "string" }, "trigger": { "type": "string", "nullable": true }, "direction": { "type": "string", "enum": [ "increase", "decrease", "pause", "launch" ] }, "deltaPct": { "type": "integer" }, "target": { "type": "string", "nullable": true }, "scope": { "type": "string", "nullable": true }, "channels": { "type": "array", "items": { "type": "string" } }, "guardrails": { "type": "string", "nullable": true }, "confidence": { "type": "string" }, "status": { "type": "string" }, "createdAt": { "type": "string", "nullable": true } }, "type": "object" }, "AppAutomationSpecSchema": { "required": [ "id", "intentText", "title", "summary", "signal", "signalLabel", "trigger", "direction", "deltaPct", "target", "scope", "channels", "guardrails", "requiredConfig", "confidence" ], "properties": { "id": { "type": "string" }, "intentText": { "type": "string" }, "title": { "type": "string" }, "summary": { "type": "string" }, "signal": { "type": "string" }, "signalLabel": { "type": "string" }, "trigger": { "type": "string" }, "direction": { "type": "string", "enum": [ "increase", "decrease", "pause", "launch" ] }, "deltaPct": { "type": "integer" }, "target": { "type": "string" }, "scope": { "type": "string" }, "channels": { "type": "array", "items": { "type": "string" } }, "guardrails": { "type": "string" }, "requiredConfig": { "type": "array", "items": { "$ref": "#/components/schemas/AppAutomationConfigFieldSchema" } }, "confidence": { "type": "string" } }, "type": "object" }, "AppBillingSubscriptionCheckoutSchema": { "required": [ "uri" ], "properties": { "uri": { "type": "string", "nullable": true } }, "type": "object" }, "AppBillingSubscriptionSessionSchema": { "required": [ "uri" ], "properties": { "uri": { "type": "string" } }, "type": "object" }, "AppBillingSubscriptionSchema": { "required": [ "id", "plan", "description", "features", "featured", "amount", "annual", "trial", "sales" ], "properties": { "id": { "type": "integer" }, "plan": { "type": "string", "enum": [ "STARTUP", "BUSINESS", "PROFESSIONAL" ] }, "description": { "type": "string" }, "features": { "type": "array", "items": { "type": "string" } }, "featured": { "type": "boolean" }, "amount": { "type": "number", "format": "float" }, "annual": { "type": "boolean" }, "trial": { "type": "integer", "nullable": true }, "sales": { "type": "boolean" } }, "type": "object" }, "AppCampaignSchema": { "required": [ "id", "name", "channel", "status", "analyzing" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "channel": { "type": "string", "enum": [ "GOOGLE_ADS" ] }, "status": { "type": "string", "enum": [ "ACCESS_PENDING_REQUEST", "ACCESS_PENDING_GRANT", "ACTIVE", "PAUSED" ] }, "analyzing": { "type": "boolean" } }, "type": "object" }, "AppCampaignActivityLogSchema": { "required": [ "id", "message", "createdAt" ], "properties": { "id": { "type": "integer" }, "message": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "AppCampaignActivitySubtaskSchema": { "required": [ "id", "title", "description", "status", "startedAt", "finishedAt", "logs" ], "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": [ "DRAFT", "RECOMMENDATION", "BLOCKED", "PENDING", "PROCESSING", "DONE", "GOAL" ] }, "startedAt": { "type": "string", "format": "date-time", "nullable": true }, "finishedAt": { "type": "string", "format": "date-time", "nullable": true }, "logs": { "type": "array", "items": { "$ref": "#/components/schemas/AppCampaignActivityLogSchema" } } }, "type": "object" }, "AppCampaignActivityTaskSchema": { "required": [ "id", "campaignId", "parentId", "title", "description", "status", "startedAt", "finishedAt", "logs", "subtasks" ], "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": [ "DRAFT", "RECOMMENDATION", "BLOCKED", "PENDING", "PROCESSING", "DONE", "GOAL" ] }, "startedAt": { "type": "string", "format": "date-time", "nullable": true }, "finishedAt": { "type": "string", "format": "date-time", "nullable": true }, "logs": { "type": "array", "items": { "$ref": "#/components/schemas/AppCampaignActivityLogSchema" } }, "subtasks": { "type": "array", "items": { "$ref": "#/components/schemas/AppCampaignActivitySubtaskSchema" } } }, "type": "object" }, "AppCampaignGoogleAdsMetricsReportSchema": { "required": [ "unit", "currencyCode", "metrics", "summary" ], "properties": { "unit": { "type": "string" }, "currencyCode": { "type": "string" }, "metrics": { "type": "array", "items": { "$ref": "#/components/schemas/AppCampaignGoogleAdsMetricsSchema" } }, "summary": { "$ref": "#/components/schemas/AppCampaignGoogleAdsMetricsSummarySchema" } }, "type": "object" }, "AppCampaignGoogleAdsMetricsSchema": { "required": [ "date", "costMicros", "clicks", "conversions", "costPerConversion" ], "properties": { "date": { "type": "string", "format": "date" }, "costMicros": { "type": "integer" }, "clicks": { "type": "integer" }, "conversions": { "type": "number", "format": "float" }, "costPerConversion": { "type": "number", "format": "float" } }, "type": "object" }, "AppCampaignGoogleAdsMetricsSummarySchema": { "required": [ "costMicros", "clicks", "conversions", "costPerConversion" ], "properties": { "costMicros": { "type": "integer" }, "clicks": { "type": "integer" }, "conversions": { "type": "number", "format": "float" }, "costPerConversion": { "type": "number", "format": "float" } }, "type": "object" }, "AppCreateGoogleAdsKeywordPlannerKeywordSchema": { "required": [ "id", "text", "lowTopOfPageBid", "highTopOfPageBid", "competition", "avgMonthlySearches", "score", "selected" ], "properties": { "id": { "type": "integer" }, "text": { "type": "string" }, "lowTopOfPageBid": { "type": "integer", "nullable": true }, "highTopOfPageBid": { "type": "integer", "nullable": true }, "competition": { "type": "integer", "nullable": true }, "avgMonthlySearches": { "type": "integer", "nullable": true }, "score": { "type": "integer", "nullable": true }, "selected": { "type": "boolean" } }, "type": "object" }, "AppCreateGoogleAdsKeywordPlannerSchema": { "required": [ "id", "url", "language", "locations", "keywordSeed", "prompt", "status", "keywords" ], "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "language": { "type": "integer", "nullable": true }, "locations": { "type": "array", "items": { "type": "integer" } }, "keywordSeed": { "type": "array", "items": { "type": "string" } }, "prompt": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": [ "QUEUED", "PROCESSING", "SUCCESSFUL", "FAILED" ] }, "keywords": { "type": "array", "items": { "$ref": "#/components/schemas/AppCreateGoogleAdsKeywordPlannerKeywordSchema" } } }, "type": "object" }, "AppCreateGoogleAdsRsaBuilderSchema": { "required": [ "id", "url", "prompt", "status", "headlines", "descriptions" ], "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "prompt": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": [ "QUEUED", "PROCESSING", "SUCCESSFUL" ] }, "headlines": { "type": "array", "items": { "type": "string" } }, "descriptions": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "AppCreateGoogleAdsSearchCreationDraftKeywordSchema": { "required": [ "id", "text", "lowTopOfPageBid", "highTopOfPageBid", "competition", "avgMonthlySearches", "score", "selected" ], "properties": { "id": { "type": "integer" }, "text": { "type": "string" }, "lowTopOfPageBid": { "type": "integer", "nullable": true }, "highTopOfPageBid": { "type": "integer", "nullable": true }, "competition": { "type": "integer", "nullable": true }, "avgMonthlySearches": { "type": "integer", "nullable": true }, "score": { "type": "integer", "nullable": true }, "selected": { "type": "boolean" } }, "type": "object" }, "AppCreateGoogleAdsSearchCreationDraftSchema": { "required": [ "id", "linkingId", "linkingName", "linkingCurrencyCode", "campaignId", "status", "url", "prompt", "languages", "locations", "excludedLocations", "proximities", "headlines", "descriptions", "headlineSuggestions", "descriptionSuggestions", "keywords", "budgetAmount" ], "properties": { "id": { "type": "integer" }, "linkingId": { "type": "integer", "nullable": true }, "linkingName": { "type": "string", "nullable": true }, "linkingCurrencyCode": { "type": "string", "nullable": true }, "campaignId": { "type": "integer", "nullable": true }, "status": { "type": "string", "enum": [ "IDLE", "BUILD_QUEUED", "BUILD_PROCESSING", "PUBLISH_QUEUED", "PUBLISH_PROCESSING", "PUBLISHED", "PARTIALLY_PUBLISHED" ] }, "url": { "type": "string", "nullable": true }, "prompt": { "type": "string", "nullable": true }, "languages": { "type": "array", "items": { "type": "integer" } }, "locations": { "type": "array", "items": { "type": "integer" } }, "excludedLocations": { "type": "array", "items": { "type": "integer" } }, "proximities": { "type": "array", "items": { "type": "object" } }, "headlines": { "type": "array", "items": { "type": "string" } }, "descriptions": { "type": "array", "items": { "type": "string" } }, "headlineSuggestions": { "type": "array", "items": { "type": "string" } }, "descriptionSuggestions": { "type": "array", "items": { "type": "string" } }, "keywords": { "type": "array", "items": { "$ref": "#/components/schemas/AppCreateGoogleAdsSearchCreationDraftKeywordSchema" } }, "budgetAmount": { "type": "integer", "nullable": true } }, "type": "object" }, "AppCreateGoogleAdsSearchCreationStatusSchema": { "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "IDLE", "BUILD_QUEUED", "BUILD_PROCESSING", "PUBLISH_QUEUED", "PUBLISH_PROCESSING", "PUBLISHED", "PARTIALLY_PUBLISHED" ] } }, "type": "object" }, "AppCreateGoogleAdsSitelinkBuilderSchema": { "required": [ "id", "url", "status", "sitelinks" ], "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "status": { "type": "string", "enum": [ "QUEUED", "PROCESSING", "SUCCESSFUL" ] }, "sitelinks": { "type": "array", "items": { "$ref": "#/components/schemas/AppCreateGoogleAdsSitelinkBuilderSitelinkSchema" } } }, "type": "object" }, "AppCreateGoogleAdsSitelinkBuilderSitelinkSchema": { "required": [ "id", "finalUrl", "linkText", "description1", "description2" ], "properties": { "id": { "type": "integer" }, "finalUrl": { "type": "string" }, "linkText": { "type": "string" }, "description1": { "type": "string", "nullable": true }, "description2": { "type": "string", "nullable": true } }, "type": "object" }, "AppLinkingBusinessProfileSchema": { "required": [ "id", "accountName", "accountDisplayName", "accountType", "locationCount", "photoCount", "logoUrl", "locations", "mediaItems", "lastSyncedAt" ], "properties": { "id": { "type": "integer" }, "accountName": { "type": "string" }, "accountDisplayName": { "type": "string", "nullable": true }, "accountType": { "type": "string", "nullable": true }, "locationCount": { "type": "integer" }, "photoCount": { "type": "integer" }, "logoUrl": { "type": "string", "nullable": true }, "locations": { "type": "array", "items": { "type": "object" } }, "mediaItems": { "type": "array", "items": { "type": "object" } }, "lastSyncedAt": { "type": "string", "nullable": true } }, "type": "object" }, "AppLinkingGoogleAdsHierarchySchema": { "required": [ "id", "name", "customerId", "readableCustomerId", "loginCustomerId", "currencyCode", "descriptiveName", "isManager", "children" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "customerId": { "type": "integer" }, "readableCustomerId": { "type": "string" }, "loginCustomerId": { "type": "integer", "nullable": true }, "currencyCode": { "type": "string", "nullable": true }, "descriptiveName": { "type": "string", "nullable": true }, "isManager": { "type": "boolean" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/AppLinkingGoogleAdsHierarchySchema" } } }, "type": "object" }, "AppLinkingGoogleAdsSchema": { "required": [ "id", "name", "customerId", "readableCustomerId", "loginCustomerId", "currencyCode", "descriptiveName", "isManager" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "customerId": { "type": "integer" }, "readableCustomerId": { "type": "string" }, "loginCustomerId": { "type": "integer", "nullable": true }, "currencyCode": { "type": "string", "nullable": true }, "descriptiveName": { "type": "string", "nullable": true }, "isManager": { "type": "boolean" } }, "type": "object" }, "AppLinkingMerchantCenterSchema": { "required": [ "id", "merchantCenterId", "aggregatorId", "name", "websiteUrl" ], "properties": { "id": { "type": "integer" }, "merchantCenterId": { "type": "integer" }, "aggregatorId": { "type": "integer", "nullable": true }, "name": { "type": "string", "nullable": true }, "websiteUrl": { "type": "string", "nullable": true } }, "type": "object" }, "AppLinkingMetaAccountSchema": { "required": [ "id", "externalId", "accountId", "name", "currency", "timezoneName", "accountStatus", "selected" ], "properties": { "id": { "type": "integer" }, "externalId": { "type": "string" }, "accountId": { "type": "string" }, "name": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true }, "timezoneName": { "type": "string", "nullable": true }, "accountStatus": { "type": "integer", "nullable": true }, "selected": { "type": "boolean" } }, "type": "object" }, "AppLinkingMetaSchema": { "required": [ "id", "externalUserId", "name", "status", "scopes", "accountsCount", "selectedAccount" ], "properties": { "id": { "type": "integer" }, "externalUserId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "status": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "accountsCount": { "type": "integer" }, "selectedAccount": { "oneOf": [ { "$ref": "#/components/schemas/AppLinkingMetaAccountSchema" } ], "nullable": true } }, "type": "object" }, "AppLookupGoogleAdsCampaignSchema": { "required": [ "id", "name", "status" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "status": { "type": "integer" }, "cost30d": { "description": "Spend over the last 30 days, account currency", "type": "number", "format": "float" }, "currencyCode": { "type": "string", "nullable": true } }, "type": "object" }, "AppLookupGoogleAdsGeoTargetConstantSchema": { "required": [ "id", "resourceName", "name", "canonicalName", "countryCode", "targetType" ], "properties": { "id": { "type": "integer" }, "resourceName": { "type": "string" }, "name": { "type": "string" }, "canonicalName": { "type": "string" }, "countryCode": { "type": "string" }, "targetType": { "type": "string" }, "reach": { "type": "integer", "nullable": true } }, "type": "object" }, "AppLookupGoogleAdsLanguageConstantSchema": { "required": [ "id", "code", "name" ], "properties": { "id": { "type": "integer" }, "code": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "AppProjectAccountSchema": { "required": [ "id", "accountableId", "channel", "role" ], "properties": { "id": { "type": "integer" }, "accountableId": { "type": "integer" }, "channel": { "type": "string" }, "role": { "type": "string" }, "label": { "type": "string", "nullable": true }, "sublabel": { "type": "string", "nullable": true }, "ref": { "type": "string", "nullable": true }, "spendMtdCents": { "description": "Month-to-date spend, USD cents; null = unknown (Yelp without Reporting API, or no Google snapshot / several Google accounts)", "type": "integer", "nullable": true } }, "type": "object" }, "AppProjectLinkSuggestionSchema": { "required": [ "channel", "accountableId", "reason", "confidence" ], "properties": { "channel": { "type": "string" }, "accountableId": { "type": "integer" }, "label": { "type": "string", "nullable": true }, "sublabel": { "type": "string", "nullable": true }, "ref": { "type": "string", "nullable": true }, "reason": { "type": "string" }, "confidence": { "type": "number", "format": "float" } }, "type": "object" }, "AppProjectSchema": { "required": [ "id", "name", "status", "channels", "accountCount", "spendMtdCents", "leadsMtd", "googleAdsSpendMtdCents", "googleAdsLeadsMtd", "yelpSpendMtdCents", "yelpLeadsMtd", "accounts", "disabledYelpAccounts" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "verticalId": { "type": "string", "nullable": true }, "verticalLabel": { "type": "string", "nullable": true }, "verticalSource": { "type": "string", "nullable": true }, "verticals": { "type": "array", "items": { "type": "object" } }, "status": { "type": "string" }, "website": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "monthlyBudget": { "type": "string", "nullable": true }, "channels": { "type": "array", "items": { "type": "string" } }, "accountCount": { "type": "integer" }, "spendMtdCents": { "type": "integer" }, "leadsMtd": { "type": "integer" }, "googleAdsSpendMtdCents": { "description": "Google Ads share of spendMtdCents, USD cents (from the reporting snapshot)", "type": "integer" }, "googleAdsLeadsMtd": { "description": "Google Ads share of leadsMtd", "type": "integer" }, "yelpSpendMtdCents": { "description": "Yelp share of spendMtdCents, USD cents; null = no Yelp account with Reporting API data", "type": "integer", "nullable": true }, "yelpLeadsMtd": { "description": "Yelp share of leadsMtd; null = no Yelp account with Reporting API data", "type": "integer", "nullable": true }, "accounts": { "type": "array", "items": { "$ref": "#/components/schemas/AppProjectAccountSchema" } }, "disabledYelpAccounts": { "description": "Yelp businesses linked to the project but switched off in Optimyzee (hidden from accounts)", "type": "array", "items": { "$ref": "#/components/schemas/AppProjectAccountSchema" } } }, "type": "object" }, "AppRecommendationSchema": { "required": [ "id", "businessId", "businessName", "domain", "title", "rationale", "direction", "action", "deltaPct", "service", "confidence", "status", "source", "createdAt", "acceptedAt", "dismissedAt", "outcomeCheckedAt", "outcomeWindowDays", "outcomeMetrics", "yelpAdsJobId", "yelpAdsJobStatus", "yelpAdsJobProgramRef", "yelpAdsJobMessage" ], "properties": { "id": { "type": "integer" }, "businessId": { "type": "string", "nullable": true }, "businessName": { "type": "string", "nullable": true }, "domain": { "type": "string" }, "title": { "type": "string" }, "rationale": { "type": "string" }, "direction": { "type": "string", "enum": [ "increase", "decrease", "hold", "action", "pause", "launch" ] }, "action": { "type": "string", "enum": [ "budget_adjustment", "program_pause", "program_resume", "program_create" ], "nullable": true }, "deltaPct": { "type": "integer", "nullable": true }, "service": { "type": "string", "nullable": true }, "confidence": { "type": "string" }, "status": { "type": "string" }, "source": { "type": "string" }, "createdAt": { "type": "string", "nullable": true }, "acceptedAt": { "type": "string", "nullable": true }, "dismissedAt": { "type": "string", "nullable": true }, "outcomeCheckedAt": { "type": "string", "nullable": true }, "outcomeWindowDays": { "type": "integer", "nullable": true }, "outcomeMetrics": { "type": "object", "nullable": true }, "yelpAdsJobId": { "type": "integer", "nullable": true }, "yelpAdsJobStatus": { "type": "string", "nullable": true }, "yelpAdsJobProgramRef": { "type": "string", "nullable": true }, "yelpAdsJobMessage": { "type": "string", "nullable": true } }, "type": "object" }, "AppDaypartingCurveSchema": { "required": [ "vertical", "hasData", "geoMatched", "metro", "byDay", "byHour" ], "properties": { "vertical": { "type": "string", "nullable": true }, "hasData": { "type": "boolean" }, "geoMatched": { "type": "boolean" }, "metro": { "type": "string", "nullable": true }, "byDay": { "type": "array", "items": { "$ref": "#/components/schemas/AppDaypartingDaySchema" } }, "byHour": { "type": "array", "items": { "$ref": "#/components/schemas/AppDaypartingHourSchema" } } }, "type": "object" }, "AppDaypartingDaySchema": { "required": [ "dow", "dayName", "demandIndex", "costPerLead", "leads" ], "properties": { "dow": { "type": "integer" }, "dayName": { "type": "string" }, "demandIndex": { "type": "number", "format": "float" }, "costPerLead": { "type": "number", "format": "float", "nullable": true }, "leads": { "type": "integer" } }, "type": "object" }, "AppDaypartingHourSchema": { "required": [ "hour", "demandIndex", "leads" ], "properties": { "hour": { "type": "integer" }, "demandIndex": { "type": "number", "format": "float" }, "leads": { "type": "integer" } }, "type": "object" }, "AppMarketInsightsSchema": { "required": [ "vertical", "hasData", "byLocation", "byTemperature" ], "properties": { "vertical": { "type": "string", "nullable": true }, "hasData": { "type": "boolean" }, "byLocation": { "type": "array", "items": { "$ref": "#/components/schemas/AppMarketLocationSchema" } }, "byTemperature": { "type": "array", "items": { "$ref": "#/components/schemas/AppMarketTemperatureSchema" } } }, "type": "object" }, "AppMarketLocationSchema": { "required": [ "metro", "costPerLead", "leads", "physicalPct" ], "properties": { "metro": { "type": "string" }, "costPerLead": { "type": "number", "format": "float", "nullable": true }, "leads": { "type": "integer" }, "physicalPct": { "type": "number", "format": "float", "nullable": true } }, "type": "object" }, "AppMarketTemperatureSchema": { "required": [ "bucket", "cvrPct", "costPerLead", "leads" ], "properties": { "bucket": { "type": "string" }, "cvrPct": { "type": "number", "format": "float", "nullable": true }, "costPerLead": { "type": "number", "format": "float", "nullable": true }, "leads": { "type": "integer" } }, "type": "object" }, "AppSignalReadingSchema": { "required": [ "connectorId", "label", "value", "status", "cost", "detail", "error" ], "properties": { "connectorId": { "type": "string" }, "label": { "type": "string" }, "value": { "type": "number", "format": "float", "nullable": true }, "status": { "type": "string" }, "cost": { "type": "string" }, "detail": { "type": "string", "nullable": true }, "error": { "type": "boolean" } }, "type": "object" }, "AppTeamInvitationPublicSchema": { "required": [ "teamName", "invitedByName", "email", "role", "expiresAt" ], "properties": { "teamName": { "type": "string" }, "invitedByName": { "type": "string", "nullable": true }, "email": { "type": "string" }, "role": { "type": "string" }, "expiresAt": { "type": "string", "nullable": true } }, "type": "object" }, "AppTeamInvitationSchema": { "required": [ "id", "email", "role", "invitedByName", "expiresAt", "createdAt" ], "properties": { "id": { "type": "integer" }, "email": { "type": "string" }, "role": { "type": "string" }, "invitedByName": { "type": "string", "nullable": true }, "expiresAt": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "nullable": true } }, "type": "object" }, "AppTeamMemberSchema": { "required": [ "userId", "name", "email", "role", "status", "joinedAt" ], "properties": { "userId": { "type": "integer" }, "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "role": { "type": "string" }, "status": { "type": "string" }, "joinedAt": { "type": "string", "nullable": true } }, "type": "object" }, "AppTeamSchema": { "required": [ "id", "name", "personal", "ownerUserId", "myRole", "memberCount", "members" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "personal": { "type": "boolean" }, "ownerUserId": { "type": "integer", "nullable": true }, "myRole": { "type": "string", "nullable": true }, "memberCount": { "type": "integer" }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/AppTeamMemberSchema" } } }, "type": "object" }, "AppTeamSummarySchema": { "required": [ "id", "name", "personal", "myRole", "memberCount" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "personal": { "type": "boolean" }, "myRole": { "type": "string", "nullable": true }, "memberCount": { "type": "integer" } }, "type": "object" }, "AppYelpAdsJobSchema": { "required": [ "id", "recommendationId", "recommendationTitle", "businessId", "businessName", "programRef", "action", "status", "requestedDirection", "requestedDeltaPct", "currentBudgetCents", "targetBudgetCents", "guardrailsPassed", "partnerWriteEnabled", "blockReason", "message", "submittedAt", "checkedAt", "completedAt", "createdAt" ], "properties": { "id": { "type": "integer" }, "recommendationId": { "type": "integer", "nullable": true }, "recommendationTitle": { "type": "string", "nullable": true }, "businessId": { "type": "string", "nullable": true }, "businessName": { "type": "string", "nullable": true }, "programRef": { "type": "string", "nullable": true }, "action": { "type": "string" }, "status": { "type": "string" }, "requestedDirection": { "type": "string", "nullable": true }, "requestedDeltaPct": { "type": "integer", "nullable": true }, "currentBudgetCents": { "type": "integer", "nullable": true }, "targetBudgetCents": { "type": "integer", "nullable": true }, "guardrailsPassed": { "type": "boolean", "nullable": true }, "partnerWriteEnabled": { "type": "boolean", "nullable": true }, "blockReason": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "submittedAt": { "type": "string", "nullable": true }, "checkedAt": { "type": "string", "nullable": true }, "completedAt": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "nullable": true } }, "type": "object" }, "AppYelpProgramAutopilotSchema": { "required": [ "programId", "businessId", "enabled", "eomBoostEnabled", "eomBoostDays", "pauseDaysEnabled", "pauseWeekdays", "manualPauseEnabled", "manualPauseDates", "priority", "lastEvaluatedAt", "lastAction", "lastActionAt", "lastJobId", "lastError", "updatedAt" ], "properties": { "programId": { "type": "string" }, "businessId": { "type": "string", "nullable": true }, "enabled": { "description": "Derived: at least one rule is switched on", "type": "boolean" }, "eomBoostEnabled": { "type": "boolean" }, "eomBoostDays": { "type": "integer", "nullable": true }, "pauseDaysEnabled": { "type": "boolean" }, "pauseWeekdays": { "description": "0 = Sunday ... 6 = Saturday", "type": "array", "items": { "type": "integer" } }, "manualPauseEnabled": { "type": "boolean" }, "manualPauseDates": { "type": "array", "items": { "type": "string", "format": "date" } }, "priority": { "type": "string", "enum": [ "boost", "pause" ] }, "lastEvaluatedAt": { "type": "string", "nullable": true }, "lastAction": { "type": "string", "enum": [ "pause", "resume" ], "nullable": true }, "lastActionAt": { "type": "string", "nullable": true }, "lastJobId": { "type": "integer", "nullable": true }, "lastError": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true } }, "type": "object" }, "AppYelpAutoresponderMessageSchema": { "required": [ "id", "autoresponderId", "businessId", "flow", "position", "delaySeconds", "body", "enabled", "onlyIfNoReply", "reviewRequired", "businessHoursOnly", "createdAt", "updatedAt" ], "properties": { "id": { "type": "integer" }, "autoresponderId": { "type": "integer", "nullable": true }, "businessId": { "type": "string" }, "flow": { "type": "string" }, "position": { "type": "integer" }, "delaySeconds": { "type": "integer" }, "body": { "type": "string" }, "enabled": { "type": "boolean" }, "onlyIfNoReply": { "type": "boolean" }, "reviewRequired": { "type": "boolean" }, "businessHoursOnly": { "type": "boolean" }, "createdAt": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true } }, "type": "object" }, "AppYelpAutoresponderRunSchema": { "required": [ "id", "autoresponderId", "leadId", "businessId", "businessName", "consumer", "leadStatus", "status", "skipReason", "message", "sendEnabled", "replyDraftId", "replyDraftStatus", "replyDraftBody", "replyDraftMessage", "delayPhase", "delayBaseAt", "eligibleAt", "delayMinutes", "waitingSeconds", "queuedAt", "approvedAt", "rejectedAt", "sentAt" ], "properties": { "id": { "type": "integer" }, "autoresponderId": { "type": "integer", "nullable": true }, "leadId": { "type": "string" }, "businessId": { "type": "string", "nullable": true }, "businessName": { "type": "string", "nullable": true }, "consumer": { "type": "string", "nullable": true }, "leadStatus": { "type": "string", "nullable": true }, "status": { "type": "string" }, "skipReason": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "sendEnabled": { "type": "boolean" }, "replyDraftId": { "type": "integer", "nullable": true }, "replyDraftStatus": { "type": "string", "nullable": true }, "replyDraftBody": { "type": "string", "nullable": true }, "replyDraftMessage": { "type": "string", "nullable": true }, "delayPhase": { "type": "string", "nullable": true }, "delayBaseAt": { "type": "string", "nullable": true }, "eligibleAt": { "type": "string", "nullable": true }, "delayMinutes": { "type": "integer", "nullable": true }, "waitingSeconds": { "type": "integer", "nullable": true }, "queuedAt": { "type": "string", "nullable": true }, "approvedAt": { "type": "string", "nullable": true }, "rejectedAt": { "type": "string", "nullable": true }, "sentAt": { "type": "string", "nullable": true } }, "type": "object" }, "AppYelpAutoresponderRunUpdatePayload": { "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "approved", "rejected" ] }, "body": { "type": "string", "nullable": true } }, "type": "object" }, "AppYelpAutoresponderRunSendPayload": { "properties": { "body": { "type": "string", "nullable": true } }, "type": "object" }, "AppYelpAutoresponderSchema": { "required": [ "id", "businessId", "businessName", "status", "connectionStatus", "sendEnabled", "tone", "firstMessageBody", "sequenceMessages", "sequenceSize", "stopwords", "notifyNewLead", "notifyDraftReady", "notificationMode", "notificationEmail", "offHoursEnabled", "timezone", "businessHours", "calendarIntegrationEnabled", "googleCalendarConnected", "googleCalendarId", "googleCalendarName", "googleCalendarTimezone", "calendarAppointmentMinutes", "calendarMinNoticeMinutes", "calendarBufferMinutes", "googleCalendarTokenExpiresAt", "googleCalendarConnectedAt", "leadExportWebhookEnabled", "leadExportWebhookUrl", "leadExportWebhookSecret", "conversationsCount", "message", "activatedAt", "deactivatedAt", "lastCheckedAt" ], "properties": { "id": { "type": "integer" }, "businessId": { "type": "string" }, "businessName": { "type": "string", "nullable": true }, "status": { "type": "string" }, "connectionStatus": { "type": "string" }, "sendEnabled": { "type": "boolean" }, "tone": { "type": "string" }, "firstMessageBody": { "type": "string", "nullable": true }, "sequenceMessages": { "type": "array", "items": { "type": "string" } }, "sequenceSize": { "type": "integer" }, "stopwords": { "type": "array", "items": { "type": "string" } }, "notifyNewLead": { "type": "boolean" }, "notifyDraftReady": { "type": "boolean" }, "notificationMode": { "type": "string", "enum": [ "off", "every_interaction", "new_conversation", "phone_detected" ] }, "notificationEmail": { "type": "string", "nullable": true }, "offHoursEnabled": { "type": "boolean" }, "timezone": { "type": "string", "nullable": true }, "businessHours": { "type": "object" }, "calendarIntegrationEnabled": { "type": "boolean" }, "googleCalendarConnected": { "type": "boolean" }, "googleCalendarId": { "type": "string", "nullable": true }, "googleCalendarName": { "type": "string", "nullable": true }, "googleCalendarTimezone": { "type": "string", "nullable": true }, "calendarAppointmentMinutes": { "type": "integer" }, "calendarMinNoticeMinutes": { "type": "integer" }, "calendarBufferMinutes": { "type": "integer" }, "googleCalendarTokenExpiresAt": { "type": "string", "nullable": true }, "googleCalendarConnectedAt": { "type": "string", "nullable": true }, "leadExportWebhookEnabled": { "type": "boolean" }, "leadExportWebhookUrl": { "type": "string", "nullable": true }, "leadExportWebhookSecret": { "type": "string", "nullable": true }, "conversationsCount": { "type": "integer" }, "message": { "type": "string", "nullable": true }, "activatedAt": { "type": "string", "nullable": true }, "deactivatedAt": { "type": "string", "nullable": true }, "lastCheckedAt": { "type": "string", "nullable": true }, "telegramConnected": { "type": "boolean" }, "telegramChatId": { "type": "string", "nullable": true }, "telegramConnectedAt": { "type": "string", "nullable": true }, "telegramDeepLink": { "description": "Bot deep link the client taps to connect their chat", "type": "string", "nullable": true }, "telegramChats": { "type": "array", "items": { "properties": { "id": { "type": "integer", "nullable": true }, "chatId": { "type": "string" }, "chatType": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "connectedAt": { "type": "string", "nullable": true }, "lastSeenAt": { "type": "string", "nullable": true } }, "type": "object" } } }, "type": "object" }, "AppYelpBusinessSchema": { "required": [ "id", "yelpBusinessId", "partnerBusinessId", "name", "city", "state", "rating", "reviewCount", "status", "activePrograms", "spendMtdCents", "leadsMtd", "lastSyncedAt", "serviceTags", "categories", "addressLines", "phone", "yelpUrl", "imageUrl", "vertical", "verticalLabel", "verticalSource", "aiProfileSummary", "aiServiceFocus", "aiDemandTriggers", "aiRecommendedSignals", "aiCustomerIntentNotes", "aiProfileSource", "aiProfileGeneratedAt", "latestListingUpdate", "enabled", "enabledAt", "spendMtdAvailable" ], "properties": { "id": { "type": "string" }, "yelpBusinessId": { "type": "string", "nullable": true }, "partnerBusinessId": { "type": "string", "nullable": true }, "name": { "type": "string" }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "rating": { "type": "number", "format": "float", "nullable": true }, "reviewCount": { "type": "integer" }, "status": { "type": "string" }, "activePrograms": { "type": "integer" }, "spendMtdCents": { "type": "integer" }, "leadsMtd": { "type": "integer" }, "lastSyncedAt": { "type": "string", "nullable": true }, "serviceTags": { "type": "array", "items": { "type": "string" } }, "categories": { "type": "array", "items": { "type": "string" } }, "addressLines": { "type": "array", "items": { "type": "string" } }, "phone": { "type": "string", "nullable": true }, "yelpUrl": { "type": "string", "nullable": true }, "imageUrl": { "type": "string", "nullable": true }, "vertical": { "type": "string" }, "verticalLabel": { "type": "string" }, "verticalSource": { "type": "string", "nullable": true }, "aiProfileSummary": { "type": "string", "nullable": true }, "aiServiceFocus": { "type": "array", "items": { "type": "string" } }, "aiDemandTriggers": { "type": "array", "items": { "type": "string" } }, "aiRecommendedSignals": { "type": "array", "items": { "type": "string" } }, "aiCustomerIntentNotes": { "type": "string", "nullable": true }, "aiProfileSource": { "type": "string", "nullable": true }, "aiProfileGeneratedAt": { "type": "string", "nullable": true }, "latestListingUpdate": { "type": "object", "nullable": true }, "enabled": { "description": "Managed in Optimyzee. Disabled businesses are skipped by every feature.", "type": "boolean" }, "enabledAt": { "type": "string", "nullable": true }, "spendMtdAvailable": { "description": "True when spendMtdCents/leadsMtd come from Reporting API daily rows; false = no reporting (show as unknown, not $0)", "type": "boolean" } }, "type": "object" }, "AppYelpBusinessSignalSettingSchema": { "required": [ "signal", "enabled", "updatedAt" ], "properties": { "signal": { "type": "string" }, "enabled": { "type": "boolean" }, "updatedAt": { "type": "string", "nullable": true } }, "type": "object" }, "AppYelpConnectionSchema": { "required": [ "id", "label", "connected", "hasReportingApiKey", "hasLeadsOAuth", "pauseResumeAutoPilot", "healthStatus", "healthMessage", "lastCheckedAt", "createdAt", "updatedAt" ], "properties": { "id": { "type": "integer" }, "label": { "type": "string", "nullable": true }, "partnerUsername": { "type": "string", "nullable": true }, "connected": { "type": "boolean" }, "hasReportingApiKey": { "type": "boolean" }, "hasLeadsOAuth": { "type": "boolean" }, "pauseResumeAutoPilot": { "type": "boolean" }, "healthStatus": { "type": "string", "nullable": true }, "healthMessage": { "type": "string", "nullable": true }, "lastCheckedAt": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true } }, "type": "object" }, "AppYelpLeadSchema": { "required": [ "id", "businessId", "businessName", "conversationId", "consumer", "type", "excerpt", "status", "responseMinutes", "createdAt", "lastEventAt", "conversationMessages", "timelineEvents", "replyDraftId", "replyDraftStatus", "replyDraftBody", "replyDraftMessage", "replyDraftGeneratedAt" ], "properties": { "id": { "type": "string" }, "businessId": { "type": "string", "nullable": true }, "businessName": { "type": "string", "nullable": true }, "conversationId": { "type": "string", "nullable": true }, "consumer": { "type": "string", "nullable": true }, "type": { "type": "string" }, "excerpt": { "type": "string", "nullable": true }, "status": { "type": "string" }, "responseMinutes": { "type": "integer", "nullable": true }, "createdAt": { "type": "string", "nullable": true }, "lastEventAt": { "type": "string", "nullable": true }, "conversationMessages": { "type": "array", "items": { "type": "object" } }, "timelineEvents": { "type": "array", "items": { "type": "object" } }, "replyDraftId": { "type": "integer", "nullable": true }, "replyDraftStatus": { "type": "string", "nullable": true }, "replyDraftBody": { "type": "string", "nullable": true }, "replyDraftMessage": { "type": "string", "nullable": true }, "replyDraftGeneratedAt": { "type": "string", "nullable": true }, "assignedUserId": { "type": "integer", "nullable": true }, "assignedUserName": { "type": "string", "nullable": true }, "claimedAt": { "type": "string", "nullable": true }, "phoneShared": { "type": "boolean" }, "sharedPhone": { "type": "string", "nullable": true }, "phoneSource": { "description": "opt_in | conversation", "type": "string", "nullable": true }, "emailShared": { "type": "boolean" }, "sharedEmail": { "type": "string", "nullable": true }, "emailSource": { "description": "opt_in | conversation", "type": "string", "nullable": true }, "businessTimezone": { "description": "IANA timezone of the business (autoresponder setting, else its US state) — show lead times in the client's local clock", "type": "string", "nullable": true } }, "type": "object" }, "AppYelpProgramSchema": { "required": [ "id", "businessId", "businessName", "type", "status", "pauseStatus", "startDate", "endDate", "budgetCents", "spendMtdCents", "billedClicks", "billedImpressions", "avgCpcCents", "maxBidCents", "pacingMethod", "adCategories", "feePeriod", "autoPilot", "features", "rejectionReason", "lastSyncedAt", "title" ], "properties": { "id": { "type": "string" }, "businessId": { "type": "string", "nullable": true }, "businessName": { "type": "string", "nullable": true }, "type": { "type": "string" }, "status": { "type": "string" }, "pauseStatus": { "type": "string", "nullable": true }, "startDate": { "type": "string", "nullable": true }, "endDate": { "type": "string", "nullable": true }, "budgetCents": { "type": "integer" }, "spendMtdCents": { "type": "integer" }, "billedClicks": { "type": "integer" }, "billedImpressions": { "type": "integer" }, "avgCpcCents": { "type": "integer" }, "maxBidCents": { "type": "integer", "nullable": true }, "pacingMethod": { "type": "string", "nullable": true }, "adCategories": { "type": "array", "items": { "type": "string" } }, "feePeriod": { "type": "string", "nullable": true }, "autoPilot": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "rejectionReason": { "type": "string", "nullable": true }, "lastSyncedAt": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true } }, "type": "object" }, "AppYelpReportingBusinessMetricSchema": { "description": "Per-business profile + engagement metrics for the Data Explorer's Business\nMetrics section. Rating/reviewCount come from the business profile; the rest\nare summed from the daily reporting rows over the queried window.", "properties": { "businessRef": { "type": "string" }, "businessName": { "type": "string" }, "rating": { "type": "number", "format": "float", "nullable": true }, "reviewCount": { "type": "integer", "nullable": true }, "pageViews": { "type": "integer" }, "websiteClicks": { "type": "integer" }, "calls": { "type": "integer" }, "raqMessages": { "type": "integer" }, "billableImpressions": { "type": "integer" }, "billableClicks": { "type": "integer" }, "spendCents": { "type": "integer" } }, "type": "object" }, "AppYelpReportingDailyPointSchema": { "properties": { "date": { "type": "string" }, "spendCents": { "type": "integer" }, "leads": { "type": "integer" }, "billableClicks": { "type": "integer" }, "billableImpressions": { "type": "integer" }, "calls": { "type": "integer" }, "raqMessages": { "type": "integer" }, "websiteClicks": { "type": "integer" }, "pageViews": { "type": "integer" } }, "type": "object" }, "AppYelpReportingKpiSchema": { "properties": { "totalSpendCents": { "type": "integer" }, "totalLeads": { "type": "integer" }, "costPerLeadCents": { "type": "integer" }, "ctr": { "type": "number", "format": "float" }, "avgCpcCents": { "type": "integer" }, "billableClicks": { "type": "integer" }, "billableImpressions": { "type": "integer" }, "calls": { "type": "integer" }, "raqMessages": { "type": "integer" }, "websiteClicks": { "type": "integer" }, "pageViews": { "type": "integer" } }, "type": "object" }, "AppYelpReportingLeadBreakdownSliceSchema": { "properties": { "label": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "AppYelpReportingLeadLocationSchema": { "properties": { "postalCode": { "type": "string" }, "leads": { "type": "integer" } }, "type": "object" }, "AppYelpReportingLeadLocationsSchema": { "description": "Leads grouped by the customer's ZIP from the Yelp request payload\n(lead.project.location.postal_code). `items` holds the top ZIPs only;\n`total` counts every lead in the window and `unknown` those without a ZIP.", "required": [ "total", "unknown", "items" ], "properties": { "total": { "type": "integer" }, "unknown": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/AppYelpReportingLeadLocationSchema" } } }, "type": "object" }, "AppYelpReportingSchema": { "required": [ "kpis", "leadBreakdown", "daily", "businesses", "leadLocations" ], "properties": { "kpis": { "$ref": "#/components/schemas/AppYelpReportingKpiSchema" }, "leadBreakdown": { "type": "array", "items": { "$ref": "#/components/schemas/AppYelpReportingLeadBreakdownSliceSchema" } }, "daily": { "type": "array", "items": { "$ref": "#/components/schemas/AppYelpReportingDailyPointSchema" } }, "businesses": { "type": "array", "items": { "$ref": "#/components/schemas/AppYelpReportingBusinessMetricSchema" } }, "leadLocations": { "$ref": "#/components/schemas/AppYelpReportingLeadLocationsSchema" } }, "type": "object" }, "AppYelpSyncRunSchema": { "required": [ "id", "type", "source", "status", "startedAt", "finishedAt", "importedCount", "failedCount", "errorMessage", "createdAt" ], "properties": { "id": { "type": "integer" }, "type": { "type": "string" }, "source": { "type": "string" }, "status": { "type": "string" }, "startedAt": { "type": "string", "nullable": true }, "finishedAt": { "type": "string", "nullable": true }, "importedCount": { "type": "integer" }, "failedCount": { "type": "integer" }, "errorMessage": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "nullable": true } }, "type": "object" }, "OperationsAdminSchema": { "required": [ "id", "email", "name", "permissions" ], "properties": { "id": { "type": "integer" }, "email": { "type": "string" }, "name": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "MANAGE_USERS", "MANAGE_BILLING_SUBSCRIPTIONS", "MANAGE_CAMPAIGNS", "MANAGE_ADMINS" ] } } }, "type": "object" }, "OperationsAuthGatewayTokenSchema": { "required": [ "adminId", "accessToken" ], "properties": { "adminId": { "type": "integer" }, "accessToken": { "type": "string" } }, "type": "object" }, "OperationsAuthProfileSchema": { "required": [ "id", "email", "name", "permissions" ], "properties": { "id": { "type": "integer" }, "email": { "type": "string" }, "name": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "MANAGE_USERS", "MANAGE_BILLING_SUBSCRIPTIONS", "MANAGE_CAMPAIGNS", "MANAGE_ADMINS" ] } } }, "type": "object" }, "OperationsBillingSubscriptionSchema": { "required": [ "id", "plan", "description", "features", "featured", "stripePriceId", "amount", "annual", "trial", "sales", "legacy" ], "properties": { "id": { "type": "integer" }, "plan": { "type": "string", "enum": [ "STARTUP", "BUSINESS", "PROFESSIONAL" ] }, "description": { "type": "string" }, "features": { "type": "array", "items": { "type": "string" } }, "featured": { "type": "boolean" }, "stripePriceId": { "type": "string" }, "amount": { "type": "number", "format": "float" }, "annual": { "type": "boolean" }, "trial": { "type": "integer", "nullable": true }, "sales": { "type": "boolean" }, "legacy": { "type": "boolean" } }, "type": "object" }, "OperationsCampaignSchema": { "required": [ "id", "adminId", "adminName", "adminEmail", "userId", "userEmail", "userSubscriptionPlan", "userSubscriptionStatus", "name", "status", "analyzing", "googleAdsLinkingId", "googleAdsLinkingCustomerId", "googleAdsLinkingName", "googleAdsCampaignId", "lastManagedAt", "createdAt" ], "properties": { "id": { "type": "integer" }, "adminId": { "type": "integer", "nullable": true }, "adminEmail": { "type": "string", "nullable": true }, "adminName": { "type": "string", "nullable": true }, "userId": { "type": "integer" }, "userEmail": { "type": "string", "nullable": true }, "userSubscriptionPlan": { "type": "string", "enum": [ "FREE", "STARTUP", "BUSINESS", "PROFESSIONAL" ], "nullable": true }, "userSubscriptionStatus": { "type": "string", "enum": [ "TRIAL", "ACTIVE", "CANCELLED" ], "nullable": true }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "ACCESS_PENDING_REQUEST", "ACCESS_PENDING_GRANT", "ACTIVE", "PAUSED" ] }, "analyzing": { "type": "boolean" }, "googleAdsLinkingId": { "type": "integer", "nullable": true }, "googleAdsLinkingCustomerId": { "type": "integer", "nullable": true }, "googleAdsLinkingName": { "type": "string", "nullable": true }, "googleAdsCampaignId": { "type": "integer", "nullable": true }, "lastManagedAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "OperationsCampaignLogSchema": { "required": [ "id", "taskId", "message", "createdAt" ], "properties": { "id": { "type": "integer" }, "taskId": { "type": "integer" }, "message": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "OperationsCampaignTaskSchema": { "required": [ "id", "campaignId", "parentId", "title", "description", "status", "startedAt", "finishedAt", "order", "childrenCount" ], "properties": { "id": { "type": "integer" }, "campaignId": { "type": "integer" }, "parentId": { "type": "integer", "nullable": true }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": [ "DRAFT", "RECOMMENDATION", "BLOCKED", "PENDING", "PROCESSING", "DONE", "GOAL" ] }, "startedAt": { "type": "string", "format": "date-time", "nullable": true }, "finishedAt": { "type": "string", "format": "date-time", "nullable": true }, "order": { "type": "integer" }, "childrenCount": { "type": "integer" } }, "type": "object" }, "OperationsUserTokenSchema": { "required": [ "userId", "accessToken" ], "properties": { "userId": { "type": "integer" }, "accessToken": { "type": "string" } }, "type": "object" }, "OperationsUserSchema": { "required": [ "id", "email", "name", "position", "spend", "goal", "subscriptionPlan", "subscriptionStatus", "subscriptionExpiresAt", "subscriptionAnnual", "subscriptionSkipped" ], "properties": { "id": { "type": "integer" }, "email": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "position": { "type": "string", "nullable": true }, "spend": { "type": "string", "nullable": true }, "goal": { "type": "string", "nullable": true }, "subscriptionPlan": { "type": "string", "enum": [ "FREE", "STARTUP", "BUSINESS", "PROFESSIONAL" ] }, "subscriptionStatus": { "type": "string", "enum": [ "TRIAL", "ACTIVE", "CANCELLED" ] }, "subscriptionExpiresAt": { "type": "string", "format": "date-time", "nullable": true }, "subscriptionAnnual": { "type": "boolean", "nullable": true }, "subscriptionSkipped": { "type": "boolean" } }, "type": "object" } }, "securitySchemes": { "token": { "type": "apiKey", "description": "Bearer token authorization", "name": "authorization", "in": "header" } } }, "tags": [ { "name": "App/Analyze/GoogleAds/Audit", "description": "App/Analyze/GoogleAds/Audit" }, { "name": "App/Analyze/GoogleAds/Health", "description": "App/Analyze/GoogleAds/Health" }, { "name": "App/Analyze/GoogleAds/Optimization", "description": "App/Analyze/GoogleAds/Optimization" }, { "name": "App/Analyze/GoogleAds/Reporting", "description": "App/Analyze/GoogleAds/Reporting" }, { "name": "App/Auth/Email", "description": "App/Auth/Email" }, { "name": "App/Auth/Gateway", "description": "App/Auth/Gateway" }, { "name": "App/Auth/Password", "description": "App/Auth/Password" }, { "name": "App/Auth/Profile", "description": "App/Auth/Profile" }, { "name": "App/Auth/Tfa", "description": "App/Auth/Tfa" }, { "name": "App/Auth/TrustedDevice", "description": "App/Auth/TrustedDevice" }, { "name": "App Automation", "description": "App Automation" }, { "name": "App Automations", "description": "App Automations" }, { "name": "App/Billing/Subscription", "description": "App/Billing/Subscription" }, { "name": "App/Campaign", "description": "App/Campaign" }, { "name": "App/FreeLimit", "description": "App/FreeLimit" }, { "name": "App/Campaign/Activity", "description": "App/Campaign/Activity" }, { "name": "App/Campaign/GoogleAds", "description": "App/Campaign/GoogleAds" }, { "name": "App/Create/GoogleAds/DemandGenCreation", "description": "App/Create/GoogleAds/DemandGenCreation" }, { "name": "App/Create/GoogleAds/KeywordPlanner", "description": "App/Create/GoogleAds/KeywordPlanner" }, { "name": "App/Create/GoogleAds/PMaxCreation", "description": "App/Create/GoogleAds/PMaxCreation" }, { "name": "App/Create/GoogleAds/RsaBuilder", "description": "App/Create/GoogleAds/RsaBuilder" }, { "name": "App/Create/GoogleAds/SearchCreation", "description": "App/Create/GoogleAds/SearchCreation" }, { "name": "App/Create/GoogleAds/SearchCreationAi", "description": "App/Create/GoogleAds/SearchCreationAi" }, { "name": "App/Create/GoogleAds/SitelinkBuilder", "description": "App/Create/GoogleAds/SitelinkBuilder" }, { "name": "App/Linking/GoogleAds", "description": "App/Linking/GoogleAds" }, { "name": "App/Linking/Meta", "description": "App/Linking/Meta" }, { "name": "App/Lookup/GoogleAds/Campaign", "description": "App/Lookup/GoogleAds/Campaign" }, { "name": "App/Lookup/GoogleAds/GeoTargetConstant", "description": "App/Lookup/GoogleAds/GeoTargetConstant" }, { "name": "App/Lookup/GoogleAds/LanguageConstant", "description": "App/Lookup/GoogleAds/LanguageConstant" }, { "name": "App/Lookup/GoogleAds/MerchantCenter", "description": "App/Lookup/GoogleAds/MerchantCenter" }, { "name": "App Project", "description": "App Project" }, { "name": "App Recommendation", "description": "App Recommendation" }, { "name": "App Reporting", "description": "App Reporting" }, { "name": "App Signal", "description": "App Signal" }, { "name": "App/Support", "description": "App/Support" }, { "name": "App Team", "description": "App Team" }, { "name": "App Yelp", "description": "App Yelp" }, { "name": "Operations/Admin", "description": "Operations/Admin" }, { "name": "Operations/Auth/Gateway", "description": "Operations/Auth/Gateway" }, { "name": "Operations/Auth/Profile", "description": "Operations/Auth/Profile" }, { "name": "Operations/Billing/Subscription", "description": "Operations/Billing/Subscription" }, { "name": "Operations/Campaign", "description": "Operations/Campaign" }, { "name": "Operations/Campaign/Log", "description": "Operations/Campaign/Log" }, { "name": "Operations/Campaign/Task", "description": "Operations/Campaign/Task" }, { "name": "Operations/User", "description": "Operations/User" } ] }