{ "schema_version": 1, "entries": [ { "id": "api:get:/agency/brand-groups", "surface": "api", "heading": "GET /agency/brand-groups", "route": "/openapi.json", "anchor": "/paths/~1agency~1brand-groups/get", "url": "/openapi.json#/paths/~1agency~1brand-groups/get", "contract": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandGroupsPublicResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/agency/compare-brands", "surface": "api", "heading": "POST /agency/compare-brands", "route": "/openapi.json", "anchor": "/paths/~1agency~1compare-brands/post", "url": "/openapi.json#/paths/~1agency~1compare-brands/post", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompareBrandsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompareBrandsPublicResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/agency/portfolio-actions", "surface": "api", "heading": "GET /agency/portfolio-actions", "route": "/openapi.json", "anchor": "/paths/~1agency~1portfolio-actions/get", "url": "/openapi.json#/paths/~1agency~1portfolio-actions/get", "contract": { "parameters": [ { "name": "group_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Group Id" } }, { "name": "quick_win", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Quick Win" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortfolioActionsPublicResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/ai-pages", "surface": "api", "heading": "GET /ai-pages", "route": "/openapi.json", "anchor": "/paths/~1ai-pages/get", "url": "/openapi.json#/paths/~1ai-pages/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrismResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/api/v1/crawler/access", "surface": "api", "heading": "GET /api/v1/crawler/access", "route": "/openapi.json", "anchor": "/paths/~1api~1v1~1crawler~1access/get", "url": "/openapi.json#/paths/~1api~1v1~1crawler~1access/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "range_preset", "in": "query", "required": false, "schema": { "enum": [ "24h", "7d", "30d", "90d", "custom" ], "type": "string", "default": "30d", "title": "Range Preset" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start Date" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Date" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Public Crawler Access Api V1 Crawler Access Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/api/v1/crawler/submit-to-search", "surface": "api", "heading": "POST /api/v1/crawler/submit-to-search", "route": "/openapi.json", "anchor": "/paths/~1api~1v1~1crawler~1submit-to-search/post", "url": "/openapi.json#/paths/~1api~1v1~1crawler~1submit-to-search/post", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrawlerSubmitToSearchRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Submit Public Crawler To Search Api V1 Crawler Submit To Search Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/api/v1/crawler/submit-to-search/status", "surface": "api", "heading": "GET /api/v1/crawler/submit-to-search/status", "route": "/openapi.json", "anchor": "/paths/~1api~1v1~1crawler~1submit-to-search~1status/get", "url": "/openapi.json#/paths/~1api~1v1~1crawler~1submit-to-search~1status/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "range_preset", "in": "query", "required": false, "schema": { "enum": [ "24h", "7d", "30d", "90d", "custom" ], "type": "string", "default": "30d", "title": "Range Preset" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start Date" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Date" } }, { "name": "urls", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Urls" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "pending", "success", "failed" ], "type": "string" }, { "type": "null" } ], "title": "Status" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Public Crawler Submit Status Api V1 Crawler Submit To Search Status Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/api/v1/crawler/verification-ping", "surface": "api", "heading": "POST /api/v1/crawler/verification-ping", "route": "/openapi.json", "anchor": "/paths/~1api~1v1~1crawler~1verification-ping/post", "url": "/openapi.json#/paths/~1api~1v1~1crawler~1verification-ping/post", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_trigger_public_crawler_verification_ping_api_v1_crawler_verification_ping_post" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Trigger Public Crawler Verification Ping Api V1 Crawler Verification Ping Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/api/v1/notifications", "surface": "api", "heading": "GET /api/v1/notifications", "route": "/openapi.json", "anchor": "/paths/~1api~1v1~1notifications/get", "url": "/openapi.json#/paths/~1api~1v1~1notifications/get", "contract": { "parameters": [ { "name": "view", "in": "query", "required": false, "schema": { "enum": [ "list", "unread_count" ], "type": "string", "default": "list", "title": "View" } }, { "name": "brand_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Brand Id" } }, { "name": "event_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Event Type" } }, { "name": "unread_only", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Unread Only" } }, { "name": "days", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 180, "minimum": 1 }, { "type": "null" } ], "title": "Days" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationsPublicResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/api/v1/notifications/read", "surface": "api", "heading": "POST /api/v1/notifications/read", "route": "/openapi.json", "anchor": "/paths/~1api~1v1~1notifications~1read/post", "url": "/openapi.json#/paths/~1api~1v1~1notifications~1read/post", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationsMarkReadRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationsReadResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:delete:/api/v1/workflows/{workflow_id}", "surface": "api", "heading": "DELETE /api/v1/workflows/{workflow_id}", "route": "/openapi.json", "anchor": "/paths/~1api~1v1~1workflows~1{workflow_id}/delete", "url": "/openapi.json#/paths/~1api~1v1~1workflows~1{workflow_id}/delete", "contract": { "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowPublicResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/commit-opportunity", "surface": "api", "heading": "POST /commit-opportunity", "route": "/openapi.json", "anchor": "/paths/~1commit-opportunity/post", "url": "/openapi.json#/paths/~1commit-opportunity/post", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommitOpportunityRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommitOpportunityPublicResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/competitors/manage", "surface": "api", "heading": "POST /competitors/manage", "route": "/openapi.json", "anchor": "/paths/~1competitors~1manage/post", "url": "/openapi.json#/paths/~1competitors~1manage/post", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManageCompetitorRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompetitorManageResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/content/articles", "surface": "api", "heading": "GET /content/articles", "route": "/openapi.json", "anchor": "/paths/~1content~1articles/get", "url": "/openapi.json#/paths/~1content~1articles/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "view", "in": "query", "required": false, "schema": { "enum": [ "list", "detail", "get" ], "type": "string", "default": "list", "title": "View" } }, { "name": "article_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Article Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "standalone_only", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Standalone Only" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ContentArticlesPublicResponse" }, { "type": "object", "additionalProperties": true } ], "title": "Response Get Content Articles Public Content Articles Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/content/articles/generate", "surface": "api", "heading": "POST /content/articles/generate", "route": "/openapi.json", "anchor": "/paths/~1content~1articles~1generate/post", "url": "/openapi.json#/paths/~1content~1articles~1generate/post", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicGenerateArticleRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentMutationPublicResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/content/knowledge", "surface": "api", "heading": "GET /content/knowledge", "route": "/openapi.json", "anchor": "/paths/~1content~1knowledge/get", "url": "/openapi.json#/paths/~1content~1knowledge/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "view", "in": "query", "required": false, "schema": { "enum": [ "sources", "stats", "list" ], "type": "string", "default": "sources", "title": "View" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentKnowledgePublicResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/content/knowledge/sources/text", "surface": "api", "heading": "POST /content/knowledge/sources/text", "route": "/openapi.json", "anchor": "/paths/~1content~1knowledge~1sources~1text/post", "url": "/openapi.json#/paths/~1content~1knowledge~1sources~1text/post", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicKnowledgeTextRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentMutationPublicResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/content/knowledge/sources/url", "surface": "api", "heading": "POST /content/knowledge/sources/url", "route": "/openapi.json", "anchor": "/paths/~1content~1knowledge~1sources~1url/post", "url": "/openapi.json#/paths/~1content~1knowledge~1sources~1url/post", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicKnowledgeUrlRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentMutationPublicResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:delete:/content/knowledge/sources/{source_id}", "surface": "api", "heading": "DELETE /content/knowledge/sources/{source_id}", "route": "/openapi.json", "anchor": "/paths/~1content~1knowledge~1sources~1{source_id}/delete", "url": "/openapi.json#/paths/~1content~1knowledge~1sources~1{source_id}/delete", "contract": { "parameters": [ { "name": "source_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Source Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentMutationPublicResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/content/knowledge/sources/{source_id}/reprocess", "surface": "api", "heading": "POST /content/knowledge/sources/{source_id}/reprocess", "route": "/openapi.json", "anchor": "/paths/~1content~1knowledge~1sources~1{source_id}~1reprocess/post", "url": "/openapi.json#/paths/~1content~1knowledge~1sources~1{source_id}~1reprocess/post", "contract": { "parameters": [ { "name": "source_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Source Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentMutationPublicResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/content/writing-style", "surface": "api", "heading": "GET /content/writing-style", "route": "/openapi.json", "anchor": "/paths/~1content~1writing-style/get", "url": "/openapi.json#/paths/~1content~1writing-style/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "view", "in": "query", "required": false, "schema": { "enum": [ "profile", "samples" ], "type": "string", "default": "profile", "title": "View" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentWritingStylePublicResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/crawler/access", "surface": "api", "heading": "GET /crawler/access", "route": "/openapi.json", "anchor": "/paths/~1crawler~1access/get", "url": "/openapi.json#/paths/~1crawler~1access/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "range_preset", "in": "query", "required": false, "schema": { "enum": [ "24h", "7d", "30d", "90d", "custom" ], "type": "string", "default": "30d", "title": "Range Preset" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start Date" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Date" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Public Crawler Access Crawler Access Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/crawler/access/preview-fix", "surface": "api", "heading": "POST /crawler/access/preview-fix", "route": "/openapi.json", "anchor": "/paths/~1crawler~1access~1preview-fix/post", "url": "/openapi.json#/paths/~1crawler~1access~1preview-fix/post", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrawlerAccessPreviewFixRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Preview Public Crawler Fix Crawler Access Preview Fix Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/crawler/bot-details", "surface": "api", "heading": "GET /crawler/bot-details", "route": "/openapi.json", "anchor": "/paths/~1crawler~1bot-details/get", "url": "/openapi.json#/paths/~1crawler~1bot-details/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "bot_name", "in": "query", "required": true, "schema": { "type": "string", "title": "Bot Name" } }, { "name": "range_preset", "in": "query", "required": false, "schema": { "enum": [ "24h", "7d", "30d", "90d", "custom" ], "type": "string", "default": "30d", "title": "Range Preset" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start Date" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Date" } }, { "name": "intent", "in": "query", "required": false, "schema": { "enum": [ "all", "interaction", "search", "training" ], "type": "string", "default": "all", "title": "Intent" } }, { "name": "platform", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Platform" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "status", "in": "query", "required": false, "schema": { "enum": [ "all", "converting", "cited", "crawled", "healthy", "cold" ], "type": "string", "default": "all", "title": "Status" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrawlerDetailResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/crawler/live", "surface": "api", "heading": "GET /crawler/live", "route": "/openapi.json", "anchor": "/paths/~1crawler~1live/get", "url": "/openapi.json#/paths/~1crawler~1live/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "view", "in": "query", "required": false, "schema": { "enum": [ "activity", "pages", "sessions" ], "type": "string", "default": "activity", "title": "View" } }, { "name": "range_preset", "in": "query", "required": false, "schema": { "enum": [ "24h", "7d", "30d", "90d", "custom" ], "type": "string", "default": "30d", "title": "Range Preset" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start Date" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Date" } }, { "name": "intent", "in": "query", "required": false, "schema": { "enum": [ "all", "interaction", "search", "training" ], "type": "string", "default": "all", "title": "Intent" } }, { "name": "platform", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Platform" } }, { "name": "http_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Http Status" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort By" } }, { "name": "sort_dir", "in": "query", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string", "default": "desc", "title": "Sort Dir" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 25, "title": "Limit" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrawlerLiveResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/crawler/overview", "surface": "api", "heading": "GET /crawler/overview", "route": "/openapi.json", "anchor": "/paths/~1crawler~1overview/get", "url": "/openapi.json#/paths/~1crawler~1overview/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "range_preset", "in": "query", "required": false, "schema": { "enum": [ "24h", "7d", "30d", "90d", "custom" ], "type": "string", "default": "30d", "title": "Range Preset" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start Date" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Date" } }, { "name": "compare_to", "in": "query", "required": false, "schema": { "enum": [ "none", "previous_period" ], "type": "string", "default": "none", "title": "Compare To" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrawlerOverviewResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/crawler/page-details", "surface": "api", "heading": "GET /crawler/page-details", "route": "/openapi.json", "anchor": "/paths/~1crawler~1page-details/get", "url": "/openapi.json#/paths/~1crawler~1page-details/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "page_url", "in": "query", "required": true, "schema": { "type": "string", "title": "Page Url" } }, { "name": "range_preset", "in": "query", "required": false, "schema": { "enum": [ "24h", "7d", "30d", "90d", "custom" ], "type": "string", "default": "30d", "title": "Range Preset" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start Date" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Date" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrawlerDetailResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/crawler/pages", "surface": "api", "heading": "GET /crawler/pages", "route": "/openapi.json", "anchor": "/paths/~1crawler~1pages/get", "url": "/openapi.json#/paths/~1crawler~1pages/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "lens", "in": "query", "required": false, "schema": { "enum": [ "pages", "paths", "bots" ], "type": "string", "default": "pages", "title": "Lens" } }, { "name": "range_preset", "in": "query", "required": false, "schema": { "enum": [ "24h", "7d", "30d", "90d", "custom" ], "type": "string", "default": "30d", "title": "Range Preset" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start Date" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Date" } }, { "name": "intent", "in": "query", "required": false, "schema": { "enum": [ "all", "interaction", "search", "training" ], "type": "string", "default": "all", "title": "Intent" } }, { "name": "platform", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Platform" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "status", "in": "query", "required": false, "schema": { "enum": [ "all", "converting", "cited", "crawled", "healthy", "cold" ], "type": "string", "default": "all", "title": "Status" } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort By" } }, { "name": "sort_dir", "in": "query", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string", "default": "desc", "title": "Sort Dir" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 25, "title": "Limit" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrawlerPagesResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/crawler/path-details", "surface": "api", "heading": "GET /crawler/path-details", "route": "/openapi.json", "anchor": "/paths/~1crawler~1path-details/get", "url": "/openapi.json#/paths/~1crawler~1path-details/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "path_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Path Id" } }, { "name": "range_preset", "in": "query", "required": false, "schema": { "enum": [ "24h", "7d", "30d", "90d", "custom" ], "type": "string", "default": "30d", "title": "Range Preset" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start Date" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Date" } }, { "name": "intent", "in": "query", "required": false, "schema": { "enum": [ "all", "interaction", "search", "training" ], "type": "string", "default": "all", "title": "Intent" } }, { "name": "platform", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Platform" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "status", "in": "query", "required": false, "schema": { "enum": [ "all", "converting", "cited", "crawled", "healthy", "cold" ], "type": "string", "default": "all", "title": "Status" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrawlerDetailResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/crawler/submit-to-search", "surface": "api", "heading": "POST /crawler/submit-to-search", "route": "/openapi.json", "anchor": "/paths/~1crawler~1submit-to-search/post", "url": "/openapi.json#/paths/~1crawler~1submit-to-search/post", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrawlerSubmitToSearchRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Submit Public Crawler To Search Crawler Submit To Search Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/crawler/submit-to-search/status", "surface": "api", "heading": "GET /crawler/submit-to-search/status", "route": "/openapi.json", "anchor": "/paths/~1crawler~1submit-to-search~1status/get", "url": "/openapi.json#/paths/~1crawler~1submit-to-search~1status/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "range_preset", "in": "query", "required": false, "schema": { "enum": [ "24h", "7d", "30d", "90d", "custom" ], "type": "string", "default": "30d", "title": "Range Preset" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start Date" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Date" } }, { "name": "urls", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Urls" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "pending", "success", "failed" ], "type": "string" }, { "type": "null" } ], "title": "Status" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Public Crawler Submit Status Crawler Submit To Search Status Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/crawler/verification-ping", "surface": "api", "heading": "POST /crawler/verification-ping", "route": "/openapi.json", "anchor": "/paths/~1crawler~1verification-ping/post", "url": "/openapi.json#/paths/~1crawler~1verification-ping/post", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_trigger_public_crawler_verification_ping_crawler_verification_ping_post" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Trigger Public Crawler Verification Ping Crawler Verification Ping Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/diagnose", "surface": "api", "heading": "GET /diagnose", "route": "/openapi.json", "anchor": "/paths/~1diagnose/get", "url": "/openapi.json#/paths/~1diagnose/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Brand Id" } }, { "name": "diagnosis_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Diagnosis Id" } }, { "name": "market_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "name": "view", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "history", "usage" ], "type": "string" }, { "type": "null" } ], "title": "View" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Limit" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DiagnoseResultApiResponse" }, { "$ref": "#/components/schemas/DiagnoseHistoryApiResponse" }, { "$ref": "#/components/schemas/DiagnoseUsageApiResponse" } ], "title": "Response Get Diagnose Api Diagnose Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/diagnose", "surface": "api", "heading": "POST /diagnose", "route": "/openapi.json", "anchor": "/paths/~1diagnose/post", "url": "/openapi.json#/paths/~1diagnose/post", "contract": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnoseRunApiRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnoseRunApiResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/discover-publishers", "surface": "api", "heading": "POST /discover-publishers", "route": "/openapi.json", "anchor": "/paths/~1discover-publishers/post", "url": "/openapi.json#/paths/~1discover-publishers/post", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoverPublishersRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublisherDiscoveryResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/export", "surface": "api", "heading": "GET /export", "route": "/openapi.json", "anchor": "/paths/~1export/get", "url": "/openapi.json#/paths/~1export/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "data_type", "in": "query", "required": true, "schema": { "enum": [ "prompts", "results", "citations", "reports" ], "type": "string", "title": "Data Type" } }, { "name": "format", "in": "query", "required": false, "schema": { "enum": [ "json", "csv" ], "type": "string", "default": "json", "title": "Format" } }, { "name": "days", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 365, "minimum": 1, "default": 30, "title": "Days" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 1, "default": 1000, "title": "Limit" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportResponse" } }, "text/csv": { "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/export-collection-history", "surface": "api", "heading": "GET /export-collection-history", "route": "/openapi.json", "anchor": "/paths/~1export-collection-history/get", "url": "/openapi.json#/paths/~1export-collection-history/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start Date" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Date" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/get-action-stats", "surface": "api", "heading": "GET /get-action-stats", "route": "/openapi.json", "anchor": "/paths/~1get-action-stats/get", "url": "/openapi.json#/paths/~1get-action-stats/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionStatsPublicResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/get-actions", "surface": "api", "heading": "GET /get-actions", "route": "/openapi.json", "anchor": "/paths/~1get-actions/get", "url": "/openapi.json#/paths/~1get-actions/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "open", "title": "Status" } }, { "name": "category", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" } }, { "name": "action_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action Type" } }, { "name": "source", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" } }, { "name": "lens", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lens" } }, { "name": "quick_win", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Quick Win" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "url", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "default": "priority_score", "title": "Sort By" } }, { "name": "sort_dir", "in": "query", "required": false, "schema": { "type": "string", "default": "desc", "title": "Sort Dir" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionsPublicResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/get-audit-findings", "surface": "api", "heading": "GET /get-audit-findings", "route": "/openapi.json", "anchor": "/paths/~1get-audit-findings/get", "url": "/openapi.json#/paths/~1get-audit-findings/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "audit_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Audit Id" } }, { "name": "severity", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "critical,high", "title": "Severity" } }, { "name": "issue_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "open,in_progress", "title": "Issue Status" } }, { "name": "check_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Check Name" } }, { "name": "page_url", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Url" } }, { "name": "page_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Type" } }, { "name": "url_pattern", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url Pattern" } }, { "name": "min_score", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 0 }, { "type": "null" } ], "title": "Min Score" } }, { "name": "max_score", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 0 }, { "type": "null" } ], "title": "Max Score" } }, { "name": "issues_limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 50, "minimum": 1, "default": 20, "title": "Issues Limit" } }, { "name": "pages_limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Pages Limit" } }, { "name": "full_urls", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Full Urls" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditFindingsResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/get-audits", "surface": "api", "heading": "GET /get-audits", "route": "/openapi.json", "anchor": "/paths/~1get-audits/get", "url": "/openapi.json#/paths/~1get-audits/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "audit_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Audit Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Limit" } }, { "name": "period", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Period" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditsListResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/get-brands", "surface": "api", "heading": "GET /get-brands", "route": "/openapi.json", "anchor": "/paths/~1get-brands/get", "url": "/openapi.json#/paths/~1get-brands/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Brand Id" } }, { "name": "include", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Include" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandsExtendedResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:put:/get-brands/aliases", "surface": "api", "heading": "PUT /get-brands/aliases", "route": "/openapi.json", "anchor": "/paths/~1get-brands~1aliases/put", "url": "/openapi.json#/paths/~1get-brands~1aliases/put", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAliasesApiRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandAliasesResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:put:/get-brands/location", "surface": "api", "heading": "PUT /get-brands/location", "route": "/openapi.json", "anchor": "/paths/~1get-brands~1location/put", "url": "/openapi.json#/paths/~1get-brands~1location/put", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBrandLocationRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBrandLocationResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:delete:/get-brands/markets", "surface": "api", "heading": "DELETE /get-brands/markets", "route": "/openapi.json", "anchor": "/paths/~1get-brands~1markets/delete", "url": "/openapi.json#/paths/~1get-brands~1markets/delete", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "market_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Market Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDeleteResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/get-brands/markets", "surface": "api", "heading": "POST /get-brands/markets", "route": "/openapi.json", "anchor": "/paths/~1get-brands~1markets/post", "url": "/openapi.json#/paths/~1get-brands~1markets/post", "contract": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddMarketRequest" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketItem" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/get-business-context", "surface": "api", "heading": "GET /get-business-context", "route": "/openapi.json", "anchor": "/paths/~1get-business-context/get", "url": "/openapi.json#/paths/~1get-business-context/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessContextResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/get-citations", "surface": "api", "heading": "GET /get-citations", "route": "/openapi.json", "anchor": "/paths/~1get-citations/get", "url": "/openapi.json#/paths/~1get-citations/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "view", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "domain", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain" } }, { "name": "days", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 365, "minimum": 7, "default": 30, "title": "Days" } }, { "name": "days_back", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 30, "minimum": 1, "default": 7, "title": "Days Back" } }, { "name": "tag_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tag Ids" } }, { "name": "prompt_text", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt Text" } }, { "name": "period", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Period" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/CitationsResponse" }, { "$ref": "#/components/schemas/CitationsHistoryResponse" }, { "$ref": "#/components/schemas/CitationsQueriesResponse" }, { "$ref": "#/components/schemas/CitationsSourceResponse" }, { "$ref": "#/components/schemas/CitationsFeedResponse" }, { "$ref": "#/components/schemas/CitationsHeatmapResponse" }, { "$ref": "#/components/schemas/CitationsAnalyticsResponse" }, { "$ref": "#/components/schemas/CitationDetailResponse" }, { "$ref": "#/components/schemas/CitationsByModelResponse" }, { "$ref": "#/components/schemas/CitationsTopPagesResponse" } ], "title": "Response Get Citations Get Citations Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/get-competitor-data", "surface": "api", "heading": "GET /get-competitor-data", "route": "/openapi.json", "anchor": "/paths/~1get-competitor-data/get", "url": "/openapi.json#/paths/~1get-competitor-data/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Brand Id" } }, { "name": "brand", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Brand" } }, { "name": "view", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View" } }, { "name": "competitor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Competitor" } }, { "name": "days", "in": "query", "required": false, "schema": { "type": "integer", "default": 30, "title": "Days" } }, { "name": "tag_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tag Ids" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 50, "minimum": 1, "default": 10, "title": "Limit" } }, { "name": "period", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Period" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/CompetitorPeriodResponse" }, { "$ref": "#/components/schemas/CompetitorDataResponse" }, { "$ref": "#/components/schemas/CompetitorArenaResponse" }, { "$ref": "#/components/schemas/CompetitorH2HResponse" }, { "$ref": "#/components/schemas/CompetitorByModelResponse" }, { "$ref": "#/components/schemas/CompetitorThreatsResponse" }, { "$ref": "#/components/schemas/CompetitorHeatmapResponse" }, { "$ref": "#/components/schemas/CompetitorOverTimeResponse" } ], "title": "Response Get Competitor Data Get Competitor Data Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/get-content-ideas", "surface": "api", "heading": "GET /get-content-ideas", "route": "/openapi.json", "anchor": "/paths/~1get-content-ideas/get", "url": "/openapi.json#/paths/~1get-content-ideas/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "active", "dismissed", "implemented" ], "type": "string" }, { "type": "null" } ], "title": "Status" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentIdeasPublicResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/get-content-ideas", "surface": "api", "heading": "POST /get-content-ideas", "route": "/openapi.json", "anchor": "/paths/~1get-content-ideas/post", "url": "/openapi.json#/paths/~1get-content-ideas/post", "contract": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentIdeasRefreshRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentIdeasRefreshResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/get-crawler", "surface": "api", "heading": "GET /get-crawler", "route": "/openapi.json", "anchor": "/paths/~1get-crawler/get", "url": "/openapi.json#/paths/~1get-crawler/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "view", "in": "query", "required": false, "schema": { "enum": [ "dashboard", "recent" ], "type": "string", "default": "dashboard", "title": "View" } }, { "name": "days", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 90, "minimum": 1, "default": 7, "title": "Days" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/CrawlerDashboardResponse" }, { "$ref": "#/components/schemas/CrawlerRecentResponse" } ], "title": "Response Get Crawler Get Crawler Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/get-metrics", "surface": "api", "heading": "GET /get-metrics", "route": "/openapi.json", "anchor": "/paths/~1get-metrics/get", "url": "/openapi.json#/paths/~1get-metrics/get", "contract": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricsCatalogueResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/get-models", "surface": "api", "heading": "GET /get-models", "route": "/openapi.json", "anchor": "/paths/~1get-models/get", "url": "/openapi.json#/paths/~1get-models/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "days", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 365, "minimum": 7, "default": 30, "title": "Days" } }, { "name": "include_trends", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Trends" } }, { "name": "period", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Period" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelsResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/get-opportunities", "surface": "api", "heading": "GET /get-opportunities", "route": "/openapi.json", "anchor": "/paths/~1get-opportunities/get", "url": "/openapi.json#/paths/~1get-opportunities/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "days", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 365, "minimum": 1 }, { "type": "null" } ], "title": "Days" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunitiesResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/get-opportunity-pool", "surface": "api", "heading": "GET /get-opportunity-pool", "route": "/openapi.json", "anchor": "/paths/~1get-opportunity-pool/get", "url": "/openapi.json#/paths/~1get-opportunity-pool/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "family", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Family" } }, { "name": "kind", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kind" } }, { "name": "impact", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Impact" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityPoolResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/get-page-analyses", "surface": "api", "heading": "GET /get-page-analyses", "route": "/openapi.json", "anchor": "/paths/~1get-page-analyses/get", "url": "/openapi.json#/paths/~1get-page-analyses/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "url", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Limit" } }, { "name": "max_age_days", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 365, "minimum": 1, "default": 30, "title": "Max Age Days" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PageAnalysesListResponse" }, { "$ref": "#/components/schemas/PageAnalysisDetailResponse" } ], "title": "Response Get Page Analyses Public Get Page Analyses Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/get-pages", "surface": "api", "heading": "GET /get-pages", "route": "/openapi.json", "anchor": "/paths/~1get-pages/get", "url": "/openapi.json#/paths/~1get-pages/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "ownership", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ownership" } }, { "name": "tracked", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Tracked" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/get-perception", "surface": "api", "heading": "GET /get-perception", "route": "/openapi.json", "anchor": "/paths/~1get-perception/get", "url": "/openapi.json#/paths/~1get-perception/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "view", "in": "query", "required": false, "schema": { "enum": [ "dashboard", "metrics", "narrative", "story", "narrative_drift" ], "type": "string", "default": "dashboard", "title": "View" } }, { "name": "days", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 365, "minimum": 7, "default": 90, "title": "Days" } }, { "name": "weeks", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 52, "minimum": 1, "default": 8, "title": "Weeks" } }, { "name": "tracked_brand", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tracked Brand" } }, { "name": "period", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Period" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PerceptionDashboardApiResponse" }, { "$ref": "#/components/schemas/PerceptionMetricsApiResponse" }, { "$ref": "#/components/schemas/PerceptionNarrativeApiResponse" }, { "$ref": "#/components/schemas/PerceptionStoryApiResponse" }, { "type": "object", "additionalProperties": true }, { "$ref": "#/components/schemas/PerceptionDashboardApiResponse" }, { "$ref": "#/components/schemas/PerceptionMetricsApiResponse" }, { "$ref": "#/components/schemas/PerceptionNarrativeApiResponse" }, { "$ref": "#/components/schemas/PerceptionStoryApiResponse" }, { "$ref": "#/components/schemas/PerceptionNarrativeDriftApiResponse" }, { "type": "object", "additionalProperties": true } ], "title": "Response 200 Get Perception Get Perception Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/get-perception", "surface": "api", "heading": "POST /get-perception", "route": "/openapi.json", "anchor": "/paths/~1get-perception/post", "url": "/openapi.json#/paths/~1get-perception/post", "contract": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerceptionRunRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerceptionRunApiResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/get-period-summary", "surface": "api", "heading": "GET /get-period-summary", "route": "/openapi.json", "anchor": "/paths/~1get-period-summary/get", "url": "/openapi.json#/paths/~1get-period-summary/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Brand Id" } }, { "name": "brand_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Brand Ids" } }, { "name": "period", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Period" } }, { "name": "view", "in": "query", "required": false, "schema": { "enum": [ "summary", "list" ], "type": "string", "default": "summary", "title": "View" } }, { "name": "compare", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Compare" } }, { "name": "include", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Include" } }, { "name": "months", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 36, "minimum": 1, "default": 12, "title": "Months" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PeriodSummaryResponse" }, { "$ref": "#/components/schemas/PeriodIndexResponse" }, { "$ref": "#/components/schemas/PeriodPortfolioResponse" } ], "title": "Response Get Period Summary Get Period Summary Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:delete:/get-prompts", "surface": "api", "heading": "DELETE /get-prompts", "route": "/openapi.json", "anchor": "/paths/~1get-prompts/delete", "url": "/openapi.json#/paths/~1get-prompts/delete", "contract": { "parameters": [ { "name": "prompt_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Prompt Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDeleteResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/get-prompts", "surface": "api", "heading": "GET /get-prompts", "route": "/openapi.json", "anchor": "/paths/~1get-prompts/get", "url": "/openapi.json#/paths/~1get-prompts/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "active_only", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Active Only" } }, { "name": "tag_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tag Ids" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromptsListResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/get-prompts", "surface": "api", "heading": "POST /get-prompts", "route": "/openapi.json", "anchor": "/paths/~1get-prompts/post", "url": "/openapi.json#/paths/~1get-prompts/post", "contract": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePromptRequest" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromptItem" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:put:/get-prompts", "surface": "api", "heading": "PUT /get-prompts", "route": "/openapi.json", "anchor": "/paths/~1get-prompts/put", "url": "/openapi.json#/paths/~1get-prompts/put", "contract": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePromptRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromptItem" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:patch:/get-prompts/activate", "surface": "api", "heading": "PATCH /get-prompts/activate", "route": "/openapi.json", "anchor": "/paths/~1get-prompts~1activate/patch", "url": "/openapi.json#/paths/~1get-prompts~1activate/patch", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkActivateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkActivateResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:delete:/get-prompts/bulk", "surface": "api", "heading": "DELETE /get-prompts/bulk", "route": "/openapi.json", "anchor": "/paths/~1get-prompts~1bulk/delete", "url": "/openapi.json#/paths/~1get-prompts~1bulk/delete", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkDeletePromptsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkDeletePromptsResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/get-prompts/bulk", "surface": "api", "heading": "POST /get-prompts/bulk", "route": "/openapi.json", "anchor": "/paths/~1get-prompts~1bulk/post", "url": "/openapi.json#/paths/~1get-prompts~1bulk/post", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkCreatePromptsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkCreatePromptsResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:patch:/get-prompts/deactivate", "surface": "api", "heading": "PATCH /get-prompts/deactivate", "route": "/openapi.json", "anchor": "/paths/~1get-prompts~1deactivate/patch", "url": "/openapi.json#/paths/~1get-prompts~1deactivate/patch", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkActivateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkActivateResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/get-prompts/rerun", "surface": "api", "heading": "POST /get-prompts/rerun", "route": "/openapi.json", "anchor": "/paths/~1get-prompts~1rerun/post", "url": "/openapi.json#/paths/~1get-prompts~1rerun/post", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RerunPromptRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RerunPromptResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "410": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RerunPromptResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ], "deprecated": true } }, { "id": "api:post:/get-prompts/suggest", "surface": "api", "heading": "POST /get-prompts/suggest", "route": "/openapi.json", "anchor": "/paths/~1get-prompts~1suggest/post", "url": "/openapi.json#/paths/~1get-prompts~1suggest/post", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuggestPromptsApiRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuggestPromptsApiResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/get-proof", "surface": "api", "heading": "GET /get-proof", "route": "/openapi.json", "anchor": "/paths/~1get-proof/get", "url": "/openapi.json#/paths/~1get-proof/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "verdict", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Verdict" } }, { "name": "family", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Family" } }, { "name": "days", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 3650, "minimum": 1 }, { "type": "null" } ], "title": "Days" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProofResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ], "deprecated": true } }, { "id": "api:get:/get-rankings", "surface": "api", "heading": "GET /get-rankings", "route": "/openapi.json", "anchor": "/paths/~1get-rankings/get", "url": "/openapi.json#/paths/~1get-rankings/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "view", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View" } }, { "name": "days", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 365, "minimum": 1, "default": 30, "title": "Days" } }, { "name": "include_volume", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Volume" } }, { "name": "tag_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tag Ids" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 25, "title": "Limit" } }, { "name": "period", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Period" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/RankingsOverallResponse" }, { "$ref": "#/components/schemas/RankingsByPromptResponse" }, { "$ref": "#/components/schemas/RankingsPromptTrendsResponse" } ], "title": "Response Get Rankings Get Rankings Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/get-reports", "surface": "api", "heading": "GET /get-reports", "route": "/openapi.json", "anchor": "/paths/~1get-reports/get", "url": "/openapi.json#/paths/~1get-reports/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Brand Id" } }, { "name": "report_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Report Id" } }, { "name": "report_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Report Type" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "view", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View" } }, { "name": "days", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 365, "minimum": 7, "default": 30, "title": "Days" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ReportsListPublicResponse" }, { "$ref": "#/components/schemas/ReportSinglePublicResponse" }, { "$ref": "#/components/schemas/ReportResultsResponse" }, { "$ref": "#/components/schemas/ReportSentimentResponse" }, { "$ref": "#/components/schemas/ReportMentionsResponse" } ], "title": "Response Get Reports Public Get Reports Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/get-reports", "surface": "api", "heading": "POST /get-reports", "route": "/openapi.json", "anchor": "/paths/~1get-reports/post", "url": "/openapi.json#/paths/~1get-reports/post", "contract": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateReportPublicRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateReportPublicResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/get-reports/compare", "surface": "api", "heading": "POST /get-reports/compare", "route": "/openapi.json", "anchor": "/paths/~1get-reports~1compare/post", "url": "/openapi.json#/paths/~1get-reports~1compare/post", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCompareRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCompareResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/get-reports/{report_id}/download", "surface": "api", "heading": "GET /get-reports/{report_id}/download", "route": "/openapi.json", "anchor": "/paths/~1get-reports~1{report_id}~1download/get", "url": "/openapi.json#/paths/~1get-reports~1{report_id}~1download/get", "contract": { "parameters": [ { "name": "report_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Report Id" } } ], "responses": { "200": { "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/get-results", "surface": "api", "heading": "GET /get-results", "route": "/openapi.json", "anchor": "/paths/~1get-results/get", "url": "/openapi.json#/paths/~1get-results/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "verdict", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Verdict" } }, { "name": "family", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Family" } }, { "name": "days", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 3650, "minimum": 1 }, { "type": "null" } ], "title": "Days" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResultsResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/get-scores", "surface": "api", "heading": "GET /get-scores", "route": "/openapi.json", "anchor": "/paths/~1get-scores/get", "url": "/openapi.json#/paths/~1get-scores/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Brand Id" } }, { "name": "brand", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Brand" } }, { "name": "days", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 365, "minimum": 7, "default": 90, "title": "Days" } }, { "name": "view", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View" } }, { "name": "tag_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tag Ids" } }, { "name": "prompt_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Prompt Id" } }, { "name": "period", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Period" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ScoresResponse" }, { "$ref": "#/components/schemas/VisibilityTimeSeriesResponse" }, { "$ref": "#/components/schemas/VisibilityByModelResponse" }, { "$ref": "#/components/schemas/VisibilityByPromptResponse" } ], "title": "Response Get Scores Get Scores Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/get-search-performance", "surface": "api", "heading": "GET /get-search-performance", "route": "/openapi.json", "anchor": "/paths/~1get-search-performance/get", "url": "/openapi.json#/paths/~1get-search-performance/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "url", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ], "title": "Url" } }, { "name": "days", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 90, "minimum": 1, "default": 28, "title": "Days" } }, { "name": "compare_previous_period", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Compare Previous Period" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Search Performance Public Get Search Performance Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/get-tags", "surface": "api", "heading": "GET /get-tags", "route": "/openapi.json", "anchor": "/paths/~1get-tags/get", "url": "/openapi.json#/paths/~1get-tags/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagsListResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/get-tracked-articles", "surface": "api", "heading": "GET /get-tracked-articles", "route": "/openapi.json", "anchor": "/paths/~1get-tracked-articles/get", "url": "/openapi.json#/paths/~1get-tracked-articles/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "domain", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 253 }, { "type": "null" } ], "title": "Domain" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackedArticlesResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/manage-action", "surface": "api", "heading": "POST /manage-action", "route": "/openapi.json", "anchor": "/paths/~1manage-action/post", "url": "/openapi.json#/paths/~1manage-action/post", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManageActionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManageActionResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/manage-brand", "surface": "api", "heading": "POST /manage-brand", "route": "/openapi.json", "anchor": "/paths/~1manage-brand/post", "url": "/openapi.json#/paths/~1manage-brand/post", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManageBrandRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManageBrandResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/manage-client", "surface": "api", "heading": "POST /manage-client", "route": "/openapi.json", "anchor": "/paths/~1manage-client/post", "url": "/openapi.json#/paths/~1manage-client/post", "contract": { "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManageClientRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManageClientResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/manage-prompt-tags", "surface": "api", "heading": "POST /manage-prompt-tags", "route": "/openapi.json", "anchor": "/paths/~1manage-prompt-tags/post", "url": "/openapi.json#/paths/~1manage-prompt-tags/post", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagePromptTagsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagePromptTagsResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/mcp/crawler/verification-ping", "surface": "api", "heading": "POST /mcp/crawler/verification-ping", "route": "/openapi.json", "anchor": "/paths/~1mcp~1crawler~1verification-ping/post", "url": "/openapi.json#/paths/~1mcp~1crawler~1verification-ping/post", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_trigger_public_crawler_verification_ping_mcp_crawler_verification_ping_post" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Trigger Public Crawler Verification Ping Mcp Crawler Verification Ping Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:delete:/narratives", "surface": "api", "heading": "DELETE /narratives", "route": "/openapi.json", "anchor": "/paths/~1narratives/delete", "url": "/openapi.json#/paths/~1narratives/delete", "contract": { "parameters": [ { "name": "narrative_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Narrative Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NarrativeDeleteApiResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/narratives", "surface": "api", "heading": "GET /narratives", "route": "/openapi.json", "anchor": "/paths/~1narratives/get", "url": "/openapi.json#/paths/~1narratives/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "narrative_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Narrative Id" } }, { "name": "include", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Include" } }, { "name": "days", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 365, "minimum": 7, "default": 90, "title": "Days" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/NarrativesListApiResponse" }, { "$ref": "#/components/schemas/NarrativeItemApi" } ], "title": "Response Get Narratives Narratives Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:patch:/narratives", "surface": "api", "heading": "PATCH /narratives", "route": "/openapi.json", "anchor": "/paths/~1narratives/patch", "url": "/openapi.json#/paths/~1narratives/patch", "contract": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NarrativeUpdateApiRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NarrativeUpdateApiResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/narratives", "surface": "api", "heading": "POST /narratives", "route": "/openapi.json", "anchor": "/paths/~1narratives/post", "url": "/openapi.json#/paths/~1narratives/post", "contract": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NarrativeCreateApiRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NarrativeCreateApiResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/notifications", "surface": "api", "heading": "GET /notifications", "route": "/openapi.json", "anchor": "/paths/~1notifications/get", "url": "/openapi.json#/paths/~1notifications/get", "contract": { "parameters": [ { "name": "view", "in": "query", "required": false, "schema": { "enum": [ "list", "unread_count" ], "type": "string", "default": "list", "title": "View" } }, { "name": "brand_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Brand Id" } }, { "name": "event_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Event Type" } }, { "name": "unread_only", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Unread Only" } }, { "name": "days", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 180, "minimum": 1 }, { "type": "null" } ], "title": "Days" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationsPublicResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/notifications/read", "surface": "api", "heading": "POST /notifications/read", "route": "/openapi.json", "anchor": "/paths/~1notifications~1read/post", "url": "/openapi.json#/paths/~1notifications~1read/post", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationsMarkReadRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationsReadResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/publisher-shortlist/manage", "surface": "api", "heading": "POST /publisher-shortlist/manage", "route": "/openapi.json", "anchor": "/paths/~1publisher-shortlist~1manage/post", "url": "/openapi.json#/paths/~1publisher-shortlist~1manage/post", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagePublisherShortlistRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublisherShortlistResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/reddit", "surface": "api", "heading": "GET /reddit", "route": "/openapi.json", "anchor": "/paths/~1reddit/get", "url": "/openapi.json#/paths/~1reddit/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "view", "in": "query", "required": false, "schema": { "enum": [ "overview", "feed", "opportunities", "thread", "subreddits", "triggers", "analytics" ], "type": "string", "default": "overview", "title": "View" } }, { "name": "thread_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thread Id" } }, { "name": "days", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 365, "minimum": 1, "default": 30, "title": "Days" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 30, "title": "Page Size" } }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" } }, { "name": "subreddit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subreddit" } }, { "name": "mention_type", "in": "query", "required": false, "schema": { "type": "string", "default": "all", "title": "Mention Type" } }, { "name": "min_citation_score", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 0, "default": 0, "title": "Min Citation Score" } }, { "name": "max_citation_score", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 0, "default": 100, "title": "Max Citation Score" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "keyword", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Keyword" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "default": "all", "title": "Status" } }, { "name": "include_dismissed", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Dismissed" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedditPublicResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/reddit/opportunities/{opportunity_id}/dismiss", "surface": "api", "heading": "POST /reddit/opportunities/{opportunity_id}/dismiss", "route": "/openapi.json", "anchor": "/paths/~1reddit~1opportunities~1{opportunity_id}~1dismiss/post", "url": "/openapi.json#/paths/~1reddit~1opportunities~1{opportunity_id}~1dismiss/post", "contract": { "parameters": [ { "name": "opportunity_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Opportunity Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedditOpportunityDismissRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedditMutationResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/reddit/opportunities/{opportunity_id}/respond", "surface": "api", "heading": "POST /reddit/opportunities/{opportunity_id}/respond", "route": "/openapi.json", "anchor": "/paths/~1reddit~1opportunities~1{opportunity_id}~1respond/post", "url": "/openapi.json#/paths/~1reddit~1opportunities~1{opportunity_id}~1respond/post", "contract": { "parameters": [ { "name": "opportunity_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Opportunity Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedditOpportunityRespondRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedditMutationResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/reddit/scan", "surface": "api", "heading": "POST /reddit/scan", "route": "/openapi.json", "anchor": "/paths/~1reddit~1scan/post", "url": "/openapi.json#/paths/~1reddit~1scan/post", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedditScanRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedditMutationResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/reddit/subreddits", "surface": "api", "heading": "POST /reddit/subreddits", "route": "/openapi.json", "anchor": "/paths/~1reddit~1subreddits/post", "url": "/openapi.json#/paths/~1reddit~1subreddits/post", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedditSubredditAddRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedditMutationResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:delete:/reddit/subreddits/{subreddit_id}", "surface": "api", "heading": "DELETE /reddit/subreddits/{subreddit_id}", "route": "/openapi.json", "anchor": "/paths/~1reddit~1subreddits~1{subreddit_id}/delete", "url": "/openapi.json#/paths/~1reddit~1subreddits~1{subreddit_id}/delete", "contract": { "parameters": [ { "name": "subreddit_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Subreddit Id" } }, { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedditMutationResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/reddit/triggers", "surface": "api", "heading": "POST /reddit/triggers", "route": "/openapi.json", "anchor": "/paths/~1reddit~1triggers/post", "url": "/openapi.json#/paths/~1reddit~1triggers/post", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedditTriggerAddRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedditMutationResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:delete:/reddit/triggers/{trigger_id}", "surface": "api", "heading": "DELETE /reddit/triggers/{trigger_id}", "route": "/openapi.json", "anchor": "/paths/~1reddit~1triggers~1{trigger_id}/delete", "url": "/openapi.json#/paths/~1reddit~1triggers~1{trigger_id}/delete", "contract": { "parameters": [ { "name": "trigger_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Trigger Id" } }, { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedditMutationResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/research/latest", "surface": "api", "heading": "GET /research/latest", "route": "/openapi.json", "anchor": "/paths/~1research~1latest/get", "url": "/openapi.json#/paths/~1research~1latest/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "report_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Report Type" } }, { "name": "results_limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Results Limit" } }, { "name": "results_offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Results Offset" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResearchRunDetailResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/research/runs", "surface": "api", "heading": "GET /research/runs", "route": "/openapi.json", "anchor": "/paths/~1research~1runs/get", "url": "/openapi.json#/paths/~1research~1runs/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "report_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Report Type" } }, { "name": "ready_only", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Ready Only" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResearchRunsListResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/research/runs/{run_id}", "surface": "api", "heading": "GET /research/runs/{run_id}", "route": "/openapi.json", "anchor": "/paths/~1research~1runs~1{run_id}/get", "url": "/openapi.json#/paths/~1research~1runs~1{run_id}/get", "contract": { "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "results_limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Results Limit" } }, { "name": "results_offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Results Offset" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResearchRunDetailResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/research/snapshot", "surface": "api", "heading": "POST /research/snapshot", "route": "/openapi.json", "anchor": "/paths/~1research~1snapshot/post", "url": "/openapi.json#/paths/~1research~1snapshot/post", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunSnapshotPublicRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunSnapshotPublicResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/research/snapshot-credits", "surface": "api", "heading": "GET /research/snapshot-credits", "route": "/openapi.json", "anchor": "/paths/~1research~1snapshot-credits/get", "url": "/openapi.json#/paths/~1research~1snapshot-credits/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResearchSnapshotCreditsResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/tracked-articles/manage", "surface": "api", "heading": "POST /tracked-articles/manage", "route": "/openapi.json", "anchor": "/paths/~1tracked-articles~1manage/post", "url": "/openapi.json#/paths/~1tracked-articles~1manage/post", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManageTrackedArticleRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackedArticleMutationResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/traffic/conversions", "surface": "api", "heading": "GET /traffic/conversions", "route": "/openapi.json", "anchor": "/paths/~1traffic~1conversions/get", "url": "/openapi.json#/paths/~1traffic~1conversions/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversionValuesResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/traffic/conversions", "surface": "api", "heading": "POST /traffic/conversions", "route": "/openapi.json", "anchor": "/paths/~1traffic~1conversions/post", "url": "/openapi.json#/paths/~1traffic~1conversions/post", "contract": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetConversionRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrafficConversionMutationResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:delete:/traffic/conversions/{event_name}", "surface": "api", "heading": "DELETE /traffic/conversions/{event_name}", "route": "/openapi.json", "anchor": "/paths/~1traffic~1conversions~1{event_name}/delete", "url": "/openapi.json#/paths/~1traffic~1conversions~1{event_name}/delete", "contract": { "parameters": [ { "name": "event_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Event Name" } }, { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrafficConversionMutationResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/traffic/report", "surface": "api", "heading": "GET /traffic/report", "route": "/openapi.json", "anchor": "/paths/~1traffic~1report/get", "url": "/openapi.json#/paths/~1traffic~1report/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } }, { "name": "days", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 90, "minimum": 7, "default": 30, "title": "Days" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrafficReportResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/traffic/status", "surface": "api", "heading": "GET /traffic/status", "route": "/openapi.json", "anchor": "/paths/~1traffic~1status/get", "url": "/openapi.json#/paths/~1traffic~1status/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrafficStatusResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/traffic/visitors", "surface": "api", "heading": "GET /traffic/visitors", "route": "/openapi.json", "anchor": "/paths/~1traffic~1visitors/get", "url": "/openapi.json#/paths/~1traffic~1visitors/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Brand Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrafficVisitorsResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/webhooks", "surface": "api", "heading": "GET /webhooks", "route": "/openapi.json", "anchor": "/paths/~1webhooks/get", "url": "/openapi.json#/paths/~1webhooks/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Brand Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookListResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/webhooks", "surface": "api", "heading": "POST /webhooks", "route": "/openapi.json", "anchor": "/paths/~1webhooks/post", "url": "/openapi.json#/paths/~1webhooks/post", "contract": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookCreateBody" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPublicResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:delete:/webhooks/{webhook_id}", "surface": "api", "heading": "DELETE /webhooks/{webhook_id}", "route": "/openapi.json", "anchor": "/paths/~1webhooks~1{webhook_id}/delete", "url": "/openapi.json#/paths/~1webhooks~1{webhook_id}/delete", "contract": { "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Webhook Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDeleteResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/webhooks/{webhook_id}", "surface": "api", "heading": "GET /webhooks/{webhook_id}", "route": "/openapi.json", "anchor": "/paths/~1webhooks~1{webhook_id}/get", "url": "/openapi.json#/paths/~1webhooks~1{webhook_id}/get", "contract": { "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Webhook Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPublicResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/webhooks/{webhook_id}/test", "surface": "api", "heading": "POST /webhooks/{webhook_id}/test", "route": "/openapi.json", "anchor": "/paths/~1webhooks~1{webhook_id}~1test/post", "url": "/openapi.json#/paths/~1webhooks~1{webhook_id}~1test/post", "contract": { "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Webhook Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookTestResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:get:/workflows", "surface": "api", "heading": "GET /workflows", "route": "/openapi.json", "anchor": "/paths/~1workflows/get", "url": "/openapi.json#/paths/~1workflows/get", "contract": { "parameters": [ { "name": "brand_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Brand Id" } }, { "name": "view", "in": "query", "required": false, "schema": { "enum": [ "list", "get", "runs", "run_detail", "templates" ], "type": "string", "default": "list", "title": "View" } }, { "name": "workflow_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workflow Id" } }, { "name": "run_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Run Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "trigger_types", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Trigger Types" } }, { "name": "days", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 90, "minimum": 1 }, { "type": "null" } ], "title": "Days" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowPublicResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:post:/workflows/from-template", "surface": "api", "heading": "POST /workflows/from-template", "route": "/openapi.json", "anchor": "/paths/~1workflows~1from-template/post", "url": "/openapi.json#/paths/~1workflows~1from-template/post", "contract": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowFromTemplateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowPublicResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:delete:/workflows/{workflow_id}", "surface": "api", "heading": "DELETE /workflows/{workflow_id}", "route": "/openapi.json", "anchor": "/paths/~1workflows~1{workflow_id}/delete", "url": "/openapi.json#/paths/~1workflows~1{workflow_id}/delete", "contract": { "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowPublicResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:patch:/workflows/{workflow_id}", "surface": "api", "heading": "PATCH /workflows/{workflow_id}", "route": "/openapi.json", "anchor": "/paths/~1workflows~1{workflow_id}/patch", "url": "/openapi.json#/paths/~1workflows~1{workflow_id}/patch", "contract": { "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowStatusPatchRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowPublicResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiErrorResponse" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, { "id": "api:schema:ActionPublicItem", "surface": "api", "heading": "API response or request schema: ActionPublicItem", "route": "/openapi.json", "anchor": "/components/schemas/ActionPublicItem", "url": "/openapi.json#/components/schemas/ActionPublicItem", "contract": { "properties": { "id": { "type": "string", "title": "Id" }, "title": { "type": "string", "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Detail" }, "first_step": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First Step" }, "category": { "type": "string", "title": "Category" }, "action_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action Type" }, "effort": { "type": "string", "title": "Effort" }, "impact": { "type": "string", "title": "Impact" }, "priority_score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Priority Score" }, "priority_level": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Priority Level" }, "status": { "type": "string", "title": "Status" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "time_horizon": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Time Horizon" }, "affected_models": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Affected Models" }, "affected_query_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Affected Query Count" }, "deep_link": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deep Link" }, "pinned": { "type": "boolean", "title": "Pinned", "default": false }, "snoozed_until": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Snoozed Until" }, "action_data": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Action Data" }, "execution": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Execution" }, "family": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Family" }, "page_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Id" }, "page_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Url" }, "result": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Result" }, "proof": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Proof" }, "created_at": { "type": "string", "title": "Created At" }, "updated_at": { "type": "string", "title": "Updated At" }, "completed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Completed At" } }, "type": "object", "required": [ "id", "title", "category", "effort", "impact", "status", "created_at", "updated_at" ], "title": "ActionPublicItem" } }, { "id": "api:schema:ActionStatsPublicResponse", "surface": "api", "heading": "API response or request schema: ActionStatsPublicResponse", "route": "/openapi.json", "anchor": "/components/schemas/ActionStatsPublicResponse", "url": "/openapi.json#/components/schemas/ActionStatsPublicResponse", "contract": { "properties": { "total_pending": { "type": "integer", "title": "Total Pending" }, "total_in_progress": { "type": "integer", "title": "Total In Progress" }, "total_completed": { "type": "integer", "title": "Total Completed" }, "total_dismissed": { "type": "integer", "title": "Total Dismissed" }, "total_snoozed": { "type": "integer", "title": "Total Snoozed" }, "quick_wins": { "type": "integer", "title": "Quick Wins" }, "completion_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Completion Rate" }, "completed_this_week": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Completed This Week" }, "by_type": { "anyOf": [ { "additionalProperties": { "type": "integer" }, "type": "object" }, { "type": "null" } ], "title": "By Type" }, "by_category": { "anyOf": [ { "additionalProperties": { "type": "integer" }, "type": "object" }, { "type": "null" } ], "title": "By Category" }, "by_source": { "anyOf": [ { "additionalProperties": { "type": "integer" }, "type": "object" }, { "type": "null" } ], "title": "By Source" } }, "type": "object", "required": [ "total_pending", "total_in_progress", "total_completed", "total_dismissed", "total_snoozed", "quick_wins" ], "title": "ActionStatsPublicResponse" } }, { "id": "api:schema:ActionsPublicResponse", "surface": "api", "heading": "API response or request schema: ActionsPublicResponse", "route": "/openapi.json", "anchor": "/components/schemas/ActionsPublicResponse", "url": "/openapi.json#/components/schemas/ActionsPublicResponse", "contract": { "properties": { "actions": { "items": { "$ref": "#/components/schemas/ActionPublicItem" }, "type": "array", "title": "Actions" }, "pagination": { "$ref": "#/components/schemas/PaginationInfo" }, "suggestions": { "items": { "$ref": "#/components/schemas/SuggestedAction" }, "type": "array", "title": "Suggestions" }, "suggestion_total": { "type": "integer", "title": "Suggestion Total", "default": 0 }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note" } }, "type": "object", "required": [ "actions", "pagination" ], "title": "ActionsPublicResponse" } }, { "id": "api:schema:AddMarketRequest", "surface": "api", "heading": "API response or request schema: AddMarketRequest", "route": "/openapi.json", "anchor": "/components/schemas/AddMarketRequest", "url": "/openapi.json#/components/schemas/AddMarketRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "location": { "type": "string", "title": "Location" }, "market_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Market Name" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, "type": "object", "required": [ "brand_id", "location" ], "title": "AddMarketRequest" } }, { "id": "api:schema:AuditFindingsResponse", "surface": "api", "heading": "API response or request schema: AuditFindingsResponse", "route": "/openapi.json", "anchor": "/components/schemas/AuditFindingsResponse", "url": "/openapi.json#/components/schemas/AuditFindingsResponse", "contract": { "properties": { "status": { "type": "string", "enum": [ "ok", "no_audit_yet" ], "title": "Status", "default": "ok" }, "audit_summary": { "anyOf": [ { "$ref": "#/components/schemas/AuditFindingsSummary" }, { "type": "null" } ] }, "issues": { "items": { "$ref": "#/components/schemas/AuditIssueItem" }, "type": "array", "title": "Issues", "default": [] }, "issues_count": { "type": "integer", "title": "Issues Count", "default": 0 }, "pages": { "items": { "$ref": "#/components/schemas/AuditPageItem" }, "type": "array", "title": "Pages", "default": [] }, "pages_count": { "type": "integer", "title": "Pages Count", "default": 0 }, "pages_total_matching": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Pages Total Matching" }, "pages_truncated": { "type": "boolean", "title": "Pages Truncated", "default": false }, "filters_applied": { "additionalProperties": true, "type": "object", "title": "Filters Applied" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note" } }, "type": "object", "title": "AuditFindingsResponse" } }, { "id": "api:schema:AuditFindingsSummary", "surface": "api", "heading": "API response or request schema: AuditFindingsSummary", "route": "/openapi.json", "anchor": "/components/schemas/AuditFindingsSummary", "url": "/openapi.json#/components/schemas/AuditFindingsSummary", "contract": { "properties": { "audit_id": { "type": "string", "title": "Audit Id" }, "overall_score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Overall Score" }, "pages_crawled": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Pages Crawled" }, "critical_issues": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Critical Issues" }, "high_issues": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "High Issues" }, "medium_issues": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Medium Issues" }, "low_issues": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Low Issues" }, "detected_platform": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Detected Platform" }, "site_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Site Url" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "has_llms_txt": { "type": "boolean", "title": "Has Llms Txt", "default": false }, "ai_crawler_blocked": { "type": "boolean", "title": "Ai Crawler Blocked", "default": false }, "has_sitemap": { "type": "boolean", "title": "Has Sitemap", "default": false } }, "type": "object", "required": [ "audit_id" ], "title": "AuditFindingsSummary" } }, { "id": "api:schema:AuditIssueItem", "surface": "api", "heading": "API response or request schema: AuditIssueItem", "route": "/openapi.json", "anchor": "/components/schemas/AuditIssueItem", "url": "/openapi.json#/components/schemas/AuditIssueItem", "contract": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "check_name": { "type": "string", "title": "Check Name" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" }, "severity": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Severity" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "impact": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Impact" }, "affected_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Affected Count" }, "affected_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Affected Percent" }, "sample_urls": { "items": { "type": "string" }, "type": "array", "title": "Sample Urls", "default": [] }, "affected_urls": { "items": { "type": "string" }, "type": "array", "title": "Affected Urls", "default": [] }, "affected_urls_returned": { "type": "integer", "title": "Affected Urls Returned", "default": 0 }, "affected_urls_total": { "type": "integer", "title": "Affected Urls Total", "default": 0 }, "affected_urls_truncated": { "type": "boolean", "title": "Affected Urls Truncated", "default": false }, "fix_effort": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fix Effort" }, "fix_impact": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fix Impact" }, "implementation": { "items": {}, "type": "array", "title": "Implementation", "default": [] }, "fixed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fixed At" } }, "type": "object", "required": [ "check_name" ], "title": "AuditIssueItem" } }, { "id": "api:schema:AuditPageItem", "surface": "api", "heading": "API response or request schema: AuditPageItem", "route": "/openapi.json", "anchor": "/components/schemas/AuditPageItem", "url": "/openapi.json#/components/schemas/AuditPageItem", "contract": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "url": { "type": "string", "title": "Url" }, "final_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Final Url" }, "page_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Type" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "technical_score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Technical Score" }, "status_code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Status Code" }, "word_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Word Count" }, "failed_checks": { "items": { "type": "string" }, "type": "array", "title": "Failed Checks", "default": [] }, "warning_checks": { "items": { "type": "string" }, "type": "array", "title": "Warning Checks", "default": [] }, "is_deep_analyzed": { "type": "boolean", "title": "Is Deep Analyzed", "default": false } }, "type": "object", "required": [ "url" ], "title": "AuditPageItem" } }, { "id": "api:schema:AuditSummaryItem", "surface": "api", "heading": "API response or request schema: AuditSummaryItem", "route": "/openapi.json", "anchor": "/components/schemas/AuditSummaryItem", "url": "/openapi.json#/components/schemas/AuditSummaryItem", "contract": { "properties": { "id": { "type": "string", "title": "Id" }, "brand_id": { "type": "string", "title": "Brand Id" }, "site_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Site Url" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "overall_score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Overall Score" }, "pages_crawled": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Pages Crawled" }, "critical_issues": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Critical Issues" }, "high_issues": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "High Issues" }, "medium_issues": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Medium Issues" }, "low_issues": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Low Issues" }, "detected_platform": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Detected Platform" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "completed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Completed At" } }, "type": "object", "required": [ "id", "brand_id" ], "title": "AuditSummaryItem" } }, { "id": "api:schema:AuditsListResponse", "surface": "api", "heading": "API response or request schema: AuditsListResponse", "route": "/openapi.json", "anchor": "/components/schemas/AuditsListResponse", "url": "/openapi.json#/components/schemas/AuditsListResponse", "contract": { "properties": { "period": { "anyOf": [ { "$ref": "#/components/schemas/PeriodMeta" }, { "type": "null" } ] }, "audits": { "items": { "$ref": "#/components/schemas/AuditSummaryItem" }, "type": "array", "title": "Audits" }, "total": { "type": "integer", "title": "Total" } }, "type": "object", "required": [ "audits", "total" ], "title": "AuditsListResponse" } }, { "id": "api:schema:Body_trigger_public_crawler_verification_ping_api_v1_crawler_verification_ping_post", "surface": "api", "heading": "API response or request schema: Body_trigger_public_crawler_verification_ping_api_v1_crawler_verification_ping_post", "route": "/openapi.json", "anchor": "/components/schemas/Body_trigger_public_crawler_verification_ping_api_v1_crawler_verification_ping_post", "url": "/openapi.json#/components/schemas/Body_trigger_public_crawler_verification_ping_api_v1_crawler_verification_ping_post", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" } }, "type": "object", "required": [ "brand_id" ], "title": "Body_trigger_public_crawler_verification_ping_api_v1_crawler_verification_ping_post" } }, { "id": "api:schema:Body_trigger_public_crawler_verification_ping_crawler_verification_ping_post", "surface": "api", "heading": "API response or request schema: Body_trigger_public_crawler_verification_ping_crawler_verification_ping_post", "route": "/openapi.json", "anchor": "/components/schemas/Body_trigger_public_crawler_verification_ping_crawler_verification_ping_post", "url": "/openapi.json#/components/schemas/Body_trigger_public_crawler_verification_ping_crawler_verification_ping_post", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" } }, "type": "object", "required": [ "brand_id" ], "title": "Body_trigger_public_crawler_verification_ping_crawler_verification_ping_post" } }, { "id": "api:schema:Body_trigger_public_crawler_verification_ping_mcp_crawler_verification_ping_post", "surface": "api", "heading": "API response or request schema: Body_trigger_public_crawler_verification_ping_mcp_crawler_verification_ping_post", "route": "/openapi.json", "anchor": "/components/schemas/Body_trigger_public_crawler_verification_ping_mcp_crawler_verification_ping_post", "url": "/openapi.json#/components/schemas/Body_trigger_public_crawler_verification_ping_mcp_crawler_verification_ping_post", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" } }, "type": "object", "required": [ "brand_id" ], "title": "Body_trigger_public_crawler_verification_ping_mcp_crawler_verification_ping_post" } }, { "id": "api:schema:BrandAliasesResponse", "surface": "api", "heading": "API response or request schema: BrandAliasesResponse", "route": "/openapi.json", "anchor": "/components/schemas/BrandAliasesResponse", "url": "/openapi.json#/components/schemas/BrandAliasesResponse", "contract": { "properties": { "success": { "type": "boolean", "title": "Success" }, "brand_id": { "type": "string", "title": "Brand Id" }, "aliases": { "items": { "type": "string" }, "type": "array", "title": "Aliases" }, "reports_updated": { "type": "integer", "title": "Reports Updated" } }, "type": "object", "required": [ "success", "brand_id", "aliases", "reports_updated" ], "title": "BrandAliasesResponse" } }, { "id": "api:schema:BrandGroupsPublicResponse", "surface": "api", "heading": "API response or request schema: BrandGroupsPublicResponse", "route": "/openapi.json", "anchor": "/components/schemas/BrandGroupsPublicResponse", "url": "/openapi.json#/components/schemas/BrandGroupsPublicResponse", "contract": { "properties": { "groups": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Groups" }, "total": { "type": "integer", "title": "Total" } }, "type": "object", "required": [ "groups", "total" ], "title": "BrandGroupsPublicResponse" } }, { "id": "api:schema:BrandItemExtended", "surface": "api", "heading": "API response or request schema: BrandItemExtended", "route": "/openapi.json", "anchor": "/components/schemas/BrandItemExtended", "url": "/openapi.json#/components/schemas/BrandItemExtended", "contract": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Website" }, "favicon": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Favicon" }, "active": { "type": "boolean", "title": "Active", "default": true }, "role": { "type": "string", "enum": [ "owner", "editor", "viewer" ], "title": "Role", "default": "owner" }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location" }, "location_region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location Region" }, "location_city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location City" }, "markets": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MarketItem" }, "type": "array" }, { "type": "null" } ], "title": "Markets" }, "aliases": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Aliases" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" } }, "type": "object", "required": [ "id", "name" ], "title": "BrandItemExtended" } }, { "id": "api:schema:BrandPerformance", "surface": "api", "heading": "API response or request schema: BrandPerformance", "route": "/openapi.json", "anchor": "/components/schemas/BrandPerformance", "url": "/openapi.json#/components/schemas/BrandPerformance", "contract": { "properties": { "brand_name": { "type": "string", "title": "Brand Name" }, "total_mentions": { "type": "integer", "title": "Total Mentions" }, "avg_rank": { "type": "number", "title": "Avg Rank" } }, "type": "object", "required": [ "brand_name", "total_mentions", "avg_rank" ], "title": "BrandPerformance" } }, { "id": "api:schema:BrandsExtendedResponse", "surface": "api", "heading": "API response or request schema: BrandsExtendedResponse", "route": "/openapi.json", "anchor": "/components/schemas/BrandsExtendedResponse", "url": "/openapi.json#/components/schemas/BrandsExtendedResponse", "contract": { "properties": { "brands": { "items": { "$ref": "#/components/schemas/BrandItemExtended" }, "type": "array", "title": "Brands" } }, "type": "object", "required": [ "brands" ], "title": "BrandsExtendedResponse" } }, { "id": "api:schema:BulkActivateRequest", "surface": "api", "heading": "API response or request schema: BulkActivateRequest", "route": "/openapi.json", "anchor": "/components/schemas/BulkActivateRequest", "url": "/openapi.json#/components/schemas/BulkActivateRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "prompt_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "maxItems": 50, "minItems": 1, "title": "Prompt Ids" } }, "type": "object", "required": [ "brand_id", "prompt_ids" ], "title": "BulkActivateRequest" } }, { "id": "api:schema:BulkActivateResponse", "surface": "api", "heading": "API response or request schema: BulkActivateResponse", "route": "/openapi.json", "anchor": "/components/schemas/BulkActivateResponse", "url": "/openapi.json#/components/schemas/BulkActivateResponse", "contract": { "properties": { "updated": { "type": "integer", "title": "Updated" }, "prompt_ids": { "items": { "type": "string" }, "type": "array", "title": "Prompt Ids" } }, "type": "object", "required": [ "updated", "prompt_ids" ], "title": "BulkActivateResponse" } }, { "id": "api:schema:BulkCreatePromptItem", "surface": "api", "heading": "API response or request schema: BulkCreatePromptItem", "route": "/openapi.json", "anchor": "/components/schemas/BulkCreatePromptItem", "url": "/openapi.json#/components/schemas/BulkCreatePromptItem", "contract": { "properties": { "text": { "type": "string", "title": "Text" }, "active": { "type": "boolean", "title": "Active", "default": true }, "focus_area": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Focus Area" }, "intent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Intent" }, "audience": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Audience" } }, "type": "object", "required": [ "text" ], "title": "BulkCreatePromptItem" } }, { "id": "api:schema:BulkCreatePromptsRequest", "surface": "api", "heading": "API response or request schema: BulkCreatePromptsRequest", "route": "/openapi.json", "anchor": "/components/schemas/BulkCreatePromptsRequest", "url": "/openapi.json#/components/schemas/BulkCreatePromptsRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "prompts": { "items": { "$ref": "#/components/schemas/BulkCreatePromptItem" }, "type": "array", "maxItems": 50, "minItems": 1, "title": "Prompts" } }, "type": "object", "required": [ "brand_id", "prompts" ], "title": "BulkCreatePromptsRequest" } }, { "id": "api:schema:BulkCreatePromptsResponse", "surface": "api", "heading": "API response or request schema: BulkCreatePromptsResponse", "route": "/openapi.json", "anchor": "/components/schemas/BulkCreatePromptsResponse", "url": "/openapi.json#/components/schemas/BulkCreatePromptsResponse", "contract": { "properties": { "created": { "type": "integer", "title": "Created" }, "failed": { "type": "integer", "title": "Failed" }, "results": { "items": { "$ref": "#/components/schemas/BulkPromptResult" }, "type": "array", "title": "Results" } }, "type": "object", "required": [ "created", "failed", "results" ], "title": "BulkCreatePromptsResponse" } }, { "id": "api:schema:BulkDeletePromptsRequest", "surface": "api", "heading": "API response or request schema: BulkDeletePromptsRequest", "route": "/openapi.json", "anchor": "/components/schemas/BulkDeletePromptsRequest", "url": "/openapi.json#/components/schemas/BulkDeletePromptsRequest", "contract": { "properties": { "prompt_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "maxItems": 50, "minItems": 1, "title": "Prompt Ids" } }, "type": "object", "required": [ "prompt_ids" ], "title": "BulkDeletePromptsRequest" } }, { "id": "api:schema:BulkDeletePromptsResponse", "surface": "api", "heading": "API response or request schema: BulkDeletePromptsResponse", "route": "/openapi.json", "anchor": "/components/schemas/BulkDeletePromptsResponse", "url": "/openapi.json#/components/schemas/BulkDeletePromptsResponse", "contract": { "properties": { "deleted": { "type": "integer", "title": "Deleted" }, "failed": { "type": "integer", "title": "Failed" }, "results": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Results" } }, "type": "object", "required": [ "deleted", "failed", "results" ], "title": "BulkDeletePromptsResponse" } }, { "id": "api:schema:BulkPromptResult", "surface": "api", "heading": "API response or request schema: BulkPromptResult", "route": "/openapi.json", "anchor": "/components/schemas/BulkPromptResult", "url": "/openapi.json#/components/schemas/BulkPromptResult", "contract": { "properties": { "index": { "type": "integer", "title": "Index" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "text": { "type": "string", "title": "Text" }, "success": { "type": "boolean", "title": "Success" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" } }, "type": "object", "required": [ "index", "text", "success" ], "title": "BulkPromptResult" } }, { "id": "api:schema:BusinessContextResponse", "surface": "api", "heading": "API response or request schema: BusinessContextResponse", "route": "/openapi.json", "anchor": "/components/schemas/BusinessContextResponse", "url": "/openapi.json#/components/schemas/BusinessContextResponse", "contract": { "properties": { "brand_id": { "type": "string", "title": "Brand Id" }, "revision": { "type": "integer", "title": "Revision" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "about": { "additionalProperties": { "type": "string" }, "type": "object", "title": "About" }, "other_limits": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Other Limits" }, "rules": { "items": { "$ref": "#/components/schemas/BusinessContextRule" }, "type": "array", "title": "Rules" }, "content_standards": { "items": { "type": "string" }, "type": "array", "title": "Content Standards" }, "guidance": { "type": "string", "title": "Guidance", "default": "" } }, "type": "object", "required": [ "brand_id", "revision" ], "title": "BusinessContextResponse" } }, { "id": "api:schema:BusinessContextRule", "surface": "api", "heading": "API response or request schema: BusinessContextRule", "route": "/openapi.json", "anchor": "/components/schemas/BusinessContextRule", "url": "/openapi.json#/components/schemas/BusinessContextRule", "contract": { "properties": { "kind": { "type": "string", "title": "Kind" }, "label": { "type": "string", "title": "Label" }, "text": { "type": "string", "title": "Text" } }, "type": "object", "required": [ "kind", "label", "text" ], "title": "BusinessContextRule" } }, { "id": "api:schema:CitationAppearance", "surface": "api", "heading": "API response or request schema: CitationAppearance", "route": "/openapi.json", "anchor": "/components/schemas/CitationAppearance", "url": "/openapi.json#/components/schemas/CitationAppearance", "contract": { "properties": { "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" }, "prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt" } }, "type": "object", "title": "CitationAppearance" } }, { "id": "api:schema:CitationDetailResponse", "surface": "api", "heading": "API response or request schema: CitationDetailResponse", "route": "/openapi.json", "anchor": "/components/schemas/CitationDetailResponse", "url": "/openapi.json#/components/schemas/CitationDetailResponse", "contract": { "properties": { "brand": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Brand" }, "url": { "type": "string", "title": "Url" }, "domain": { "type": "string", "title": "Domain" }, "h1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "H1" }, "sentiment": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sentiment" }, "sentiment_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sentiment Label" }, "mentions_brand": { "type": "boolean", "title": "Mentions Brand", "default": false }, "brand_check": { "type": "string", "title": "Brand Check", "default": "not_mentioned" }, "not_checked_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Not Checked Reason" }, "competitors": { "items": { "type": "string" }, "type": "array", "title": "Competitors", "default": [] }, "topics": { "items": { "type": "string" }, "type": "array", "title": "Topics", "default": [] }, "appearance_count": { "type": "integer", "title": "Appearance Count", "default": 1 }, "first_seen": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First Seen" }, "last_seen": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Seen" }, "prompts": { "items": { "type": "string" }, "type": "array", "title": "Prompts", "default": [] }, "source_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Type" }, "appearances": { "items": { "$ref": "#/components/schemas/CitationAppearance" }, "type": "array", "title": "Appearances", "default": [] }, "related_citations": { "items": { "type": "string" }, "type": "array", "title": "Related Citations", "default": [] } }, "type": "object", "required": [ "brand", "url", "domain" ], "title": "CitationDetailResponse" } }, { "id": "api:schema:CitationItem", "surface": "api", "heading": "API response or request schema: CitationItem", "route": "/openapi.json", "anchor": "/components/schemas/CitationItem", "url": "/openapi.json#/components/schemas/CitationItem", "contract": { "properties": { "id": { "type": "string", "title": "Id" }, "url": { "type": "string", "title": "Url" }, "domain": { "type": "string", "title": "Domain" }, "page_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Title" }, "prompt": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Prompt", "default": {} }, "prompts": { "items": { "type": "string" }, "type": "array", "title": "Prompts", "default": [] }, "metrics": { "additionalProperties": true, "type": "object", "title": "Metrics", "default": {} }, "seo": { "additionalProperties": true, "type": "object", "title": "Seo", "default": {} }, "source_type": { "type": "string", "title": "Source Type", "default": "organic" }, "search_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search Model" }, "ai_provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ai Provider" }, "ai_providers": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ai Providers" }, "provider_counts": { "anyOf": [ { "additionalProperties": { "type": "integer" }, "type": "object" }, { "type": "null" } ], "title": "Provider Counts" }, "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date" }, "mentions_brand": { "type": "boolean", "title": "Mentions Brand", "default": false }, "brand_check": { "type": "string", "title": "Brand Check", "default": "not_mentioned" }, "not_checked_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Not Checked Reason" }, "competitors": { "items": { "type": "string" }, "type": "array", "title": "Competitors", "default": [] }, "first_seen": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First Seen" }, "last_seen": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Seen" } }, "type": "object", "required": [ "id", "url", "domain" ], "title": "CitationItem" } }, { "id": "api:schema:CitationsAnalyticsResponse", "surface": "api", "heading": "API response or request schema: CitationsAnalyticsResponse", "route": "/openapi.json", "anchor": "/components/schemas/CitationsAnalyticsResponse", "url": "/openapi.json#/components/schemas/CitationsAnalyticsResponse", "contract": { "properties": { "period": { "anyOf": [ { "$ref": "#/components/schemas/PeriodMeta" }, { "type": "null" } ] }, "brand": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Brand" }, "summary": { "$ref": "#/components/schemas/CitationsSummary" }, "top_domains": { "items": { "$ref": "#/components/schemas/CitationsTopDomain" }, "type": "array", "title": "Top Domains" }, "top_competitors": { "items": { "$ref": "#/components/schemas/CitationsTopCompetitor" }, "type": "array", "title": "Top Competitors" }, "period_figures": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Period Figures" } }, "type": "object", "required": [ "brand", "summary", "top_domains", "top_competitors" ], "title": "CitationsAnalyticsResponse" } }, { "id": "api:schema:CitationsByModelItem", "surface": "api", "heading": "API response or request schema: CitationsByModelItem", "route": "/openapi.json", "anchor": "/components/schemas/CitationsByModelItem", "url": "/openapi.json#/components/schemas/CitationsByModelItem", "contract": { "properties": { "model": { "type": "string", "title": "Model" }, "total_citations": { "type": "integer", "title": "Total Citations" }, "brand_mentions": { "type": "integer", "title": "Brand Mentions" }, "unique_sources": { "type": "integer", "title": "Unique Sources" }, "top_domains": { "items": { "type": "string" }, "type": "array", "title": "Top Domains", "default": [] } }, "type": "object", "required": [ "model", "total_citations", "brand_mentions", "unique_sources" ], "title": "CitationsByModelItem" } }, { "id": "api:schema:CitationsByModelResponse", "surface": "api", "heading": "API response or request schema: CitationsByModelResponse", "route": "/openapi.json", "anchor": "/components/schemas/CitationsByModelResponse", "url": "/openapi.json#/components/schemas/CitationsByModelResponse", "contract": { "properties": { "brand": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Brand" }, "models": { "items": { "$ref": "#/components/schemas/CitationsByModelItem" }, "type": "array", "title": "Models" } }, "type": "object", "required": [ "brand", "models" ], "title": "CitationsByModelResponse" } }, { "id": "api:schema:CitationsCompetitorPoint", "surface": "api", "heading": "API response or request schema: CitationsCompetitorPoint", "route": "/openapi.json", "anchor": "/components/schemas/CitationsCompetitorPoint", "url": "/openapi.json#/components/schemas/CitationsCompetitorPoint", "contract": { "properties": { "date": { "type": "string", "title": "Date" }, "mentions": { "type": "integer", "title": "Mentions" } }, "type": "object", "required": [ "date", "mentions" ], "title": "CitationsCompetitorPoint" } }, { "id": "api:schema:CitationsDomainPage", "surface": "api", "heading": "API response or request schema: CitationsDomainPage", "route": "/openapi.json", "anchor": "/components/schemas/CitationsDomainPage", "url": "/openapi.json#/components/schemas/CitationsDomainPage", "contract": { "properties": { "url": { "type": "string", "title": "Url" }, "h1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "H1" }, "sentiment": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sentiment" }, "mentions_brand": { "type": "boolean", "title": "Mentions Brand", "default": false }, "brand_check": { "type": "string", "title": "Brand Check", "default": "not_mentioned" }, "not_checked_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Not Checked Reason" }, "competitors": { "items": { "type": "string" }, "type": "array", "title": "Competitors", "default": [] }, "appearance_count": { "type": "integer", "title": "Appearance Count", "default": 1 } }, "type": "object", "required": [ "url" ], "title": "CitationsDomainPage" } }, { "id": "api:schema:CitationsFeedEvent", "surface": "api", "heading": "API response or request schema: CitationsFeedEvent", "route": "/openapi.json", "anchor": "/components/schemas/CitationsFeedEvent", "url": "/openapi.json#/components/schemas/CitationsFeedEvent", "contract": { "properties": { "event_type": { "type": "string", "title": "Event Type" }, "url": { "type": "string", "title": "Url" }, "domain": { "type": "string", "title": "Domain" }, "h1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "H1" }, "source_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Type" }, "timestamp": { "type": "string", "title": "Timestamp" }, "mentions_brand": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Mentions Brand" }, "sentiment": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sentiment" }, "prev_sentiment": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Prev Sentiment" }, "appearance_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Appearance Count" }, "prev_appearance_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Prev Appearance Count" }, "new_competitors": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "New Competitors" }, "prompts": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Prompts" } }, "type": "object", "required": [ "event_type", "url", "domain", "timestamp" ], "title": "CitationsFeedEvent" } }, { "id": "api:schema:CitationsFeedResponse", "surface": "api", "heading": "API response or request schema: CitationsFeedResponse", "route": "/openapi.json", "anchor": "/components/schemas/CitationsFeedResponse", "url": "/openapi.json#/components/schemas/CitationsFeedResponse", "contract": { "properties": { "brand": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Brand" }, "events": { "items": { "$ref": "#/components/schemas/CitationsFeedEvent" }, "type": "array", "title": "Events" }, "current_snapshot_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Current Snapshot Date" }, "previous_snapshot_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Snapshot Date" }, "total_current": { "type": "integer", "title": "Total Current", "default": 0 }, "total_previous": { "type": "integer", "title": "Total Previous", "default": 0 } }, "type": "object", "required": [ "brand", "events" ], "title": "CitationsFeedResponse" } }, { "id": "api:schema:CitationsHeatmapCell", "surface": "api", "heading": "API response or request schema: CitationsHeatmapCell", "route": "/openapi.json", "anchor": "/components/schemas/CitationsHeatmapCell", "url": "/openapi.json#/components/schemas/CitationsHeatmapCell", "contract": { "properties": { "domain": { "type": "string", "title": "Domain" }, "brand": { "type": "string", "title": "Brand" }, "is_present": { "type": "boolean", "title": "Is Present" }, "mention_count": { "type": "integer", "title": "Mention Count" } }, "type": "object", "required": [ "domain", "brand", "is_present", "mention_count" ], "title": "CitationsHeatmapCell" } }, { "id": "api:schema:CitationsHeatmapResponse", "surface": "api", "heading": "API response or request schema: CitationsHeatmapResponse", "route": "/openapi.json", "anchor": "/components/schemas/CitationsHeatmapResponse", "url": "/openapi.json#/components/schemas/CitationsHeatmapResponse", "contract": { "properties": { "brand": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Brand" }, "domains": { "items": { "type": "string" }, "type": "array", "title": "Domains" }, "brands": { "items": { "type": "string" }, "type": "array", "title": "Brands" }, "your_brand": { "type": "string", "title": "Your Brand" }, "cells": { "items": { "$ref": "#/components/schemas/CitationsHeatmapCell" }, "type": "array", "title": "Cells" }, "your_coverage": { "type": "number", "title": "Your Coverage" }, "competitor_coverage": { "additionalProperties": { "type": "number" }, "type": "object", "title": "Competitor Coverage" } }, "type": "object", "required": [ "brand", "domains", "brands", "your_brand", "cells", "your_coverage", "competitor_coverage" ], "title": "CitationsHeatmapResponse" } }, { "id": "api:schema:CitationsHistoryResponse", "surface": "api", "heading": "API response or request schema: CitationsHistoryResponse", "route": "/openapi.json", "anchor": "/components/schemas/CitationsHistoryResponse", "url": "/openapi.json#/components/schemas/CitationsHistoryResponse", "contract": { "properties": { "brand": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Brand" }, "brand_time_series": { "items": { "$ref": "#/components/schemas/CitationsTimeSeriesPoint" }, "type": "array", "title": "Brand Time Series" }, "competitor_time_series": { "additionalProperties": { "items": { "$ref": "#/components/schemas/CitationsCompetitorPoint" }, "type": "array" }, "type": "object", "title": "Competitor Time Series" }, "snapshots_available": { "type": "integer", "title": "Snapshots Available" }, "date_range": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Date Range" } }, "type": "object", "required": [ "brand", "brand_time_series", "competitor_time_series", "snapshots_available", "date_range" ], "title": "CitationsHistoryResponse" } }, { "id": "api:schema:CitationsQueriesResponse", "surface": "api", "heading": "API response or request schema: CitationsQueriesResponse", "route": "/openapi.json", "anchor": "/components/schemas/CitationsQueriesResponse", "url": "/openapi.json#/components/schemas/CitationsQueriesResponse", "contract": { "properties": { "brand": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Brand" }, "clusters": { "items": { "$ref": "#/components/schemas/CitationsQueryCluster" }, "type": "array", "title": "Clusters" }, "top_queries": { "items": { "$ref": "#/components/schemas/CitationsQueryInsight" }, "type": "array", "title": "Top Queries" }, "gap_queries": { "items": { "$ref": "#/components/schemas/CitationsQueryInsight" }, "type": "array", "title": "Gap Queries" }, "coverage_by_intent": { "additionalProperties": { "type": "number" }, "type": "object", "title": "Coverage By Intent" }, "new_queries_count": { "type": "integer", "title": "New Queries Count" }, "rising_queries_count": { "type": "integer", "title": "Rising Queries Count" } }, "type": "object", "required": [ "brand", "clusters", "top_queries", "gap_queries", "coverage_by_intent", "new_queries_count", "rising_queries_count" ], "title": "CitationsQueriesResponse" } }, { "id": "api:schema:CitationsQueryCluster", "surface": "api", "heading": "API response or request schema: CitationsQueryCluster", "route": "/openapi.json", "anchor": "/components/schemas/CitationsQueryCluster", "url": "/openapi.json#/components/schemas/CitationsQueryCluster", "contract": { "properties": { "intent": { "type": "string", "title": "Intent" }, "label": { "type": "string", "title": "Label" }, "queries": { "items": { "type": "string" }, "type": "array", "title": "Queries" }, "total_citations": { "type": "integer", "title": "Total Citations" }, "brand_appears_in": { "type": "integer", "title": "Brand Appears In" }, "coverage_rate": { "type": "number", "title": "Coverage Rate" } }, "type": "object", "required": [ "intent", "label", "queries", "total_citations", "brand_appears_in", "coverage_rate" ], "title": "CitationsQueryCluster" } }, { "id": "api:schema:CitationsQueryInsight", "surface": "api", "heading": "API response or request schema: CitationsQueryInsight", "route": "/openapi.json", "anchor": "/components/schemas/CitationsQueryInsight", "url": "/openapi.json#/components/schemas/CitationsQueryInsight", "contract": { "properties": { "query": { "type": "string", "title": "Query" }, "intent": { "type": "string", "title": "Intent" }, "frequency": { "type": "integer", "title": "Frequency" }, "citations_found": { "type": "integer", "title": "Citations Found" }, "brand_appears": { "type": "boolean", "title": "Brand Appears" }, "top_sources": { "items": { "type": "string" }, "type": "array", "title": "Top Sources" }, "competitors_appearing": { "items": { "type": "string" }, "type": "array", "title": "Competitors Appearing" }, "is_new": { "type": "boolean", "title": "Is New" }, "trend": { "type": "string", "title": "Trend" } }, "type": "object", "required": [ "query", "intent", "frequency", "citations_found", "brand_appears", "top_sources", "competitors_appearing", "is_new", "trend" ], "title": "CitationsQueryInsight" } }, { "id": "api:schema:CitationsResponse", "surface": "api", "heading": "API response or request schema: CitationsResponse", "route": "/openapi.json", "anchor": "/components/schemas/CitationsResponse", "url": "/openapi.json#/components/schemas/CitationsResponse", "contract": { "properties": { "brand": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Brand" }, "citations": { "items": { "$ref": "#/components/schemas/CitationItem" }, "type": "array", "title": "Citations" }, "pagination": { "$ref": "#/components/schemas/PaginationInfo" } }, "type": "object", "required": [ "brand", "citations", "pagination" ], "title": "CitationsResponse" } }, { "id": "api:schema:CitationsSourceResponse", "surface": "api", "heading": "API response or request schema: CitationsSourceResponse", "route": "/openapi.json", "anchor": "/components/schemas/CitationsSourceResponse", "url": "/openapi.json#/components/schemas/CitationsSourceResponse", "contract": { "properties": { "brand": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Brand" }, "domain": { "type": "string", "title": "Domain" }, "total_citations": { "type": "integer", "title": "Total Citations" }, "unique_pages": { "type": "integer", "title": "Unique Pages" }, "mentions_you": { "type": "boolean", "title": "Mentions You" }, "mention_count": { "type": "integer", "title": "Mention Count" }, "competitors_on_domain": { "items": { "type": "string" }, "type": "array", "title": "Competitors On Domain" }, "avg_sentiment": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Avg Sentiment" }, "pages": { "items": { "$ref": "#/components/schemas/CitationsDomainPage" }, "type": "array", "title": "Pages" }, "first_seen": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First Seen" }, "last_seen": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Seen" } }, "type": "object", "required": [ "brand", "domain", "total_citations", "unique_pages", "mentions_you", "mention_count", "competitors_on_domain", "pages" ], "title": "CitationsSourceResponse" } }, { "id": "api:schema:CitationsSummary", "surface": "api", "heading": "API response or request schema: CitationsSummary", "route": "/openapi.json", "anchor": "/components/schemas/CitationsSummary", "url": "/openapi.json#/components/schemas/CitationsSummary", "contract": { "properties": { "total_citations": { "type": "integer", "title": "Total Citations" }, "unique_sources": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Unique Sources" }, "total_domains": { "type": "integer", "title": "Total Domains" }, "brand_mentions": { "type": "integer", "title": "Brand Mentions" }, "competitor_mentions": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Competitor Mentions" }, "positive_percentage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Positive Percentage" }, "avg_sentiment": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Avg Sentiment" }, "citations_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Citations Change" }, "brand_mentions_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Brand Mentions Change" }, "source_type_breakdown": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SourceTypeStats" }, "type": "array" }, { "type": "null" } ], "title": "Source Type Breakdown" } }, "type": "object", "required": [ "total_citations", "total_domains", "brand_mentions" ], "title": "CitationsSummary" } }, { "id": "api:schema:CitationsTimeSeriesPoint", "surface": "api", "heading": "API response or request schema: CitationsTimeSeriesPoint", "route": "/openapi.json", "anchor": "/components/schemas/CitationsTimeSeriesPoint", "url": "/openapi.json#/components/schemas/CitationsTimeSeriesPoint", "contract": { "properties": { "date": { "type": "string", "title": "Date" }, "total_citations": { "type": "integer", "title": "Total Citations" }, "new_citations": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "New Citations" }, "brand_mentions": { "type": "integer", "title": "Brand Mentions" }, "new_brand_mentions": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "New Brand Mentions" }, "unique_sources": { "type": "integer", "title": "Unique Sources" }, "avg_sentiment": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Avg Sentiment" } }, "type": "object", "required": [ "date", "total_citations", "brand_mentions", "unique_sources" ], "title": "CitationsTimeSeriesPoint" } }, { "id": "api:schema:CitationsTopCompetitor", "surface": "api", "heading": "API response or request schema: CitationsTopCompetitor", "route": "/openapi.json", "anchor": "/components/schemas/CitationsTopCompetitor", "url": "/openapi.json#/components/schemas/CitationsTopCompetitor", "contract": { "properties": { "name": { "type": "string", "title": "Name" }, "times_cited": { "type": "integer", "title": "Times Cited" }, "unique_sources": { "type": "integer", "title": "Unique Sources" }, "citation_share": { "type": "number", "title": "Citation Share" } }, "type": "object", "required": [ "name", "times_cited", "unique_sources", "citation_share" ], "title": "CitationsTopCompetitor" } }, { "id": "api:schema:CitationsTopDomain", "surface": "api", "heading": "API response or request schema: CitationsTopDomain", "route": "/openapi.json", "anchor": "/components/schemas/CitationsTopDomain", "url": "/openapi.json#/components/schemas/CitationsTopDomain", "contract": { "properties": { "domain": { "type": "string", "title": "Domain" }, "times_cited": { "type": "integer", "title": "Times Cited" }, "unique_pages": { "type": "integer", "title": "Unique Pages" }, "citation_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Citation Share" }, "source_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Type" } }, "type": "object", "required": [ "domain", "times_cited", "unique_pages" ], "title": "CitationsTopDomain" } }, { "id": "api:schema:CitationsTopPage", "surface": "api", "heading": "API response or request schema: CitationsTopPage", "route": "/openapi.json", "anchor": "/components/schemas/CitationsTopPage", "url": "/openapi.json#/components/schemas/CitationsTopPage", "contract": { "properties": { "url": { "type": "string", "title": "Url" }, "domain": { "type": "string", "title": "Domain" }, "h1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "H1" }, "appearance_count": { "type": "integer", "title": "Appearance Count", "default": 1 }, "appearance_count_30d": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Appearance Count 30D" }, "sentiment": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sentiment" }, "mentions_brand": { "type": "boolean", "title": "Mentions Brand", "default": false }, "brand_check": { "type": "string", "title": "Brand Check", "default": "not_mentioned" }, "not_checked_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Not Checked Reason" }, "competitors": { "items": { "type": "string" }, "type": "array", "title": "Competitors", "default": [] }, "source_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Type" }, "appearance_count_period": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Appearance Count Period" }, "models": { "items": { "type": "string" }, "type": "array", "title": "Models", "default": [] } }, "type": "object", "required": [ "url", "domain" ], "title": "CitationsTopPage" } }, { "id": "api:schema:CitationsTopPagesResponse", "surface": "api", "heading": "API response or request schema: CitationsTopPagesResponse", "route": "/openapi.json", "anchor": "/components/schemas/CitationsTopPagesResponse", "url": "/openapi.json#/components/schemas/CitationsTopPagesResponse", "contract": { "properties": { "period": { "anyOf": [ { "$ref": "#/components/schemas/PeriodMeta" }, { "type": "null" } ] }, "brand": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Brand" }, "pages": { "items": { "$ref": "#/components/schemas/CitationsTopPage" }, "type": "array", "title": "Pages" }, "total": { "type": "integer", "title": "Total" } }, "type": "object", "required": [ "brand", "pages", "total" ], "title": "CitationsTopPagesResponse" } }, { "id": "api:schema:CoOccurrence", "surface": "api", "heading": "API response or request schema: CoOccurrence", "route": "/openapi.json", "anchor": "/components/schemas/CoOccurrence", "url": "/openapi.json#/components/schemas/CoOccurrence", "contract": { "properties": { "competitor": { "type": "string", "title": "Competitor" }, "count": { "type": "integer", "title": "Count" }, "primary_wins_pct": { "type": "number", "title": "Primary Wins Pct" } }, "type": "object", "required": [ "competitor", "count", "primary_wins_pct" ], "title": "CoOccurrence" } }, { "id": "api:schema:CommitOpportunityPublicResponse", "surface": "api", "heading": "API response or request schema: CommitOpportunityPublicResponse", "route": "/openapi.json", "anchor": "/components/schemas/CommitOpportunityPublicResponse", "url": "/openapi.json#/components/schemas/CommitOpportunityPublicResponse", "contract": { "properties": { "status": { "type": "string", "title": "Status" }, "opportunity_id": { "type": "string", "title": "Opportunity Id" }, "action_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action Id" }, "measurement_plan": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Measurement Plan" } }, "additionalProperties": true, "type": "object", "required": [ "status", "opportunity_id" ], "title": "CommitOpportunityPublicResponse" } }, { "id": "api:schema:CommitOpportunityRequest", "surface": "api", "heading": "API response or request schema: CommitOpportunityRequest", "route": "/openapi.json", "anchor": "/components/schemas/CommitOpportunityRequest", "url": "/openapi.json#/components/schemas/CommitOpportunityRequest", "contract": { "properties": { "opportunity_id": { "type": "string", "format": "uuid", "title": "Opportunity Id" }, "action": { "type": "string", "title": "Action", "default": "commit" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "snooze_days": { "anyOf": [ { "type": "integer", "maximum": 90.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Snooze Days" } }, "type": "object", "required": [ "opportunity_id" ], "title": "CommitOpportunityRequest" } }, { "id": "api:schema:CompareBrandsPublicResponse", "surface": "api", "heading": "API response or request schema: CompareBrandsPublicResponse", "route": "/openapi.json", "anchor": "/components/schemas/CompareBrandsPublicResponse", "url": "/openapi.json#/components/schemas/CompareBrandsPublicResponse", "contract": { "properties": { "brands": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Brands" }, "period_days": { "type": "integer", "title": "Period Days" }, "metrics": { "items": { "type": "string", "enum": [ "visibility", "citations", "actions" ] }, "type": "array", "title": "Metrics" } }, "type": "object", "required": [ "brands", "period_days", "metrics" ], "title": "CompareBrandsPublicResponse" } }, { "id": "api:schema:CompareBrandsRequest", "surface": "api", "heading": "API response or request schema: CompareBrandsRequest", "route": "/openapi.json", "anchor": "/components/schemas/CompareBrandsRequest", "url": "/openapi.json#/components/schemas/CompareBrandsRequest", "contract": { "properties": { "brand_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "maxItems": 10, "minItems": 2, "title": "Brand Ids" }, "days": { "type": "integer", "maximum": 365.0, "minimum": 7.0, "title": "Days", "default": 30 }, "metrics": { "anyOf": [ { "items": { "type": "string", "enum": [ "visibility", "citations", "actions" ] }, "type": "array" }, { "type": "null" } ], "title": "Metrics" } }, "type": "object", "required": [ "brand_ids" ], "title": "CompareBrandsRequest" } }, { "id": "api:schema:CompetitorAlertItem", "surface": "api", "heading": "API response or request schema: CompetitorAlertItem", "route": "/openapi.json", "anchor": "/components/schemas/CompetitorAlertItem", "url": "/openapi.json#/components/schemas/CompetitorAlertItem", "contract": { "properties": { "type": { "type": "string", "title": "Type" }, "severity": { "type": "string", "title": "Severity" }, "message": { "type": "string", "title": "Message" }, "prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt" }, "competitor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Competitor" } }, "type": "object", "required": [ "type", "severity", "message" ], "title": "CompetitorAlertItem" } }, { "id": "api:schema:CompetitorArenaPrompt", "surface": "api", "heading": "API response or request schema: CompetitorArenaPrompt", "route": "/openapi.json", "anchor": "/components/schemas/CompetitorArenaPrompt", "url": "/openapi.json#/components/schemas/CompetitorArenaPrompt", "contract": { "properties": { "prompt_text": { "type": "string", "title": "Prompt Text" }, "your_rank": { "type": "integer", "title": "Your Rank" }, "your_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Your Score" }, "leader": { "type": "string", "title": "Leader" }, "leader_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Leader Score" }, "gap_to_leader": { "type": "number", "title": "Gap To Leader" }, "total_competitors": { "type": "integer", "title": "Total Competitors" }, "rankings": { "items": { "$ref": "#/components/schemas/CompetitorArenaRanking" }, "type": "array", "title": "Rankings" } }, "type": "object", "required": [ "prompt_text", "your_rank", "leader", "gap_to_leader", "total_competitors", "rankings" ], "title": "CompetitorArenaPrompt" } }, { "id": "api:schema:CompetitorArenaRanking", "surface": "api", "heading": "API response or request schema: CompetitorArenaRanking", "route": "/openapi.json", "anchor": "/components/schemas/CompetitorArenaRanking", "url": "/openapi.json#/components/schemas/CompetitorArenaRanking", "contract": { "properties": { "rank": { "type": "integer", "title": "Rank" }, "name": { "type": "string", "title": "Name" }, "score": { "type": "number", "title": "Score" }, "is_you": { "type": "boolean", "title": "Is You", "default": false } }, "type": "object", "required": [ "rank", "name", "score" ], "title": "CompetitorArenaRanking" } }, { "id": "api:schema:CompetitorArenaResponse", "surface": "api", "heading": "API response or request schema: CompetitorArenaResponse", "route": "/openapi.json", "anchor": "/components/schemas/CompetitorArenaResponse", "url": "/openapi.json#/components/schemas/CompetitorArenaResponse", "contract": { "properties": { "prompts": { "items": { "$ref": "#/components/schemas/CompetitorArenaPrompt" }, "type": "array", "title": "Prompts" }, "total_prompts": { "type": "integer", "title": "Total Prompts" }, "prompts_you_lead": { "type": "integer", "title": "Prompts You Lead" }, "prompts_top_3": { "type": "integer", "title": "Prompts Top 3" } }, "type": "object", "required": [ "prompts", "total_prompts", "prompts_you_lead", "prompts_top_3" ], "title": "CompetitorArenaResponse" } }, { "id": "api:schema:CompetitorBrandStats", "surface": "api", "heading": "API response or request schema: CompetitorBrandStats", "route": "/openapi.json", "anchor": "/components/schemas/CompetitorBrandStats", "url": "/openapi.json#/components/schemas/CompetitorBrandStats", "contract": { "properties": { "name": { "type": "string", "title": "Name" }, "visibility": { "type": "number", "title": "Visibility" }, "visibility_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Visibility Change" }, "avg_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Avg Rank" }, "rank1_count": { "type": "integer", "title": "Rank1 Count", "default": 0 } }, "type": "object", "required": [ "name", "visibility" ], "title": "CompetitorBrandStats" } }, { "id": "api:schema:CompetitorByModelResponse", "surface": "api", "heading": "API response or request schema: CompetitorByModelResponse", "route": "/openapi.json", "anchor": "/components/schemas/CompetitorByModelResponse", "url": "/openapi.json#/components/schemas/CompetitorByModelResponse", "contract": { "properties": { "llms": { "items": { "type": "string" }, "type": "array", "title": "Llms" }, "brands": { "items": { "type": "string" }, "type": "array", "title": "Brands" }, "your_brand": { "type": "string", "title": "Your Brand" }, "heatmap": { "items": { "$ref": "#/components/schemas/CompetitorLLMCell" }, "type": "array", "title": "Heatmap" }, "insights": { "items": { "$ref": "#/components/schemas/CompetitorLLMInsight" }, "type": "array", "title": "Insights" }, "your_best_llm": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Your Best Llm" }, "your_worst_llm": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Your Worst Llm" } }, "type": "object", "required": [ "llms", "brands", "your_brand", "heatmap", "insights" ], "title": "CompetitorByModelResponse" } }, { "id": "api:schema:CompetitorDataResponse", "surface": "api", "heading": "API response or request schema: CompetitorDataResponse", "route": "/openapi.json", "anchor": "/components/schemas/CompetitorDataResponse", "url": "/openapi.json#/components/schemas/CompetitorDataResponse", "contract": { "properties": { "brand_performance_summary": { "items": { "$ref": "#/components/schemas/BrandPerformance" }, "type": "array", "title": "Brand Performance Summary" }, "top_spot_ownership": { "items": { "$ref": "#/components/schemas/TopSpotOwnership" }, "type": "array", "title": "Top Spot Ownership" }, "primary_brand_cooccurrences": { "items": { "$ref": "#/components/schemas/CoOccurrence" }, "type": "array", "title": "Primary Brand Cooccurrences" }, "filters_applied": { "anyOf": [ { "$ref": "#/components/schemas/CompetitorFiltersApplied" }, { "type": "null" } ] } }, "type": "object", "required": [ "brand_performance_summary", "top_spot_ownership", "primary_brand_cooccurrences" ], "title": "CompetitorDataResponse" } }, { "id": "api:schema:CompetitorFiltersApplied", "surface": "api", "heading": "API response or request schema: CompetitorFiltersApplied", "route": "/openapi.json", "anchor": "/components/schemas/CompetitorFiltersApplied", "url": "/openapi.json#/components/schemas/CompetitorFiltersApplied", "contract": { "properties": { "days": { "type": "integer", "title": "Days" }, "tag_ids": { "items": { "type": "string" }, "type": "array", "title": "Tag Ids", "default": [] }, "prompts_in_scope": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Prompts In Scope" } }, "type": "object", "required": [ "days" ], "title": "CompetitorFiltersApplied" } }, { "id": "api:schema:CompetitorH2HRecord", "surface": "api", "heading": "API response or request schema: CompetitorH2HRecord", "route": "/openapi.json", "anchor": "/components/schemas/CompetitorH2HRecord", "url": "/openapi.json#/components/schemas/CompetitorH2HRecord", "contract": { "properties": { "your_wins": { "type": "integer", "title": "Your Wins" }, "rival_wins": { "type": "integer", "title": "Rival Wins" }, "ties": { "type": "integer", "title": "Ties" }, "your_win_rate": { "type": "number", "title": "Your Win Rate" }, "total_matchups": { "type": "integer", "title": "Total Matchups" } }, "type": "object", "required": [ "your_wins", "rival_wins", "ties", "your_win_rate", "total_matchups" ], "title": "CompetitorH2HRecord" } }, { "id": "api:schema:CompetitorH2HResponse", "surface": "api", "heading": "API response or request schema: CompetitorH2HResponse", "route": "/openapi.json", "anchor": "/components/schemas/CompetitorH2HResponse", "url": "/openapi.json#/components/schemas/CompetitorH2HResponse", "contract": { "properties": { "you": { "$ref": "#/components/schemas/CompetitorBrandStats" }, "rival": { "$ref": "#/components/schemas/CompetitorBrandStats" }, "head_to_head": { "$ref": "#/components/schemas/CompetitorH2HRecord" }, "where_rival_wins": { "items": { "$ref": "#/components/schemas/CompetitorPromptMatchup" }, "type": "array", "title": "Where Rival Wins" }, "where_you_win": { "items": { "$ref": "#/components/schemas/CompetitorPromptMatchup" }, "type": "array", "title": "Where You Win" }, "available_rivals": { "items": { "type": "string" }, "type": "array", "title": "Available Rivals" }, "filters_applied": { "anyOf": [ { "$ref": "#/components/schemas/CompetitorFiltersApplied" }, { "type": "null" } ] } }, "type": "object", "required": [ "you", "rival", "head_to_head", "where_rival_wins", "where_you_win", "available_rivals" ], "title": "CompetitorH2HResponse" } }, { "id": "api:schema:CompetitorHeatmapCell", "surface": "api", "heading": "API response or request schema: CompetitorHeatmapCell", "route": "/openapi.json", "anchor": "/components/schemas/CompetitorHeatmapCell", "url": "/openapi.json#/components/schemas/CompetitorHeatmapCell", "contract": { "properties": { "brand": { "type": "string", "title": "Brand" }, "model": { "type": "string", "title": "Model" }, "visibility": { "type": "number", "title": "Visibility" }, "avg_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Avg Rank" }, "mentions": { "type": "integer", "title": "Mentions", "default": 0 }, "is_you": { "type": "boolean", "title": "Is You", "default": false } }, "type": "object", "required": [ "brand", "model", "visibility" ], "title": "CompetitorHeatmapCell" } }, { "id": "api:schema:CompetitorHeatmapResponse", "surface": "api", "heading": "API response or request schema: CompetitorHeatmapResponse", "route": "/openapi.json", "anchor": "/components/schemas/CompetitorHeatmapResponse", "url": "/openapi.json#/components/schemas/CompetitorHeatmapResponse", "contract": { "properties": { "brands": { "items": { "type": "string" }, "type": "array", "title": "Brands" }, "models": { "items": { "type": "string" }, "type": "array", "title": "Models" }, "your_brand": { "type": "string", "title": "Your Brand" }, "cells": { "items": { "$ref": "#/components/schemas/CompetitorHeatmapCell" }, "type": "array", "title": "Cells" }, "your_best_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Your Best Model" }, "your_worst_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Your Worst Model" } }, "type": "object", "required": [ "brands", "models", "your_brand", "cells" ], "title": "CompetitorHeatmapResponse" } }, { "id": "api:schema:CompetitorLLMCell", "surface": "api", "heading": "API response or request schema: CompetitorLLMCell", "route": "/openapi.json", "anchor": "/components/schemas/CompetitorLLMCell", "url": "/openapi.json#/components/schemas/CompetitorLLMCell", "contract": { "properties": { "brand": { "type": "string", "title": "Brand" }, "llm": { "type": "string", "title": "Llm" }, "visibility": { "type": "number", "title": "Visibility" }, "avg_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Avg Rank" }, "mentions": { "type": "integer", "title": "Mentions" }, "is_you": { "type": "boolean", "title": "Is You", "default": false } }, "type": "object", "required": [ "brand", "llm", "visibility", "mentions" ], "title": "CompetitorLLMCell" } }, { "id": "api:schema:CompetitorLLMInsight", "surface": "api", "heading": "API response or request schema: CompetitorLLMInsight", "route": "/openapi.json", "anchor": "/components/schemas/CompetitorLLMInsight", "url": "/openapi.json#/components/schemas/CompetitorLLMInsight", "contract": { "properties": { "type": { "type": "string", "title": "Type" }, "llm": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Llm" }, "message": { "type": "string", "title": "Message" } }, "type": "object", "required": [ "type", "message" ], "title": "CompetitorLLMInsight" } }, { "id": "api:schema:CompetitorManageResponse", "surface": "api", "heading": "API response or request schema: CompetitorManageResponse", "route": "/openapi.json", "anchor": "/components/schemas/CompetitorManageResponse", "url": "/openapi.json#/components/schemas/CompetitorManageResponse", "contract": { "properties": { "brand_id": { "type": "string", "title": "Brand Id" }, "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action" }, "competitor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Competitor" }, "tracked": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tracked" }, "hidden": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Hidden" }, "already_tracked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Already Tracked" }, "already_hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Already Hidden" } }, "additionalProperties": true, "type": "object", "required": [ "brand_id" ], "title": "CompetitorManageResponse" } }, { "id": "api:schema:CompetitorOpportunityItem", "surface": "api", "heading": "API response or request schema: CompetitorOpportunityItem", "route": "/openapi.json", "anchor": "/components/schemas/CompetitorOpportunityItem", "url": "/openapi.json#/components/schemas/CompetitorOpportunityItem", "contract": { "properties": { "prompt_text": { "type": "string", "title": "Prompt Text" }, "your_rank": { "type": "integer", "title": "Your Rank" }, "gap_to_next": { "type": "number", "title": "Gap To Next" }, "next_competitor": { "type": "string", "title": "Next Competitor" }, "opportunity_score": { "type": "number", "title": "Opportunity Score" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" } }, "type": "object", "required": [ "prompt_text", "your_rank", "gap_to_next", "next_competitor", "opportunity_score" ], "title": "CompetitorOpportunityItem" } }, { "id": "api:schema:CompetitorOverTimeBrand", "surface": "api", "heading": "API response or request schema: CompetitorOverTimeBrand", "route": "/openapi.json", "anchor": "/components/schemas/CompetitorOverTimeBrand", "url": "/openapi.json#/components/schemas/CompetitorOverTimeBrand", "contract": { "properties": { "name": { "type": "string", "title": "Name" }, "is_you": { "type": "boolean", "title": "Is You", "default": false }, "rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rank" }, "visibility": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Visibility" }, "data_points": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Data Points" } }, "type": "object", "required": [ "name", "data_points" ], "title": "CompetitorOverTimeBrand" } }, { "id": "api:schema:CompetitorOverTimeResponse", "surface": "api", "heading": "API response or request schema: CompetitorOverTimeResponse", "route": "/openapi.json", "anchor": "/components/schemas/CompetitorOverTimeResponse", "url": "/openapi.json#/components/schemas/CompetitorOverTimeResponse", "contract": { "properties": { "brands": { "items": { "$ref": "#/components/schemas/CompetitorOverTimeBrand" }, "type": "array", "title": "Brands" }, "period_days": { "type": "integer", "title": "Period Days" }, "date_range": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Date Range" }, "your_brand": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Your Brand" }, "data_through": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Data Through" }, "filters_applied": { "anyOf": [ { "$ref": "#/components/schemas/CompetitorFiltersApplied" }, { "type": "null" } ] } }, "type": "object", "required": [ "brands", "period_days", "date_range" ], "title": "CompetitorOverTimeResponse" } }, { "id": "api:schema:CompetitorPeriodEntry", "surface": "api", "heading": "API response or request schema: CompetitorPeriodEntry", "route": "/openapi.json", "anchor": "/components/schemas/CompetitorPeriodEntry", "url": "/openapi.json#/components/schemas/CompetitorPeriodEntry", "contract": { "properties": { "name": { "type": "string", "title": "Name" }, "rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rank" }, "visibility": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Visibility" }, "is_you": { "type": "boolean", "title": "Is You", "default": false }, "prior_rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Prior Rank" }, "prior_visibility": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Prior Visibility" }, "positions_gained": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Positions Gained" }, "visibility_delta": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Visibility Delta" }, "new_in_list": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "New In List" } }, "type": "object", "required": [ "name" ], "title": "CompetitorPeriodEntry" } }, { "id": "api:schema:CompetitorPeriodResponse", "surface": "api", "heading": "API response or request schema: CompetitorPeriodResponse", "route": "/openapi.json", "anchor": "/components/schemas/CompetitorPeriodResponse", "url": "/openapi.json#/components/schemas/CompetitorPeriodResponse", "contract": { "properties": { "brand": { "additionalProperties": true, "type": "object", "title": "Brand" }, "period": { "$ref": "#/components/schemas/PeriodMeta" }, "prior": { "anyOf": [ { "$ref": "#/components/schemas/PeriodMeta" }, { "type": "null" } ] }, "your_rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Your Rank" }, "rank_pool": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rank Pool" }, "your_visibility": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Your Visibility" }, "your_visibility_avg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Your Visibility Avg" }, "your_rank_by_avg": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Your Rank By Avg" }, "your_visibility_by_avg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Your Visibility By Avg" }, "competitors": { "items": { "$ref": "#/components/schemas/CompetitorPeriodEntry" }, "type": "array", "title": "Competitors", "default": [] }, "competitors_by_avg": { "items": { "$ref": "#/components/schemas/CompetitorPeriodEntry" }, "type": "array", "title": "Competitors By Avg", "default": [] }, "notable_change": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Notable Change" }, "perception_competitors": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Perception Competitors", "default": [] } }, "type": "object", "required": [ "brand", "period" ], "title": "CompetitorPeriodResponse" } }, { "id": "api:schema:CompetitorPosition", "surface": "api", "heading": "API response or request schema: CompetitorPosition", "route": "/openapi.json", "anchor": "/components/schemas/CompetitorPosition", "url": "/openapi.json#/components/schemas/CompetitorPosition", "contract": { "properties": { "name": { "type": "string", "title": "Name" }, "position": { "type": "integer", "title": "Position" } }, "type": "object", "required": [ "name", "position" ], "title": "CompetitorPosition" } }, { "id": "api:schema:CompetitorPromptMatchup", "surface": "api", "heading": "API response or request schema: CompetitorPromptMatchup", "route": "/openapi.json", "anchor": "/components/schemas/CompetitorPromptMatchup", "url": "/openapi.json#/components/schemas/CompetitorPromptMatchup", "contract": { "properties": { "prompt_text": { "type": "string", "title": "Prompt Text" }, "your_rank": { "type": "integer", "title": "Your Rank" }, "rival_rank": { "type": "integer", "title": "Rival Rank" } }, "type": "object", "required": [ "prompt_text", "your_rank", "rival_rank" ], "title": "CompetitorPromptMatchup" } }, { "id": "api:schema:CompetitorThreatItem", "surface": "api", "heading": "API response or request schema: CompetitorThreatItem", "route": "/openapi.json", "anchor": "/components/schemas/CompetitorThreatItem", "url": "/openapi.json#/components/schemas/CompetitorThreatItem", "contract": { "properties": { "competitor": { "type": "string", "title": "Competitor" }, "severity": { "type": "string", "title": "Severity" }, "pressure_score": { "type": "number", "title": "Pressure Score" }, "win_rate_against_you": { "type": "number", "title": "Win Rate Against You" }, "cooccurrence_count": { "type": "integer", "title": "Cooccurrence Count" }, "trend": { "type": "string", "title": "Trend" }, "description": { "type": "string", "title": "Description" } }, "type": "object", "required": [ "competitor", "severity", "pressure_score", "win_rate_against_you", "cooccurrence_count", "trend", "description" ], "title": "CompetitorThreatItem" } }, { "id": "api:schema:CompetitorThreatsResponse", "surface": "api", "heading": "API response or request schema: CompetitorThreatsResponse", "route": "/openapi.json", "anchor": "/components/schemas/CompetitorThreatsResponse", "url": "/openapi.json#/components/schemas/CompetitorThreatsResponse", "contract": { "properties": { "threats": { "items": { "$ref": "#/components/schemas/CompetitorThreatItem" }, "type": "array", "title": "Threats" }, "opportunities": { "items": { "$ref": "#/components/schemas/CompetitorOpportunityItem" }, "type": "array", "title": "Opportunities" }, "alerts": { "items": { "$ref": "#/components/schemas/CompetitorAlertItem" }, "type": "array", "title": "Alerts" }, "summary": { "additionalProperties": true, "type": "object", "title": "Summary" } }, "type": "object", "required": [ "threats", "opportunities", "alerts", "summary" ], "title": "CompetitorThreatsResponse" } }, { "id": "api:schema:ContentArticlesPublicResponse", "surface": "api", "heading": "API response or request schema: ContentArticlesPublicResponse", "route": "/openapi.json", "anchor": "/components/schemas/ContentArticlesPublicResponse", "url": "/openapi.json#/components/schemas/ContentArticlesPublicResponse", "contract": { "properties": { "articles": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Articles" }, "total": { "type": "integer", "title": "Total" }, "limit": { "type": "integer", "title": "Limit" }, "offset": { "type": "integer", "title": "Offset" } }, "type": "object", "required": [ "articles", "total", "limit", "offset" ], "title": "ContentArticlesPublicResponse" } }, { "id": "api:schema:ContentIdeaPublicItem", "surface": "api", "heading": "API response or request schema: ContentIdeaPublicItem", "route": "/openapi.json", "anchor": "/components/schemas/ContentIdeaPublicItem", "url": "/openapi.json#/components/schemas/ContentIdeaPublicItem", "contract": { "properties": { "id": { "type": "string", "title": "Id" }, "type": { "type": "string", "title": "Type" }, "query": { "type": "string", "title": "Query" }, "insight": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Insight" }, "opportunity_score": { "type": "integer", "title": "Opportunity Score", "default": 0 }, "status": { "type": "string", "title": "Status", "default": "active" }, "recommended_template": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Recommended Template" }, "competitors_appearing": { "items": { "type": "string" }, "type": "array", "title": "Competitors Appearing", "default": [] }, "ai_models": { "items": { "type": "string" }, "type": "array", "title": "Ai Models", "default": [] }, "your_position": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Your Position" }, "created_at": { "type": "string", "title": "Created At" }, "potential": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Potential" }, "angle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Angle" }, "why_now": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Why Now" }, "sub_questions": { "items": { "type": "string" }, "type": "array", "title": "Sub Questions", "default": [] }, "proof_points": { "items": { "type": "string" }, "type": "array", "title": "Proof Points", "default": [] }, "competitors_winning": { "items": { "type": "string" }, "type": "array", "title": "Competitors Winning", "default": [] }, "is_quick_win": { "type": "boolean", "title": "Is Quick Win", "default": false } }, "type": "object", "required": [ "id", "type", "query", "created_at" ], "title": "ContentIdeaPublicItem" } }, { "id": "api:schema:ContentIdeasMeta", "surface": "api", "heading": "API response or request schema: ContentIdeasMeta", "route": "/openapi.json", "anchor": "/components/schemas/ContentIdeasMeta", "url": "/openapi.json#/components/schemas/ContentIdeasMeta", "contract": { "properties": { "generated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Generated At" }, "generation_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Generation Status" }, "total_opportunities": { "type": "integer", "title": "Total Opportunities", "default": 0 } }, "type": "object", "title": "ContentIdeasMeta" } }, { "id": "api:schema:ContentIdeasPublicResponse", "surface": "api", "heading": "API response or request schema: ContentIdeasPublicResponse", "route": "/openapi.json", "anchor": "/components/schemas/ContentIdeasPublicResponse", "url": "/openapi.json#/components/schemas/ContentIdeasPublicResponse", "contract": { "properties": { "ideas": { "items": { "$ref": "#/components/schemas/ContentIdeaPublicItem" }, "type": "array", "title": "Ideas" }, "pagination": { "$ref": "#/components/schemas/PaginationInfo" }, "meta": { "$ref": "#/components/schemas/ContentIdeasMeta" } }, "type": "object", "required": [ "ideas", "pagination", "meta" ], "title": "ContentIdeasPublicResponse" } }, { "id": "api:schema:ContentIdeasRefreshRequest", "surface": "api", "heading": "API response or request schema: ContentIdeasRefreshRequest", "route": "/openapi.json", "anchor": "/components/schemas/ContentIdeasRefreshRequest", "url": "/openapi.json#/components/schemas/ContentIdeasRefreshRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "action": { "type": "string", "const": "refresh", "title": "Action", "default": "refresh" } }, "type": "object", "required": [ "brand_id" ], "title": "ContentIdeasRefreshRequest" } }, { "id": "api:schema:ContentIdeasRefreshResponse", "surface": "api", "heading": "API response or request schema: ContentIdeasRefreshResponse", "route": "/openapi.json", "anchor": "/components/schemas/ContentIdeasRefreshResponse", "url": "/openapi.json#/components/schemas/ContentIdeasRefreshResponse", "contract": { "properties": { "status": { "type": "string", "title": "Status" }, "message": { "type": "string", "title": "Message" }, "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Count" } }, "type": "object", "required": [ "status", "message" ], "title": "ContentIdeasRefreshResponse" } }, { "id": "api:schema:ContentKnowledgePublicResponse", "surface": "api", "heading": "API response or request schema: ContentKnowledgePublicResponse", "route": "/openapi.json", "anchor": "/components/schemas/ContentKnowledgePublicResponse", "url": "/openapi.json#/components/schemas/ContentKnowledgePublicResponse", "contract": { "properties": { "sources": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Sources" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total" } }, "additionalProperties": true, "type": "object", "title": "ContentKnowledgePublicResponse" } }, { "id": "api:schema:ContentMutationPublicResponse", "surface": "api", "heading": "API response or request schema: ContentMutationPublicResponse", "route": "/openapi.json", "anchor": "/components/schemas/ContentMutationPublicResponse", "url": "/openapi.json#/components/schemas/ContentMutationPublicResponse", "contract": { "properties": { "success": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Success" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "brand_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Brand Id" } }, "additionalProperties": true, "type": "object", "title": "ContentMutationPublicResponse" } }, { "id": "api:schema:ContentWritingStylePublicResponse", "surface": "api", "heading": "API response or request schema: ContentWritingStylePublicResponse", "route": "/openapi.json", "anchor": "/components/schemas/ContentWritingStylePublicResponse", "url": "/openapi.json#/components/schemas/ContentWritingStylePublicResponse", "contract": { "properties": { "brand_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Brand Id" }, "style_json": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Style Json" }, "samples": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Samples" }, "sample_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sample Count" }, "analysis_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Analysis Status" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total" } }, "additionalProperties": true, "type": "object", "title": "ContentWritingStylePublicResponse" } }, { "id": "api:schema:ConversionValueItem", "surface": "api", "heading": "API response or request schema: ConversionValueItem", "route": "/openapi.json", "anchor": "/components/schemas/ConversionValueItem", "url": "/openapi.json#/components/schemas/ConversionValueItem", "contract": { "properties": { "id": { "type": "string", "title": "Id" }, "brand_id": { "type": "string", "title": "Brand Id" }, "event_name": { "type": "string", "title": "Event Name" }, "value_per_conversion": { "type": "number", "title": "Value Per Conversion" }, "created_at": { "type": "string", "title": "Created At" }, "updated_at": { "type": "string", "title": "Updated At" } }, "type": "object", "required": [ "id", "brand_id", "event_name", "value_per_conversion", "created_at", "updated_at" ], "title": "ConversionValueItem" } }, { "id": "api:schema:ConversionValuesResponse", "surface": "api", "heading": "API response or request schema: ConversionValuesResponse", "route": "/openapi.json", "anchor": "/components/schemas/ConversionValuesResponse", "url": "/openapi.json#/components/schemas/ConversionValuesResponse", "contract": { "properties": { "conversions": { "items": { "$ref": "#/components/schemas/ConversionValueItem" }, "type": "array", "title": "Conversions" } }, "type": "object", "required": [ "conversions" ], "title": "ConversionValuesResponse" } }, { "id": "api:schema:CrawlerAccessPreviewFixRequest", "surface": "api", "heading": "API response or request schema: CrawlerAccessPreviewFixRequest", "route": "/openapi.json", "anchor": "/components/schemas/CrawlerAccessPreviewFixRequest", "url": "/openapi.json#/components/schemas/CrawlerAccessPreviewFixRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "finding_id": { "type": "string", "title": "Finding Id" }, "range_preset": { "type": "string", "enum": [ "24h", "7d", "30d", "90d", "custom" ], "title": "Range Preset", "default": "30d" }, "start_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start Date" }, "end_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Date" } }, "type": "object", "required": [ "brand_id", "finding_id" ], "title": "CrawlerAccessPreviewFixRequest" } }, { "id": "api:schema:CrawlerDashboardResponse", "surface": "api", "heading": "API response or request schema: CrawlerDashboardResponse", "route": "/openapi.json", "anchor": "/components/schemas/CrawlerDashboardResponse", "url": "/openapi.json#/components/schemas/CrawlerDashboardResponse", "contract": { "properties": { "summary": { "$ref": "#/components/schemas/CrawlerSummaryItem" }, "distribution": { "items": { "$ref": "#/components/schemas/CrawlerDistributionItem" }, "type": "array", "title": "Distribution" }, "time_series": { "items": { "$ref": "#/components/schemas/CrawlerTimeSeriesItem" }, "type": "array", "title": "Time Series" }, "top_pages": { "items": { "$ref": "#/components/schemas/CrawlerTopPageItem" }, "type": "array", "title": "Top Pages" }, "recent_activity": { "items": { "$ref": "#/components/schemas/CrawlerVisitItem" }, "type": "array", "title": "Recent Activity" }, "date_range": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Date Range" } }, "type": "object", "required": [ "summary", "distribution", "time_series", "top_pages", "recent_activity", "date_range" ], "title": "CrawlerDashboardResponse" } }, { "id": "api:schema:CrawlerDetailResponse", "surface": "api", "heading": "API response or request schema: CrawlerDetailResponse", "route": "/openapi.json", "anchor": "/components/schemas/CrawlerDetailResponse", "url": "/openapi.json#/components/schemas/CrawlerDetailResponse", "contract": { "properties": { "brand_id": { "type": "string", "title": "Brand Id" }, "range": { "$ref": "#/components/schemas/CrawlerRangeMeta" }, "kind": { "type": "string", "title": "Kind" }, "entity": { "additionalProperties": true, "type": "object", "title": "Entity" }, "sections": { "additionalProperties": true, "type": "object", "title": "Sections" } }, "type": "object", "required": [ "brand_id", "range", "kind", "entity", "sections" ], "title": "CrawlerDetailResponse" } }, { "id": "api:schema:CrawlerDistributionItem", "surface": "api", "heading": "API response or request schema: CrawlerDistributionItem", "route": "/openapi.json", "anchor": "/components/schemas/CrawlerDistributionItem", "url": "/openapi.json#/components/schemas/CrawlerDistributionItem", "contract": { "properties": { "crawler": { "type": "string", "title": "Crawler" }, "count": { "type": "integer", "title": "Count" }, "percentage": { "type": "number", "title": "Percentage" } }, "type": "object", "required": [ "crawler", "count", "percentage" ], "title": "CrawlerDistributionItem" } }, { "id": "api:schema:CrawlerListMeta", "surface": "api", "heading": "API response or request schema: CrawlerListMeta", "route": "/openapi.json", "anchor": "/components/schemas/CrawlerListMeta", "url": "/openapi.json#/components/schemas/CrawlerListMeta", "contract": { "properties": { "total": { "type": "integer", "title": "Total" }, "limit": { "type": "integer", "title": "Limit" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "type": "object", "required": [ "total", "limit" ], "title": "CrawlerListMeta" } }, { "id": "api:schema:CrawlerLiveResponse", "surface": "api", "heading": "API response or request schema: CrawlerLiveResponse", "route": "/openapi.json", "anchor": "/components/schemas/CrawlerLiveResponse", "url": "/openapi.json#/components/schemas/CrawlerLiveResponse", "contract": { "properties": { "brand_id": { "type": "string", "title": "Brand Id" }, "range": { "$ref": "#/components/schemas/CrawlerRangeMeta" }, "view": { "type": "string", "title": "View" }, "filters": { "additionalProperties": true, "type": "object", "title": "Filters" }, "items": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Items" }, "pagination": { "$ref": "#/components/schemas/CrawlerListMeta" } }, "type": "object", "required": [ "brand_id", "range", "view", "filters", "items", "pagination" ], "title": "CrawlerLiveResponse" } }, { "id": "api:schema:CrawlerOverviewResponse", "surface": "api", "heading": "API response or request schema: CrawlerOverviewResponse", "route": "/openapi.json", "anchor": "/components/schemas/CrawlerOverviewResponse", "url": "/openapi.json#/components/schemas/CrawlerOverviewResponse", "contract": { "properties": { "brand_id": { "type": "string", "title": "Brand Id" }, "range": { "$ref": "#/components/schemas/CrawlerRangeMeta" }, "state": { "additionalProperties": true, "type": "object", "title": "State" }, "hero": { "additionalProperties": true, "type": "object", "title": "Hero" }, "chart": { "additionalProperties": true, "type": "object", "title": "Chart" }, "breakdown": { "additionalProperties": true, "type": "object", "title": "Breakdown" }, "top_pages": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Top Pages" }, "recent_preview": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Recent Preview" }, "sessions_preview": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Sessions Preview", "default": [] }, "compare": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Compare" }, "connections": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Connections" } }, "type": "object", "required": [ "brand_id", "range", "state", "hero", "chart", "breakdown", "top_pages", "recent_preview" ], "title": "CrawlerOverviewResponse" } }, { "id": "api:schema:CrawlerPagesResponse", "surface": "api", "heading": "API response or request schema: CrawlerPagesResponse", "route": "/openapi.json", "anchor": "/components/schemas/CrawlerPagesResponse", "url": "/openapi.json#/components/schemas/CrawlerPagesResponse", "contract": { "properties": { "brand_id": { "type": "string", "title": "Brand Id" }, "range": { "$ref": "#/components/schemas/CrawlerRangeMeta" }, "lens": { "type": "string", "title": "Lens" }, "filters": { "additionalProperties": true, "type": "object", "title": "Filters" }, "items": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Items" }, "pagination": { "$ref": "#/components/schemas/CrawlerListMeta" } }, "type": "object", "required": [ "brand_id", "range", "lens", "filters", "items", "pagination" ], "title": "CrawlerPagesResponse" } }, { "id": "api:schema:CrawlerRangeMeta", "surface": "api", "heading": "API response or request schema: CrawlerRangeMeta", "route": "/openapi.json", "anchor": "/components/schemas/CrawlerRangeMeta", "url": "/openapi.json#/components/schemas/CrawlerRangeMeta", "contract": { "properties": { "range_preset": { "type": "string", "title": "Range Preset" }, "start": { "type": "string", "title": "Start" }, "end": { "type": "string", "title": "End" }, "days": { "type": "integer", "title": "Days" }, "compare_to": { "type": "string", "title": "Compare To", "default": "none" } }, "type": "object", "required": [ "range_preset", "start", "end", "days" ], "title": "CrawlerRangeMeta" } }, { "id": "api:schema:CrawlerRecentResponse", "surface": "api", "heading": "API response or request schema: CrawlerRecentResponse", "route": "/openapi.json", "anchor": "/components/schemas/CrawlerRecentResponse", "url": "/openapi.json#/components/schemas/CrawlerRecentResponse", "contract": { "properties": { "visits": { "items": { "$ref": "#/components/schemas/CrawlerVisitItem" }, "type": "array", "title": "Visits" }, "total": { "type": "integer", "title": "Total" } }, "type": "object", "required": [ "visits", "total" ], "title": "CrawlerRecentResponse" } }, { "id": "api:schema:CrawlerSubmitToSearchRequest", "surface": "api", "heading": "API response or request schema: CrawlerSubmitToSearchRequest", "route": "/openapi.json", "anchor": "/components/schemas/CrawlerSubmitToSearchRequest", "url": "/openapi.json#/components/schemas/CrawlerSubmitToSearchRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "urls": { "items": { "type": "string" }, "type": "array", "title": "Urls" } }, "type": "object", "required": [ "brand_id", "urls" ], "title": "CrawlerSubmitToSearchRequest" } }, { "id": "api:schema:CrawlerSummaryItem", "surface": "api", "heading": "API response or request schema: CrawlerSummaryItem", "route": "/openapi.json", "anchor": "/components/schemas/CrawlerSummaryItem", "url": "/openapi.json#/components/schemas/CrawlerSummaryItem", "contract": { "properties": { "total_visits": { "type": "integer", "title": "Total Visits" }, "total_visits_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Visits Change" }, "unique_pages": { "type": "integer", "title": "Unique Pages" }, "unique_pages_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unique Pages Change" }, "avg_daily_visits": { "type": "number", "title": "Avg Daily Visits" }, "top_crawler": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Top Crawler" } }, "type": "object", "required": [ "total_visits", "unique_pages", "avg_daily_visits" ], "title": "CrawlerSummaryItem" } }, { "id": "api:schema:CrawlerTimeSeriesItem", "surface": "api", "heading": "API response or request schema: CrawlerTimeSeriesItem", "route": "/openapi.json", "anchor": "/components/schemas/CrawlerTimeSeriesItem", "url": "/openapi.json#/components/schemas/CrawlerTimeSeriesItem", "contract": { "properties": { "date": { "type": "string", "title": "Date" }, "count": { "type": "integer", "title": "Count" }, "by_crawler": { "additionalProperties": { "type": "integer" }, "type": "object", "title": "By Crawler", "default": {} } }, "type": "object", "required": [ "date", "count" ], "title": "CrawlerTimeSeriesItem" } }, { "id": "api:schema:CrawlerTopPageItem", "surface": "api", "heading": "API response or request schema: CrawlerTopPageItem", "route": "/openapi.json", "anchor": "/components/schemas/CrawlerTopPageItem", "url": "/openapi.json#/components/schemas/CrawlerTopPageItem", "contract": { "properties": { "url": { "type": "string", "title": "Url" }, "count": { "type": "integer", "title": "Count" }, "crawlers": { "items": { "type": "string" }, "type": "array", "title": "Crawlers", "default": [] } }, "type": "object", "required": [ "url", "count" ], "title": "CrawlerTopPageItem" } }, { "id": "api:schema:CrawlerVisitItem", "surface": "api", "heading": "API response or request schema: CrawlerVisitItem", "route": "/openapi.json", "anchor": "/components/schemas/CrawlerVisitItem", "url": "/openapi.json#/components/schemas/CrawlerVisitItem", "contract": { "properties": { "id": { "type": "string", "title": "Id" }, "url": { "type": "string", "title": "Url" }, "pathname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pathname" }, "crawler": { "type": "string", "title": "Crawler" }, "visited_at": { "type": "string", "title": "Visited At" } }, "type": "object", "required": [ "id", "url", "crawler", "visited_at" ], "title": "CrawlerVisitItem" } }, { "id": "api:schema:CreatePromptRequest", "surface": "api", "heading": "API response or request schema: CreatePromptRequest", "route": "/openapi.json", "anchor": "/components/schemas/CreatePromptRequest", "url": "/openapi.json#/components/schemas/CreatePromptRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "text": { "type": "string", "title": "Text" }, "active": { "type": "boolean", "title": "Active", "default": true }, "focus_area": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Focus Area" }, "intent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Intent" }, "audience": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Audience" } }, "type": "object", "required": [ "brand_id", "text" ], "title": "CreatePromptRequest" } }, { "id": "api:schema:DiagnoseCompetitorApi", "surface": "api", "heading": "API response or request schema: DiagnoseCompetitorApi", "route": "/openapi.json", "anchor": "/components/schemas/DiagnoseCompetitorApi", "url": "/openapi.json#/components/schemas/DiagnoseCompetitorApi", "contract": { "properties": { "name": { "type": "string", "title": "Name" }, "positions": { "additionalProperties": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "type": "object", "title": "Positions", "default": {} }, "score": { "type": "number", "title": "Score", "default": 0 } }, "type": "object", "required": [ "name" ], "title": "DiagnoseCompetitorApi" } }, { "id": "api:schema:DiagnoseHistoryApiResponse", "surface": "api", "heading": "API response or request schema: DiagnoseHistoryApiResponse", "route": "/openapi.json", "anchor": "/components/schemas/DiagnoseHistoryApiResponse", "url": "/openapi.json#/components/schemas/DiagnoseHistoryApiResponse", "contract": { "properties": { "diagnoses": { "items": { "$ref": "#/components/schemas/DiagnoseSummaryApi" }, "type": "array", "title": "Diagnoses" } }, "type": "object", "required": [ "diagnoses" ], "title": "DiagnoseHistoryApiResponse" } }, { "id": "api:schema:DiagnoseHypothesisFactorApi", "surface": "api", "heading": "API response or request schema: DiagnoseHypothesisFactorApi", "route": "/openapi.json", "anchor": "/components/schemas/DiagnoseHypothesisFactorApi", "url": "/openapi.json#/components/schemas/DiagnoseHypothesisFactorApi", "contract": { "properties": { "factor": { "type": "string", "title": "Factor" }, "mentioned_by": { "items": { "type": "string" }, "type": "array", "title": "Mentioned By", "default": [] }, "count": { "type": "integer", "title": "Count", "default": 0 }, "type": { "type": "string", "title": "Type", "default": "" }, "validation_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Validation Status" } }, "type": "object", "required": [ "factor" ], "title": "DiagnoseHypothesisFactorApi" } }, { "id": "api:schema:DiagnoseRecommendationApi", "surface": "api", "heading": "API response or request schema: DiagnoseRecommendationApi", "route": "/openapi.json", "anchor": "/components/schemas/DiagnoseRecommendationApi", "url": "/openapi.json#/components/schemas/DiagnoseRecommendationApi", "contract": { "properties": { "id": { "type": "string", "title": "Id" }, "title": { "type": "string", "title": "Title" }, "gap": { "type": "string", "title": "Gap" }, "effort": { "type": "string", "title": "Effort" }, "impact": { "type": "string", "title": "Impact" }, "validation_status": { "type": "string", "title": "Validation Status" }, "confidence": { "type": "string", "title": "Confidence" }, "mentioned_by_models": { "type": "integer", "title": "Mentioned By Models", "default": 0 } }, "type": "object", "required": [ "id", "title", "gap", "effort", "impact", "validation_status", "confidence" ], "title": "DiagnoseRecommendationApi" } }, { "id": "api:schema:DiagnoseResultApiResponse", "surface": "api", "heading": "API response or request schema: DiagnoseResultApiResponse", "route": "/openapi.json", "anchor": "/components/schemas/DiagnoseResultApiResponse", "url": "/openapi.json#/components/schemas/DiagnoseResultApiResponse", "contract": { "properties": { "id": { "type": "string", "title": "Id" }, "brand_id": { "type": "string", "title": "Brand Id" }, "query": { "type": "string", "title": "Query" }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location" }, "market_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Market Id" }, "market_scope": { "type": "string", "enum": [ "exact", "global", "legacy" ], "title": "Market Scope", "default": "legacy" }, "status": { "type": "string", "title": "Status" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "visibility_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Visibility Score" }, "best_position": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Best Position" }, "model_positions": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "type": "object" }, { "type": "null" } ], "title": "Model Positions" }, "competitors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/DiagnoseCompetitorApi" }, "type": "array" }, { "type": "null" } ], "title": "Competitors" }, "model_consistency_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Model Consistency Score" }, "hypothesis_factors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/DiagnoseHypothesisFactorApi" }, "type": "array" }, { "type": "null" } ], "title": "Hypothesis Factors" }, "confidence_score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Confidence Score" }, "confidence_level": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Confidence Level" }, "recommendations": { "anyOf": [ { "items": { "$ref": "#/components/schemas/DiagnoseRecommendationApi" }, "type": "array" }, { "type": "null" } ], "title": "Recommendations" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Summary" }, "synthesis_summary": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Synthesis Summary" }, "variant_analysis": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Variant Analysis" }, "phrasing_insight": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": "object" }, { "type": "null" } ], "title": "Phrasing Insight" }, "visibility_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Visibility Change" }, "created_at": { "type": "string", "title": "Created At" }, "completed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "duration_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Duration Ms" }, "credits_used": { "type": "integer", "title": "Credits Used", "default": 4 }, "models_queried": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Models Queried" }, "models_succeeded": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Models Succeeded" }, "models_failed": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Models Failed" } }, "type": "object", "required": [ "id", "brand_id", "query", "status", "created_at" ], "title": "DiagnoseResultApiResponse" } }, { "id": "api:schema:DiagnoseRunApiRequest", "surface": "api", "heading": "API response or request schema: DiagnoseRunApiRequest", "route": "/openapi.json", "anchor": "/components/schemas/DiagnoseRunApiRequest", "url": "/openapi.json#/components/schemas/DiagnoseRunApiRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "query": { "type": "string", "maxLength": 500, "minLength": 3, "title": "Query" }, "market_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Market Id" }, "idempotency_key": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 8 }, { "type": "null" } ], "title": "Idempotency Key" } }, "type": "object", "required": [ "brand_id", "query" ], "title": "DiagnoseRunApiRequest" } }, { "id": "api:schema:DiagnoseRunApiResponse", "surface": "api", "heading": "API response or request schema: DiagnoseRunApiResponse", "route": "/openapi.json", "anchor": "/components/schemas/DiagnoseRunApiResponse", "url": "/openapi.json#/components/schemas/DiagnoseRunApiResponse", "contract": { "properties": { "diagnosis_id": { "type": "string", "title": "Diagnosis Id" }, "status": { "type": "string", "title": "Status", "default": "pending" }, "message": { "type": "string", "title": "Message", "default": "Diagnosis started" }, "outcome": { "type": "string", "enum": [ "admitted", "existing" ], "title": "Outcome", "default": "admitted" }, "market_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Market Id" }, "market_scope": { "type": "string", "enum": [ "exact", "global" ], "title": "Market Scope", "default": "global" } }, "type": "object", "required": [ "diagnosis_id" ], "title": "DiagnoseRunApiResponse" } }, { "id": "api:schema:DiagnoseSummaryApi", "surface": "api", "heading": "API response or request schema: DiagnoseSummaryApi", "route": "/openapi.json", "anchor": "/components/schemas/DiagnoseSummaryApi", "url": "/openapi.json#/components/schemas/DiagnoseSummaryApi", "contract": { "properties": { "id": { "type": "string", "title": "Id" }, "query": { "type": "string", "title": "Query" }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location" }, "market_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Market Id" }, "market_scope": { "type": "string", "enum": [ "exact", "global", "legacy" ], "title": "Market Scope", "default": "legacy" }, "visibility_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Visibility Score" }, "best_position": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Best Position" }, "status": { "type": "string", "title": "Status" }, "created_at": { "type": "string", "title": "Created At" }, "visibility_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Visibility Change" } }, "type": "object", "required": [ "id", "query", "status", "created_at" ], "title": "DiagnoseSummaryApi" } }, { "id": "api:schema:DiagnoseUsageApiResponse", "surface": "api", "heading": "API response or request schema: DiagnoseUsageApiResponse", "route": "/openapi.json", "anchor": "/components/schemas/DiagnoseUsageApiResponse", "url": "/openapi.json#/components/schemas/DiagnoseUsageApiResponse", "contract": { "properties": { "used": { "type": "integer", "title": "Used" }, "limit": { "type": "integer", "title": "Limit" }, "remaining": { "type": "integer", "title": "Remaining" } }, "type": "object", "required": [ "used", "limit", "remaining" ], "title": "DiagnoseUsageApiResponse" } }, { "id": "api:schema:DiscoverPublishersRequest", "surface": "api", "heading": "API response or request schema: DiscoverPublishersRequest", "route": "/openapi.json", "anchor": "/components/schemas/DiscoverPublishersRequest", "url": "/openapi.json#/components/schemas/DiscoverPublishersRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "topic": { "anyOf": [ { "type": "string", "maxLength": 400 }, { "type": "null" } ], "title": "Topic" }, "prompt_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "maxItems": 20, "title": "Prompt Ids" }, "seed_domain": { "anyOf": [ { "type": "string", "maxLength": 253 }, { "type": "null" } ], "title": "Seed Domain" }, "market": { "anyOf": [ { "type": "string", "maxLength": 80 }, { "type": "null" } ], "title": "Market" }, "language": { "anyOf": [ { "type": "string", "maxLength": 80 }, { "type": "null" } ], "title": "Language" }, "new_only": { "type": "boolean", "title": "New Only", "default": true } }, "type": "object", "required": [ "brand_id" ], "title": "DiscoverPublishersRequest" } }, { "id": "api:schema:ExportResponse", "surface": "api", "heading": "API response or request schema: ExportResponse", "route": "/openapi.json", "anchor": "/components/schemas/ExportResponse", "url": "/openapi.json#/components/schemas/ExportResponse", "contract": { "properties": { "data_type": { "type": "string", "title": "Data Type" }, "count": { "type": "integer", "title": "Count" }, "data": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Data" }, "exported_at": { "type": "string", "title": "Exported At" } }, "type": "object", "required": [ "data_type", "count", "data", "exported_at" ], "title": "ExportResponse" } }, { "id": "api:schema:GenerateReportPublicRequest", "surface": "api", "heading": "API response or request schema: GenerateReportPublicRequest", "route": "/openapi.json", "anchor": "/components/schemas/GenerateReportPublicRequest", "url": "/openapi.json#/components/schemas/GenerateReportPublicRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "report_type": { "type": "string", "enum": [ "executive", "weekly", "full" ], "title": "Report Type", "default": "executive" }, "time_range": { "type": "string", "enum": [ "7d", "14d", "30d" ], "title": "Time Range", "default": "7d" } }, "type": "object", "required": [ "brand_id" ], "title": "GenerateReportPublicRequest" } }, { "id": "api:schema:GenerateReportPublicResponse", "surface": "api", "heading": "API response or request schema: GenerateReportPublicResponse", "route": "/openapi.json", "anchor": "/components/schemas/GenerateReportPublicResponse", "url": "/openapi.json#/components/schemas/GenerateReportPublicResponse", "contract": { "properties": { "report_id": { "type": "string", "title": "Report Id" }, "status": { "type": "string", "title": "Status" }, "download_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Download Url" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" } }, "type": "object", "required": [ "report_id", "status" ], "title": "GenerateReportPublicResponse" } }, { "id": "api:schema:HTTPValidationError", "surface": "api", "heading": "API response or request schema: HTTPValidationError", "route": "/openapi.json", "anchor": "/components/schemas/HTTPValidationError", "url": "/openapi.json#/components/schemas/HTTPValidationError", "contract": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" } }, { "id": "api:schema:HistoricalPoint", "surface": "api", "heading": "API response or request schema: HistoricalPoint", "route": "/openapi.json", "anchor": "/components/schemas/HistoricalPoint", "url": "/openapi.json#/components/schemas/HistoricalPoint", "contract": { "properties": { "date": { "type": "string", "title": "Date" }, "visibility": { "type": "number", "title": "Visibility" }, "presence": { "type": "number", "title": "Presence" }, "average_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Rank" }, "mentions": { "type": "integer", "title": "Mentions", "default": 0 } }, "type": "object", "required": [ "date", "visibility", "presence" ], "title": "HistoricalPoint" } }, { "id": "api:schema:LatestScores", "surface": "api", "heading": "API response or request schema: LatestScores", "route": "/openapi.json", "anchor": "/components/schemas/LatestScores", "url": "/openapi.json#/components/schemas/LatestScores", "contract": { "properties": { "visibility": { "type": "number", "title": "Visibility" }, "presence": { "type": "number", "title": "Presence" }, "average_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Rank" }, "mentions": { "type": "integer", "title": "Mentions", "default": 0 }, "models_mentioned": { "type": "integer", "title": "Models Mentioned", "default": 0 }, "model_scores": { "additionalProperties": { "$ref": "#/components/schemas/ModelScore" }, "type": "object", "title": "Model Scores", "default": {} }, "date": { "type": "string", "title": "Date" } }, "type": "object", "required": [ "visibility", "presence", "date" ], "title": "LatestScores" } }, { "id": "api:schema:ManageActionRequest", "surface": "api", "heading": "API response or request schema: ManageActionRequest", "route": "/openapi.json", "anchor": "/components/schemas/ManageActionRequest", "url": "/openapi.json#/components/schemas/ManageActionRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "action_id": { "type": "string", "format": "uuid", "title": "Action Id" }, "action": { "type": "string", "title": "Action" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note" }, "snooze_until": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Snooze Until" }, "assignee": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assignee" } }, "type": "object", "required": [ "brand_id", "action_id", "action" ], "title": "ManageActionRequest" } }, { "id": "api:schema:ManageActionResponse", "surface": "api", "heading": "API response or request schema: ManageActionResponse", "route": "/openapi.json", "anchor": "/components/schemas/ManageActionResponse", "url": "/openapi.json#/components/schemas/ManageActionResponse", "contract": { "properties": { "ok": { "type": "boolean", "title": "Ok" }, "action": { "anyOf": [ { "$ref": "#/components/schemas/ActionPublicItem" }, { "type": "null" } ] }, "note_added": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Note Added" } }, "type": "object", "required": [ "ok" ], "title": "ManageActionResponse" } }, { "id": "api:schema:ManageBrandRequest", "surface": "api", "heading": "API response or request schema: ManageBrandRequest", "route": "/openapi.json", "anchor": "/components/schemas/ManageBrandRequest", "url": "/openapi.json#/components/schemas/ManageBrandRequest", "contract": { "properties": { "action": { "type": "string", "enum": [ "create", "pause", "resume", "delete", "restore" ], "title": "Action" }, "brand_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Brand Id" }, "domain": { "anyOf": [ { "type": "string", "maxLength": 253 }, { "type": "null" } ], "title": "Domain" }, "name": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ], "title": "Description" }, "industry": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Industry" }, "target_audience": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Target Audience" }, "location": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Location" }, "language": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "title": "Language" }, "timezone": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Timezone" }, "prompts": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 200 }, { "type": "null" } ], "title": "Prompts" }, "competitors": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 50 }, { "type": "null" } ], "title": "Competitors" }, "allow_duplicate_domain": { "type": "boolean", "title": "Allow Duplicate Domain", "default": false } }, "type": "object", "required": [ "action" ], "title": "ManageBrandRequest" } }, { "id": "api:schema:ManageBrandResponse", "surface": "api", "heading": "API response or request schema: ManageBrandResponse", "route": "/openapi.json", "anchor": "/components/schemas/ManageBrandResponse", "url": "/openapi.json#/components/schemas/ManageBrandResponse", "contract": { "properties": { "action": { "type": "string", "title": "Action" }, "success": { "type": "boolean", "title": "Success", "default": true }, "brand_id": { "type": "string", "title": "Brand Id" }, "active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Active" }, "created": { "type": "boolean", "title": "Created", "default": false }, "restored": { "type": "boolean", "title": "Restored", "default": false }, "already_existed": { "type": "boolean", "title": "Already Existed", "default": false }, "prompts_created": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Prompts Created" }, "prompts_generated": { "type": "boolean", "title": "Prompts Generated", "default": false }, "report_triggered": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Report Triggered" }, "creation_allowance": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Creation Allowance" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" } }, "type": "object", "required": [ "action", "brand_id" ], "title": "ManageBrandResponse" } }, { "id": "api:schema:ManageClientRequest", "surface": "api", "heading": "API response or request schema: ManageClientRequest", "route": "/openapi.json", "anchor": "/components/schemas/ManageClientRequest", "url": "/openapi.json#/components/schemas/ManageClientRequest", "contract": { "properties": { "action": { "type": "string", "enum": [ "list", "invite", "revoke", "restore", "resend", "update" ], "title": "Action" }, "brand_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Brand Id" }, "client_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Client Id" }, "email": { "anyOf": [ { "type": "string", "maxLength": 254 }, { "type": "null" } ], "title": "Email" }, "client_name": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ], "title": "Client Name" }, "personal_message": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ], "title": "Personal Message" }, "send_email": { "type": "boolean", "title": "Send Email", "default": true }, "expires_days": { "type": "integer", "maximum": 30.0, "minimum": 7.0, "title": "Expires Days", "default": 14 }, "can_export": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Can Export" }, "receives_weekly_reports": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Receives Weekly Reports" }, "status": { "anyOf": [ { "type": "string", "enum": [ "pending", "active", "revoked" ] }, { "type": "null" } ], "title": "Status" }, "reason": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Reason" } }, "type": "object", "required": [ "action" ], "title": "ManageClientRequest" } }, { "id": "api:schema:ManageClientResponse", "surface": "api", "heading": "API response or request schema: ManageClientResponse", "route": "/openapi.json", "anchor": "/components/schemas/ManageClientResponse", "url": "/openapi.json#/components/schemas/ManageClientResponse", "contract": { "properties": { "action": { "type": "string", "title": "Action" }, "success": { "type": "boolean", "title": "Success", "default": true }, "client": { "anyOf": [ { "$ref": "#/components/schemas/PublicPortalClient" }, { "type": "null" } ] }, "clients": { "anyOf": [ { "items": { "$ref": "#/components/schemas/PublicPortalClient" }, "type": "array" }, { "type": "null" } ], "title": "Clients" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total" }, "already_revoked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Already Revoked" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" } }, "type": "object", "required": [ "action" ], "title": "ManageClientResponse" } }, { "id": "api:schema:ManageCompetitorRequest", "surface": "api", "heading": "API response or request schema: ManageCompetitorRequest", "route": "/openapi.json", "anchor": "/components/schemas/ManageCompetitorRequest", "url": "/openapi.json#/components/schemas/ManageCompetitorRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "action": { "type": "string", "enum": [ "list", "add", "remove", "hide", "unhide" ], "title": "Action" }, "competitor": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Competitor" } }, "type": "object", "required": [ "brand_id", "action" ], "title": "ManageCompetitorRequest" } }, { "id": "api:schema:ManagePromptTagsRequest", "surface": "api", "heading": "API response or request schema: ManagePromptTagsRequest", "route": "/openapi.json", "anchor": "/components/schemas/ManagePromptTagsRequest", "url": "/openapi.json#/components/schemas/ManagePromptTagsRequest", "contract": { "properties": { "action": { "type": "string", "enum": [ "create", "update", "delete", "add", "remove" ], "title": "Action" }, "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "tag_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Tag Id" }, "tag_name": { "anyOf": [ { "type": "string", "maxLength": 60 }, { "type": "null" } ], "title": "Tag Name" }, "colour": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Colour" }, "prompt_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "maxItems": 200, "title": "Prompt Ids" }, "create_if_missing": { "type": "boolean", "title": "Create If Missing", "default": true } }, "type": "object", "required": [ "action", "brand_id" ], "title": "ManagePromptTagsRequest" } }, { "id": "api:schema:ManagePromptTagsResponse", "surface": "api", "heading": "API response or request schema: ManagePromptTagsResponse", "route": "/openapi.json", "anchor": "/components/schemas/ManagePromptTagsResponse", "url": "/openapi.json#/components/schemas/ManagePromptTagsResponse", "contract": { "properties": { "success": { "type": "boolean", "title": "Success" }, "action": { "type": "string", "title": "Action" }, "tag": { "$ref": "#/components/schemas/TagItem" }, "created": { "type": "boolean", "title": "Created", "default": false }, "affected_prompt_ids": { "items": { "type": "string" }, "type": "array", "title": "Affected Prompt Ids" }, "affected_count": { "type": "integer", "title": "Affected Count", "default": 0 }, "unchanged_count": { "type": "integer", "title": "Unchanged Count", "default": 0 } }, "type": "object", "required": [ "success", "action", "tag" ], "title": "ManagePromptTagsResponse" } }, { "id": "api:schema:ManagePublisherShortlistRequest", "surface": "api", "heading": "API response or request schema: ManagePublisherShortlistRequest", "route": "/openapi.json", "anchor": "/components/schemas/ManagePublisherShortlistRequest", "url": "/openapi.json#/components/schemas/ManagePublisherShortlistRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "action": { "type": "string", "enum": [ "list", "add", "remove" ], "title": "Action" }, "domain": { "anyOf": [ { "type": "string", "maxLength": 253 }, { "type": "null" } ], "title": "Domain" }, "research_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Research Id" }, "article_idea": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ], "title": "Article Idea" }, "rationale": { "anyOf": [ { "type": "string", "maxLength": 1600 }, { "type": "null" } ], "title": "Rationale" }, "proposed_route": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ], "title": "Proposed Route" } }, "type": "object", "required": [ "brand_id", "action" ], "title": "ManagePublisherShortlistRequest" } }, { "id": "api:schema:ManageTrackedArticleRequest", "surface": "api", "heading": "API response or request schema: ManageTrackedArticleRequest", "route": "/openapi.json", "anchor": "/components/schemas/ManageTrackedArticleRequest", "url": "/openapi.json#/components/schemas/ManageTrackedArticleRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "action": { "type": "string", "enum": [ "track", "stop", "restore" ], "title": "Action" }, "url": { "anyOf": [ { "type": "string", "maxLength": 2048, "minLength": 8 }, { "type": "null" } ], "title": "Url" }, "article_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Article Id" }, "title": { "anyOf": [ { "type": "string", "maxLength": 300 }, { "type": "null" } ], "title": "Title" }, "prompt_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "maxItems": 20, "title": "Prompt Ids" }, "published_on": { "anyOf": [ { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, { "type": "null" } ], "title": "Published On" } }, "type": "object", "required": [ "brand_id", "action" ], "title": "ManageTrackedArticleRequest" } }, { "id": "api:schema:MarketItem", "surface": "api", "heading": "API response or request schema: MarketItem", "route": "/openapi.json", "anchor": "/components/schemas/MarketItem", "url": "/openapi.json#/components/schemas/MarketItem", "contract": { "properties": { "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" }, "id": { "type": "string", "title": "Id" }, "brand_id": { "type": "string", "title": "Brand Id" }, "location": { "type": "string", "title": "Location" }, "location_region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location Region" }, "location_city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location City" }, "is_primary": { "type": "boolean", "title": "Is Primary" }, "active": { "type": "boolean", "title": "Active" }, "created_at": { "type": "string", "title": "Created At" } }, "type": "object", "required": [ "id", "brand_id", "location", "is_primary", "active", "created_at" ], "title": "MarketItem" } }, { "id": "api:schema:MentionsTimeSeriesPoint", "surface": "api", "heading": "API response or request schema: MentionsTimeSeriesPoint", "route": "/openapi.json", "anchor": "/components/schemas/MentionsTimeSeriesPoint", "url": "/openapi.json#/components/schemas/MentionsTimeSeriesPoint", "contract": { "properties": { "date": { "type": "string", "title": "Date" }, "mentions": { "type": "integer", "title": "Mentions" }, "models_mentioned": { "type": "integer", "title": "Models Mentioned", "default": 0 } }, "type": "object", "required": [ "date", "mentions" ], "title": "MentionsTimeSeriesPoint" } }, { "id": "api:schema:MetricsCatalogueResponse", "surface": "api", "heading": "API response or request schema: MetricsCatalogueResponse", "route": "/openapi.json", "anchor": "/components/schemas/MetricsCatalogueResponse", "url": "/openapi.json#/components/schemas/MetricsCatalogueResponse", "contract": { "properties": { "groups": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Groups" }, "metrics": { "additionalProperties": true, "type": "object", "title": "Metrics" }, "comparison_kinds": { "items": { "type": "string" }, "type": "array", "title": "Comparison Kinds" } }, "type": "object", "required": [ "groups", "metrics", "comparison_kinds" ], "title": "MetricsCatalogueResponse" } }, { "id": "api:schema:ModelPerformance", "surface": "api", "heading": "API response or request schema: ModelPerformance", "route": "/openapi.json", "anchor": "/components/schemas/ModelPerformance", "url": "/openapi.json#/components/schemas/ModelPerformance", "contract": { "properties": { "model": { "type": "string", "title": "Model" }, "total_queries": { "type": "integer", "title": "Total Queries" }, "mentions": { "type": "integer", "title": "Mentions" }, "visibility_rate": { "type": "number", "title": "Visibility Rate" }, "presence": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Presence" }, "average_position": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Position" }, "top_3_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Top 3 Rate" }, "top_3_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Top 3 Count" } }, "type": "object", "required": [ "model", "total_queries", "mentions", "visibility_rate" ], "title": "ModelPerformance" } }, { "id": "api:schema:ModelScore", "surface": "api", "heading": "API response or request schema: ModelScore", "route": "/openapi.json", "anchor": "/components/schemas/ModelScore", "url": "/openapi.json#/components/schemas/ModelScore", "contract": { "properties": { "visibility": { "type": "number", "title": "Visibility" }, "presence": { "type": "number", "title": "Presence" } }, "type": "object", "required": [ "visibility", "presence" ], "title": "ModelScore" } }, { "id": "api:schema:ModelsResponse", "surface": "api", "heading": "API response or request schema: ModelsResponse", "route": "/openapi.json", "anchor": "/components/schemas/ModelsResponse", "url": "/openapi.json#/components/schemas/ModelsResponse", "contract": { "properties": { "period": { "anyOf": [ { "$ref": "#/components/schemas/PeriodMeta" }, { "type": "null" } ] }, "models": { "items": { "$ref": "#/components/schemas/ModelPerformance" }, "type": "array", "title": "Models" }, "summary": { "$ref": "#/components/schemas/ModelsSummary" } }, "type": "object", "required": [ "models", "summary" ], "title": "ModelsResponse" } }, { "id": "api:schema:ModelsSummary", "surface": "api", "heading": "API response or request schema: ModelsSummary", "route": "/openapi.json", "anchor": "/components/schemas/ModelsSummary", "url": "/openapi.json#/components/schemas/ModelsSummary", "contract": { "properties": { "total_results": { "type": "integer", "title": "Total Results" }, "total_mentions": { "type": "integer", "title": "Total Mentions" }, "overall_visibility_rate": { "type": "number", "title": "Overall Visibility Rate" }, "model_count": { "type": "integer", "title": "Model Count" }, "period_days": { "type": "integer", "title": "Period Days" } }, "type": "object", "required": [ "total_results", "total_mentions", "overall_visibility_rate", "model_count", "period_days" ], "title": "ModelsSummary" } }, { "id": "api:schema:NarrativeCorrectiveApi", "surface": "api", "heading": "API response or request schema: NarrativeCorrectiveApi", "route": "/openapi.json", "anchor": "/components/schemas/NarrativeCorrectiveApi", "url": "/openapi.json#/components/schemas/NarrativeCorrectiveApi", "contract": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "key_phrases": { "items": { "type": "string" }, "type": "array", "title": "Key Phrases", "default": [] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" }, "published_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Published At" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" } }, "type": "object", "required": [ "id", "name" ], "title": "NarrativeCorrectiveApi" } }, { "id": "api:schema:NarrativeCreateApiRequest", "surface": "api", "heading": "API response or request schema: NarrativeCreateApiRequest", "route": "/openapi.json", "anchor": "/components/schemas/NarrativeCreateApiRequest", "url": "/openapi.json#/components/schemas/NarrativeCreateApiRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "name": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Name" }, "description": { "type": "string", "maxLength": 2000, "minLength": 1, "title": "Description" }, "keywords": { "items": { "type": "string" }, "type": "array", "maxItems": 10, "minItems": 1, "title": "Keywords" }, "comparison_brand": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Comparison Brand" } }, "type": "object", "required": [ "brand_id", "name", "description", "keywords" ], "title": "NarrativeCreateApiRequest" } }, { "id": "api:schema:NarrativeCreateApiResponse", "surface": "api", "heading": "API response or request schema: NarrativeCreateApiResponse", "route": "/openapi.json", "anchor": "/components/schemas/NarrativeCreateApiResponse", "url": "/openapi.json#/components/schemas/NarrativeCreateApiResponse", "contract": { "properties": { "narrative_id": { "type": "string", "title": "Narrative Id" }, "status": { "type": "string", "title": "Status", "default": "created" }, "message": { "type": "string", "title": "Message", "default": "Narrative created and first analysis started" } }, "type": "object", "required": [ "narrative_id" ], "title": "NarrativeCreateApiResponse" } }, { "id": "api:schema:NarrativeDeleteApiResponse", "surface": "api", "heading": "API response or request schema: NarrativeDeleteApiResponse", "route": "/openapi.json", "anchor": "/components/schemas/NarrativeDeleteApiResponse", "url": "/openapi.json#/components/schemas/NarrativeDeleteApiResponse", "contract": { "properties": { "narrative_id": { "type": "string", "title": "Narrative Id" }, "status": { "type": "string", "title": "Status", "default": "archived" } }, "type": "object", "required": [ "narrative_id" ], "title": "NarrativeDeleteApiResponse" } }, { "id": "api:schema:NarrativeItemApi", "surface": "api", "heading": "API response or request schema: NarrativeItemApi", "route": "/openapi.json", "anchor": "/components/schemas/NarrativeItemApi", "url": "/openapi.json#/components/schemas/NarrativeItemApi", "contract": { "properties": { "id": { "type": "string", "title": "Id" }, "brand_id": { "type": "string", "title": "Brand Id" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "keywords": { "items": { "type": "string" }, "type": "array", "title": "Keywords", "default": [] }, "comparison_brand": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Comparison Brand" }, "status": { "type": "string", "title": "Status" }, "created_at": { "type": "string", "title": "Created At" }, "latest_snapshot": { "anyOf": [ { "$ref": "#/components/schemas/NarrativeSnapshotApi" }, { "type": "null" } ] }, "correctives": { "anyOf": [ { "items": { "$ref": "#/components/schemas/NarrativeCorrectiveApi" }, "type": "array" }, { "type": "null" } ], "title": "Correctives" }, "snapshots": { "anyOf": [ { "items": { "$ref": "#/components/schemas/NarrativeSnapshotApi" }, "type": "array" }, { "type": "null" } ], "title": "Snapshots" } }, "type": "object", "required": [ "id", "brand_id", "name", "description", "status", "created_at" ], "title": "NarrativeItemApi" } }, { "id": "api:schema:NarrativeSnapshotApi", "surface": "api", "heading": "API response or request schema: NarrativeSnapshotApi", "route": "/openapi.json", "anchor": "/components/schemas/NarrativeSnapshotApi", "url": "/openapi.json#/components/schemas/NarrativeSnapshotApi", "contract": { "properties": { "id": { "type": "string", "title": "Id" }, "run_date": { "type": "string", "title": "Run Date" }, "run_type": { "type": "string", "title": "Run Type" }, "overall_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Overall Score" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Summary" }, "comparison_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Comparison Score" }, "themes": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Themes" } }, "type": "object", "required": [ "id", "run_date", "run_type" ], "title": "NarrativeSnapshotApi" } }, { "id": "api:schema:NarrativeUpdateApiRequest", "surface": "api", "heading": "API response or request schema: NarrativeUpdateApiRequest", "route": "/openapi.json", "anchor": "/components/schemas/NarrativeUpdateApiRequest", "url": "/openapi.json#/components/schemas/NarrativeUpdateApiRequest", "contract": { "properties": { "narrative_id": { "type": "string", "title": "Narrative Id" }, "name": { "anyOf": [ { "type": "string", "maxLength": 200, "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string", "maxLength": 2000, "minLength": 1 }, { "type": "null" } ], "title": "Description" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 10, "minItems": 1 }, { "type": "null" } ], "title": "Keywords" }, "comparison_brand": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Comparison Brand" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, "type": "object", "required": [ "narrative_id" ], "title": "NarrativeUpdateApiRequest" } }, { "id": "api:schema:NarrativeUpdateApiResponse", "surface": "api", "heading": "API response or request schema: NarrativeUpdateApiResponse", "route": "/openapi.json", "anchor": "/components/schemas/NarrativeUpdateApiResponse", "url": "/openapi.json#/components/schemas/NarrativeUpdateApiResponse", "contract": { "properties": { "narrative_id": { "type": "string", "title": "Narrative Id" }, "status": { "type": "string", "title": "Status", "default": "updated" } }, "type": "object", "required": [ "narrative_id" ], "title": "NarrativeUpdateApiResponse" } }, { "id": "api:schema:NarrativesListApiResponse", "surface": "api", "heading": "API response or request schema: NarrativesListApiResponse", "route": "/openapi.json", "anchor": "/components/schemas/NarrativesListApiResponse", "url": "/openapi.json#/components/schemas/NarrativesListApiResponse", "contract": { "properties": { "narratives": { "items": { "$ref": "#/components/schemas/NarrativeItemApi" }, "type": "array", "title": "Narratives" } }, "type": "object", "required": [ "narratives" ], "title": "NarrativesListApiResponse" } }, { "id": "api:schema:NotificationsMarkReadRequest", "surface": "api", "heading": "API response or request schema: NotificationsMarkReadRequest", "route": "/openapi.json", "anchor": "/components/schemas/NotificationsMarkReadRequest", "url": "/openapi.json#/components/schemas/NotificationsMarkReadRequest", "contract": { "properties": { "brand_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Brand Id" }, "notification_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Notification Ids" }, "mark_all": { "type": "boolean", "title": "Mark All", "default": false } }, "type": "object", "title": "NotificationsMarkReadRequest" } }, { "id": "api:schema:NotificationsPublicResponse", "surface": "api", "heading": "API response or request schema: NotificationsPublicResponse", "route": "/openapi.json", "anchor": "/components/schemas/NotificationsPublicResponse", "url": "/openapi.json#/components/schemas/NotificationsPublicResponse", "contract": { "properties": { "notifications": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Notifications" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total" }, "unread_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Unread Count" }, "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Count" }, "brand_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Brand Id" }, "limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Limit" }, "offset": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Offset" } }, "additionalProperties": true, "type": "object", "title": "NotificationsPublicResponse" } }, { "id": "api:schema:NotificationsReadResponse", "surface": "api", "heading": "API response or request schema: NotificationsReadResponse", "route": "/openapi.json", "anchor": "/components/schemas/NotificationsReadResponse", "url": "/openapi.json#/components/schemas/NotificationsReadResponse", "contract": { "properties": { "updated_count": { "type": "integer", "title": "Updated Count" } }, "type": "object", "required": [ "updated_count" ], "title": "NotificationsReadResponse" } }, { "id": "api:schema:OpportunitiesResponse", "surface": "api", "heading": "API response or request schema: OpportunitiesResponse", "route": "/openapi.json", "anchor": "/components/schemas/OpportunitiesResponse", "url": "/openapi.json#/components/schemas/OpportunitiesResponse", "contract": { "properties": { "opportunities": { "items": { "$ref": "#/components/schemas/OpportunityItem" }, "type": "array", "title": "Opportunities" }, "summary": { "$ref": "#/components/schemas/OpportunitiesSummary" }, "brand": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Brand" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note" }, "suggestions": { "items": { "$ref": "#/components/schemas/SuggestedAction" }, "type": "array", "title": "Suggestions" }, "suggestion_total": { "type": "integer", "title": "Suggestion Total", "default": 0 } }, "type": "object", "required": [ "opportunities", "summary", "brand" ], "title": "OpportunitiesResponse" } }, { "id": "api:schema:OpportunitiesSummary", "surface": "api", "heading": "API response or request schema: OpportunitiesSummary", "route": "/openapi.json", "anchor": "/components/schemas/OpportunitiesSummary", "url": "/openapi.json#/components/schemas/OpportunitiesSummary", "contract": { "properties": { "total_opportunities": { "type": "integer", "title": "Total Opportunities" }, "not_mentioned_count": { "type": "integer", "title": "Not Mentioned Count" }, "uncited_count": { "type": "integer", "title": "Uncited Count" }, "low_position_count": { "type": "integer", "title": "Low Position Count" }, "period_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Period Days" } }, "type": "object", "required": [ "total_opportunities", "not_mentioned_count", "uncited_count", "low_position_count" ], "title": "OpportunitiesSummary" } }, { "id": "api:schema:OpportunityItem", "surface": "api", "heading": "API response or request schema: OpportunityItem", "route": "/openapi.json", "anchor": "/components/schemas/OpportunityItem", "url": "/openapi.json#/components/schemas/OpportunityItem", "contract": { "properties": { "result_id": { "type": "string", "title": "Result Id" }, "prompt_text": { "type": "string", "title": "Prompt Text" }, "llm": { "type": "string", "title": "Llm" }, "date": { "type": "string", "title": "Date" }, "competitors": { "items": { "$ref": "#/components/schemas/CompetitorPosition" }, "type": "array", "title": "Competitors" }, "opportunity_type": { "type": "string", "title": "Opportunity Type" }, "priority": { "type": "string", "title": "Priority" }, "reason": { "type": "string", "title": "Reason" } }, "type": "object", "required": [ "result_id", "prompt_text", "llm", "date", "competitors", "opportunity_type", "priority", "reason" ], "title": "OpportunityItem" } }, { "id": "api:schema:OpportunityPoolResponse", "surface": "api", "heading": "API response or request schema: OpportunityPoolResponse", "route": "/openapi.json", "anchor": "/components/schemas/OpportunityPoolResponse", "url": "/openapi.json#/components/schemas/OpportunityPoolResponse", "contract": { "properties": { "opportunities": { "items": { "$ref": "#/components/schemas/OpportunityPublicItem" }, "type": "array", "title": "Opportunities" }, "meta": { "$ref": "#/components/schemas/UnityListMeta" } }, "type": "object", "required": [ "opportunities", "meta" ], "title": "OpportunityPoolResponse" } }, { "id": "api:schema:OpportunityPublicItem", "surface": "api", "heading": "API response or request schema: OpportunityPublicItem", "route": "/openapi.json", "anchor": "/components/schemas/OpportunityPublicItem", "url": "/openapi.json#/components/schemas/OpportunityPublicItem", "contract": { "properties": { "id": { "type": "string", "title": "Id" }, "kind": { "type": "string", "title": "Kind" }, "family": { "type": "string", "title": "Family" }, "title": { "type": "string", "title": "Title" }, "impact": { "type": "string", "title": "Impact" }, "status": { "type": "string", "title": "Status" }, "evidence": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Evidence", "default": [] }, "page_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Id" }, "page_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Url" }, "dedup_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dedup Key" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "created_at": { "type": "string", "title": "Created At" } }, "type": "object", "required": [ "id", "kind", "family", "title", "impact", "status", "created_at" ], "title": "OpportunityPublicItem" } }, { "id": "api:schema:PageAnalysesListResponse", "surface": "api", "heading": "API response or request schema: PageAnalysesListResponse", "route": "/openapi.json", "anchor": "/components/schemas/PageAnalysesListResponse", "url": "/openapi.json#/components/schemas/PageAnalysesListResponse", "contract": { "properties": { "analyses": { "items": { "$ref": "#/components/schemas/PageAnalysisListItem" }, "type": "array", "title": "Analyses" }, "total": { "type": "integer", "title": "Total" } }, "type": "object", "required": [ "analyses", "total" ], "title": "PageAnalysesListResponse" } }, { "id": "api:schema:PageAnalysisDetailResponse", "surface": "api", "heading": "API response or request schema: PageAnalysisDetailResponse", "route": "/openapi.json", "anchor": "/components/schemas/PageAnalysisDetailResponse", "url": "/openapi.json#/components/schemas/PageAnalysisDetailResponse", "contract": { "properties": { "url": { "type": "string", "title": "Url" }, "analyzed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Analyzed At" }, "cached": { "type": "boolean", "title": "Cached", "default": true }, "ai_diagnosis": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ai Diagnosis" }, "overall_score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Overall Score" }, "technical_score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Technical Score" }, "citation_score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Citation Score" }, "citation_verdict": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Citation Verdict" }, "single_top_fix": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Single Top Fix" }, "secondary_fixes": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Secondary Fixes", "default": [] }, "detected_queries": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Detected Queries", "default": [] }, "quotable_facts": { "items": {}, "type": "array", "title": "Quotable Facts", "default": [] }, "ready_to_paste_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Ready To Paste Schema" }, "technical_checks": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Technical Checks" }, "failed_checks": { "items": { "type": "string" }, "type": "array", "title": "Failed Checks", "default": [] }, "warning_checks": { "items": { "type": "string" }, "type": "array", "title": "Warning Checks", "default": [] }, "entities": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Entities", "default": [] }, "detected_cms": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Detected Cms" }, "bot_visibility": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Bot Visibility" } }, "type": "object", "required": [ "url" ], "title": "PageAnalysisDetailResponse" } }, { "id": "api:schema:PageAnalysisListItem", "surface": "api", "heading": "API response or request schema: PageAnalysisListItem", "route": "/openapi.json", "anchor": "/components/schemas/PageAnalysisListItem", "url": "/openapi.json#/components/schemas/PageAnalysisListItem", "contract": { "properties": { "id": { "type": "string", "title": "Id" }, "url": { "type": "string", "title": "Url" }, "analyzed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Analyzed At" }, "overall_score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Overall Score" }, "technical_score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Technical Score" }, "citation_score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Citation Score" }, "page_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Type" }, "failed_checks_count": { "type": "integer", "title": "Failed Checks Count", "default": 0 }, "is_stale": { "type": "boolean", "title": "Is Stale", "default": false } }, "type": "object", "required": [ "id", "url" ], "title": "PageAnalysisListItem" } }, { "id": "api:schema:PagePublicItem", "surface": "api", "heading": "API response or request schema: PagePublicItem", "route": "/openapi.json", "anchor": "/components/schemas/PagePublicItem", "url": "/openapi.json#/components/schemas/PagePublicItem", "contract": { "properties": { "id": { "type": "string", "title": "Id" }, "url": { "type": "string", "title": "Url" }, "slug": { "type": "string", "title": "Slug" }, "ownership": { "type": "string", "title": "Ownership" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "tracked": { "type": "boolean", "title": "Tracked", "default": false }, "bottleneck": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bottleneck" }, "verdict": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Verdict" }, "last_seen_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Seen At" } }, "type": "object", "required": [ "id", "url", "slug", "ownership" ], "title": "PagePublicItem" } }, { "id": "api:schema:PagesResponse", "surface": "api", "heading": "API response or request schema: PagesResponse", "route": "/openapi.json", "anchor": "/components/schemas/PagesResponse", "url": "/openapi.json#/components/schemas/PagesResponse", "contract": { "properties": { "pages": { "items": { "$ref": "#/components/schemas/PagePublicItem" }, "type": "array", "title": "Pages" }, "meta": { "$ref": "#/components/schemas/UnityListMeta" } }, "type": "object", "required": [ "pages", "meta" ], "title": "PagesResponse" } }, { "id": "api:schema:PaginationInfo", "surface": "api", "heading": "API response or request schema: PaginationInfo", "route": "/openapi.json", "anchor": "/components/schemas/PaginationInfo", "url": "/openapi.json#/components/schemas/PaginationInfo", "contract": { "properties": { "total": { "type": "integer", "title": "Total" }, "limit": { "type": "integer", "title": "Limit" }, "offset": { "type": "integer", "title": "Offset" }, "has_more": { "type": "boolean", "title": "Has More" } }, "type": "object", "required": [ "total", "limit", "offset", "has_more" ], "title": "PaginationInfo" } }, { "id": "api:schema:PerceptionBrandSummaryApi", "surface": "api", "heading": "API response or request schema: PerceptionBrandSummaryApi", "route": "/openapi.json", "anchor": "/components/schemas/PerceptionBrandSummaryApi", "url": "/openapi.json#/components/schemas/PerceptionBrandSummaryApi", "contract": { "properties": { "brand_name": { "type": "string", "title": "Brand Name" }, "is_primary": { "type": "boolean", "title": "Is Primary", "default": false }, "rank_1_in": { "items": { "type": "string" }, "type": "array", "title": "Rank 1 In", "default": [] }, "rank_last_in": { "items": { "type": "string" }, "type": "array", "title": "Rank Last In", "default": [] } }, "type": "object", "required": [ "brand_name" ], "title": "PerceptionBrandSummaryApi" } }, { "id": "api:schema:PerceptionBrandTimeSeriesApi", "surface": "api", "heading": "API response or request schema: PerceptionBrandTimeSeriesApi", "route": "/openapi.json", "anchor": "/components/schemas/PerceptionBrandTimeSeriesApi", "url": "/openapi.json#/components/schemas/PerceptionBrandTimeSeriesApi", "contract": { "properties": { "brand_name": { "type": "string", "title": "Brand Name" }, "is_primary": { "type": "boolean", "title": "Is Primary", "default": false }, "metrics": { "items": { "$ref": "#/components/schemas/PerceptionMetricTimeSeriesApi" }, "type": "array", "title": "Metrics", "default": [] } }, "type": "object", "required": [ "brand_name" ], "title": "PerceptionBrandTimeSeriesApi" } }, { "id": "api:schema:PerceptionCompetitorGapApi", "surface": "api", "heading": "API response or request schema: PerceptionCompetitorGapApi", "route": "/openapi.json", "anchor": "/components/schemas/PerceptionCompetitorGapApi", "url": "/openapi.json#/components/schemas/PerceptionCompetitorGapApi", "contract": { "properties": { "competitor": { "type": "string", "title": "Competitor" }, "your_advantages": { "items": { "type": "string" }, "type": "array", "title": "Your Advantages", "default": [] }, "their_advantages": { "items": { "type": "string" }, "type": "array", "title": "Their Advantages", "default": [] }, "biggest_gap_for_you": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Biggest Gap For You" }, "biggest_gap_against_you": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Biggest Gap Against You" } }, "type": "object", "required": [ "competitor" ], "title": "PerceptionCompetitorGapApi" } }, { "id": "api:schema:PerceptionDashboardApiResponse", "surface": "api", "heading": "API response or request schema: PerceptionDashboardApiResponse", "route": "/openapi.json", "anchor": "/components/schemas/PerceptionDashboardApiResponse", "url": "/openapi.json#/components/schemas/PerceptionDashboardApiResponse", "contract": { "properties": { "period": { "anyOf": [ { "$ref": "#/components/schemas/PeriodMeta" }, { "type": "null" } ] }, "metadata": { "$ref": "#/components/schemas/PerceptionMetadataApi" }, "perception_score": { "$ref": "#/components/schemas/PerceptionScoreApi" }, "category_scores": { "additionalProperties": true, "type": "object", "title": "Category Scores", "default": {} }, "insights": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "type": "object", "title": "Insights", "default": {} }, "brand_summaries": { "items": { "$ref": "#/components/schemas/PerceptionBrandSummaryApi" }, "type": "array", "title": "Brand Summaries", "default": [] }, "detailed_sentiment_timeseries": { "items": { "$ref": "#/components/schemas/PerceptionBrandTimeSeriesApi" }, "type": "array", "title": "Detailed Sentiment Timeseries", "default": [] }, "competitor_gaps": { "items": { "$ref": "#/components/schemas/PerceptionCompetitorGapApi" }, "type": "array", "title": "Competitor Gaps", "default": [] }, "radar_chart_data": { "items": { "$ref": "#/components/schemas/PerceptionRadarBrandApi" }, "type": "array", "title": "Radar Chart Data", "default": [] }, "metric_rankings": { "additionalProperties": true, "type": "object", "title": "Metric Rankings", "default": {} }, "primary_brand_overall_timeseries": { "items": { "$ref": "#/components/schemas/PerceptionMetricSeriesPointApi" }, "type": "array", "title": "Primary Brand Overall Timeseries", "default": [] } }, "type": "object", "required": [ "metadata", "perception_score" ], "title": "PerceptionDashboardApiResponse" } }, { "id": "api:schema:PerceptionMetadataApi", "surface": "api", "heading": "API response or request schema: PerceptionMetadataApi", "route": "/openapi.json", "anchor": "/components/schemas/PerceptionMetadataApi", "url": "/openapi.json#/components/schemas/PerceptionMetadataApi", "contract": { "properties": { "brand_id": { "type": "string", "title": "Brand Id" }, "primary_brand": { "type": "string", "title": "Primary Brand" }, "date_range_start": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date Range Start" }, "date_range_end": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date Range End" }, "total_brands_tracked": { "type": "integer", "title": "Total Brands Tracked", "default": 0 }, "days_of_data": { "type": "integer", "title": "Days Of Data", "default": 0 } }, "type": "object", "required": [ "brand_id", "primary_brand" ], "title": "PerceptionMetadataApi" } }, { "id": "api:schema:PerceptionMetricSeriesPointApi", "surface": "api", "heading": "API response or request schema: PerceptionMetricSeriesPointApi", "route": "/openapi.json", "anchor": "/components/schemas/PerceptionMetricSeriesPointApi", "url": "/openapi.json#/components/schemas/PerceptionMetricSeriesPointApi", "contract": { "properties": { "date": { "type": "string", "title": "Date" }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Score" } }, "type": "object", "required": [ "date" ], "title": "PerceptionMetricSeriesPointApi" } }, { "id": "api:schema:PerceptionMetricTimeSeriesApi", "surface": "api", "heading": "API response or request schema: PerceptionMetricTimeSeriesApi", "route": "/openapi.json", "anchor": "/components/schemas/PerceptionMetricTimeSeriesApi", "url": "/openapi.json#/components/schemas/PerceptionMetricTimeSeriesApi", "contract": { "properties": { "metric_name": { "type": "string", "title": "Metric Name" }, "series": { "items": { "$ref": "#/components/schemas/PerceptionMetricSeriesPointApi" }, "type": "array", "title": "Series", "default": [] }, "average_7_day": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average 7 Day" } }, "type": "object", "required": [ "metric_name" ], "title": "PerceptionMetricTimeSeriesApi" } }, { "id": "api:schema:PerceptionMetricsApiResponse", "surface": "api", "heading": "API response or request schema: PerceptionMetricsApiResponse", "route": "/openapi.json", "anchor": "/components/schemas/PerceptionMetricsApiResponse", "url": "/openapi.json#/components/schemas/PerceptionMetricsApiResponse", "contract": { "properties": { "period": { "anyOf": [ { "$ref": "#/components/schemas/PeriodMeta" }, { "type": "null" } ] }, "brand_id": { "type": "string", "title": "Brand Id" }, "tracked_brand": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tracked Brand" }, "days": { "type": "integer", "title": "Days" }, "count": { "type": "integer", "title": "Count" }, "data": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Data", "default": [] } }, "type": "object", "required": [ "brand_id", "days", "count" ], "title": "PerceptionMetricsApiResponse" } }, { "id": "api:schema:PerceptionNarrativeApiResponse", "surface": "api", "heading": "API response or request schema: PerceptionNarrativeApiResponse", "route": "/openapi.json", "anchor": "/components/schemas/PerceptionNarrativeApiResponse", "url": "/openapi.json#/components/schemas/PerceptionNarrativeApiResponse", "contract": { "properties": { "brand_id": { "type": "string", "title": "Brand Id" }, "narrative": { "anyOf": [ { "$ref": "#/components/schemas/PerceptionNarrativeData" }, { "type": "null" } ] }, "snapshot_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Snapshot Date" } }, "type": "object", "required": [ "brand_id" ], "title": "PerceptionNarrativeApiResponse" } }, { "id": "api:schema:PerceptionNarrativeData", "surface": "api", "heading": "API response or request schema: PerceptionNarrativeData", "route": "/openapi.json", "anchor": "/components/schemas/PerceptionNarrativeData", "url": "/openapi.json#/components/schemas/PerceptionNarrativeData", "contract": { "properties": { "positioning": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Positioning" }, "strengths": { "items": { "type": "string" }, "type": "array", "title": "Strengths", "default": [] }, "weaknesses": { "items": { "type": "string" }, "type": "array", "title": "Weaknesses", "default": [] }, "opportunities": { "items": { "type": "string" }, "type": "array", "title": "Opportunities", "default": [] }, "sentiment_summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sentiment Summary" } }, "type": "object", "title": "PerceptionNarrativeData" } }, { "id": "api:schema:PerceptionNarrativeDriftApiResponse", "surface": "api", "heading": "API response or request schema: PerceptionNarrativeDriftApiResponse", "route": "/openapi.json", "anchor": "/components/schemas/PerceptionNarrativeDriftApiResponse", "url": "/openapi.json#/components/schemas/PerceptionNarrativeDriftApiResponse", "contract": { "properties": { "brand_id": { "type": "string", "title": "Brand Id" }, "weeks": { "type": "integer", "maximum": 52.0, "minimum": 1.0, "title": "Weeks" }, "drift": { "$ref": "#/components/schemas/PerceptionNarrativeDriftDataApi" } }, "type": "object", "required": [ "brand_id", "weeks", "drift" ], "title": "PerceptionNarrativeDriftApiResponse" } }, { "id": "api:schema:PerceptionNarrativeDriftDataApi", "surface": "api", "heading": "API response or request schema: PerceptionNarrativeDriftDataApi", "route": "/openapi.json", "anchor": "/components/schemas/PerceptionNarrativeDriftDataApi", "url": "/openapi.json#/components/schemas/PerceptionNarrativeDriftDataApi", "contract": { "properties": { "history": { "items": { "$ref": "#/components/schemas/PerceptionNarrativeDriftPointApi" }, "type": "array", "title": "History" }, "total_weeks": { "type": "integer", "minimum": 0.0, "title": "Total Weeks" }, "significant_changes": { "type": "integer", "minimum": 0.0, "title": "Significant Changes" } }, "type": "object", "required": [ "history", "total_weeks", "significant_changes" ], "title": "PerceptionNarrativeDriftDataApi" } }, { "id": "api:schema:PerceptionNarrativeDriftPointApi", "surface": "api", "heading": "API response or request schema: PerceptionNarrativeDriftPointApi", "route": "/openapi.json", "anchor": "/components/schemas/PerceptionNarrativeDriftPointApi", "url": "/openapi.json#/components/schemas/PerceptionNarrativeDriftPointApi", "contract": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "run_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Run Date" }, "positioning_statement": { "type": "string", "title": "Positioning Statement" }, "brand_tone": { "type": "string", "title": "Brand Tone" }, "primary_descriptors": { "items": {}, "type": "array", "title": "Primary Descriptors" }, "perception_score": { "type": "number", "title": "Perception Score" }, "positioning_changed": { "type": "boolean", "title": "Positioning Changed" }, "tone_changed": { "type": "boolean", "title": "Tone Changed" }, "new_descriptors": { "items": {}, "type": "array", "title": "New Descriptors" }, "lost_descriptors": { "items": {}, "type": "array", "title": "Lost Descriptors" }, "diff": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Diff" } }, "type": "object", "required": [ "id", "run_date", "positioning_statement", "brand_tone", "primary_descriptors", "perception_score", "positioning_changed", "tone_changed", "new_descriptors", "lost_descriptors", "diff" ], "title": "PerceptionNarrativeDriftPointApi" } }, { "id": "api:schema:PerceptionRadarBrandApi", "surface": "api", "heading": "API response or request schema: PerceptionRadarBrandApi", "route": "/openapi.json", "anchor": "/components/schemas/PerceptionRadarBrandApi", "url": "/openapi.json#/components/schemas/PerceptionRadarBrandApi", "contract": { "properties": { "name": { "type": "string", "title": "Name" }, "is_primary": { "type": "boolean", "title": "Is Primary", "default": false }, "data": { "items": { "$ref": "#/components/schemas/PerceptionRadarPointApi" }, "type": "array", "title": "Data", "default": [] } }, "type": "object", "required": [ "name" ], "title": "PerceptionRadarBrandApi" } }, { "id": "api:schema:PerceptionRadarPointApi", "surface": "api", "heading": "API response or request schema: PerceptionRadarPointApi", "route": "/openapi.json", "anchor": "/components/schemas/PerceptionRadarPointApi", "url": "/openapi.json#/components/schemas/PerceptionRadarPointApi", "contract": { "properties": { "axis": { "type": "string", "title": "Axis" }, "value": { "type": "number", "title": "Value" } }, "type": "object", "required": [ "axis", "value" ], "title": "PerceptionRadarPointApi" } }, { "id": "api:schema:PerceptionRunApiResponse", "surface": "api", "heading": "API response or request schema: PerceptionRunApiResponse", "route": "/openapi.json", "anchor": "/components/schemas/PerceptionRunApiResponse", "url": "/openapi.json#/components/schemas/PerceptionRunApiResponse", "contract": { "properties": { "status": { "type": "string", "title": "Status" }, "brand_id": { "type": "string", "title": "Brand Id" }, "primary_brand": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primary Brand" }, "run_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Run Date" }, "brands_analyzed": { "items": { "type": "string" }, "type": "array", "title": "Brands Analyzed", "default": [] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" } }, "type": "object", "required": [ "status", "brand_id" ], "title": "PerceptionRunApiResponse" } }, { "id": "api:schema:PerceptionRunRequest", "surface": "api", "heading": "API response or request schema: PerceptionRunRequest", "route": "/openapi.json", "anchor": "/components/schemas/PerceptionRunRequest", "url": "/openapi.json#/components/schemas/PerceptionRunRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "include_competitors": { "type": "boolean", "title": "Include Competitors", "default": true } }, "type": "object", "required": [ "brand_id" ], "title": "PerceptionRunRequest" } }, { "id": "api:schema:PerceptionScoreApi", "surface": "api", "heading": "API response or request schema: PerceptionScoreApi", "route": "/openapi.json", "anchor": "/components/schemas/PerceptionScoreApi", "url": "/openapi.json#/components/schemas/PerceptionScoreApi", "contract": { "properties": { "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Score" }, "change_7d": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change 7D" }, "percentile": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Percentile" }, "change_period": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change Period" } }, "type": "object", "title": "PerceptionScoreApi" } }, { "id": "api:schema:PerceptionStoryApiResponse", "surface": "api", "heading": "API response or request schema: PerceptionStoryApiResponse", "route": "/openapi.json", "anchor": "/components/schemas/PerceptionStoryApiResponse", "url": "/openapi.json#/components/schemas/PerceptionStoryApiResponse", "contract": { "properties": { "brand_id": { "type": "string", "title": "Brand Id" }, "story": { "anyOf": [ { "$ref": "#/components/schemas/PerceptionStoryDataApi" }, { "type": "null" } ] } }, "type": "object", "required": [ "brand_id", "story" ], "title": "PerceptionStoryApiResponse" } }, { "id": "api:schema:PerceptionStoryDataApi", "surface": "api", "heading": "API response or request schema: PerceptionStoryDataApi", "route": "/openapi.json", "anchor": "/components/schemas/PerceptionStoryDataApi", "url": "/openapi.json#/components/schemas/PerceptionStoryDataApi", "contract": { "properties": { "run_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Run Date" }, "brand_id": { "type": "string", "title": "Brand Id" }, "total_prompts_analyzed": { "type": "integer", "title": "Total Prompts Analyzed" }, "total_responses_processed": { "type": "integer", "title": "Total Responses Processed" }, "narrative": { "$ref": "#/components/schemas/PerceptionStoryNarrativeApi" }, "perception_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Perception Score" }, "perception_percentile": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Perception Percentile" }, "perception_change_7d": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Perception Change 7D" }, "semantic_dna": { "$ref": "#/components/schemas/PerceptionStorySemanticDnaApi" }, "use_case_mapping": { "$ref": "#/components/schemas/PerceptionStoryUseCasesApi" }, "perception_gaps": { "$ref": "#/components/schemas/PerceptionStoryGapsApi" }, "common_concerns": { "items": {}, "type": "array", "title": "Common Concerns" }, "category_scores": { "additionalProperties": true, "type": "object", "title": "Category Scores" }, "model_breakdown": { "additionalProperties": true, "type": "object", "title": "Model Breakdown" }, "recommendations": { "items": {}, "type": "array", "title": "Recommendations" }, "top_cited_domains": { "items": {}, "type": "array", "title": "Top Cited Domains" }, "source_perception_map": { "items": {}, "type": "array", "title": "Source Perception Map" }, "competitor_narratives": { "additionalProperties": true, "type": "object", "title": "Competitor Narratives" } }, "type": "object", "required": [ "run_date", "brand_id", "total_prompts_analyzed", "total_responses_processed", "narrative", "perception_score", "perception_percentile", "perception_change_7d", "semantic_dna", "use_case_mapping", "perception_gaps", "common_concerns", "category_scores", "model_breakdown", "recommendations", "top_cited_domains", "source_perception_map", "competitor_narratives" ], "title": "PerceptionStoryDataApi" } }, { "id": "api:schema:PerceptionStoryGapsApi", "surface": "api", "heading": "API response or request schema: PerceptionStoryGapsApi", "route": "/openapi.json", "anchor": "/components/schemas/PerceptionStoryGapsApi", "url": "/openapi.json#/components/schemas/PerceptionStoryGapsApi", "contract": { "properties": { "perception_gaps": { "items": {}, "type": "array", "title": "Perception Gaps" }, "alignment_score": { "type": "number", "title": "Alignment Score" } }, "type": "object", "required": [ "perception_gaps", "alignment_score" ], "title": "PerceptionStoryGapsApi" } }, { "id": "api:schema:PerceptionStoryNarrativeApi", "surface": "api", "heading": "API response or request schema: PerceptionStoryNarrativeApi", "route": "/openapi.json", "anchor": "/components/schemas/PerceptionStoryNarrativeApi", "url": "/openapi.json#/components/schemas/PerceptionStoryNarrativeApi", "contract": { "properties": { "summary": { "type": "string", "title": "Summary" }, "positioning": { "type": "string", "title": "Positioning" }, "tone": { "type": "string", "const": "", "title": "Tone" }, "key_themes": { "items": {}, "type": "array", "title": "Key Themes" } }, "type": "object", "required": [ "summary", "positioning", "tone", "key_themes" ], "title": "PerceptionStoryNarrativeApi" } }, { "id": "api:schema:PerceptionStorySemanticDnaApi", "surface": "api", "heading": "API response or request schema: PerceptionStorySemanticDnaApi", "route": "/openapi.json", "anchor": "/components/schemas/PerceptionStorySemanticDnaApi", "url": "/openapi.json#/components/schemas/PerceptionStorySemanticDnaApi", "contract": { "properties": { "semantic_dna": { "items": {}, "type": "array", "title": "Semantic Dna" }, "primary_descriptors": { "items": {}, "type": "array", "title": "Primary Descriptors" }, "emerging_descriptors": { "items": {}, "type": "array", "title": "Emerging Descriptors" }, "fading_descriptors": { "items": {}, "type": "array", "title": "Fading Descriptors" } }, "type": "object", "required": [ "semantic_dna", "primary_descriptors", "emerging_descriptors", "fading_descriptors" ], "title": "PerceptionStorySemanticDnaApi" } }, { "id": "api:schema:PerceptionStoryUseCasesApi", "surface": "api", "heading": "API response or request schema: PerceptionStoryUseCasesApi", "route": "/openapi.json", "anchor": "/components/schemas/PerceptionStoryUseCasesApi", "url": "/openapi.json#/components/schemas/PerceptionStoryUseCasesApi", "contract": { "properties": { "winning_use_cases": { "items": {}, "type": "array", "title": "Winning Use Cases" }, "losing_use_cases": { "items": {}, "type": "array", "title": "Losing Use Cases" }, "use_case_coverage_score": { "type": "number", "title": "Use Case Coverage Score" } }, "type": "object", "required": [ "winning_use_cases", "losing_use_cases", "use_case_coverage_score" ], "title": "PerceptionStoryUseCasesApi" } }, { "id": "api:schema:PeriodIndexEntry", "surface": "api", "heading": "API response or request schema: PeriodIndexEntry", "route": "/openapi.json", "anchor": "/components/schemas/PeriodIndexEntry", "url": "/openapi.json#/components/schemas/PeriodIndexEntry", "contract": { "properties": { "key": { "type": "string", "title": "Key" }, "kind": { "type": "string", "title": "Kind" }, "label": { "type": "string", "title": "Label" }, "status": { "type": "string", "title": "Status" }, "source": { "type": "string", "title": "Source" }, "start": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start" }, "end": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End" }, "data_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Data Status" }, "frozen_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Frozen At" }, "restated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Restated At" }, "complete_report_set": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Complete Report Set" }, "months_archived": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Months Archived" }, "days_elapsed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Days Elapsed" } }, "type": "object", "required": [ "key", "kind", "label", "status", "source" ], "title": "PeriodIndexEntry" } }, { "id": "api:schema:PeriodIndexResponse", "surface": "api", "heading": "API response or request schema: PeriodIndexResponse", "route": "/openapi.json", "anchor": "/components/schemas/PeriodIndexResponse", "url": "/openapi.json#/components/schemas/PeriodIndexResponse", "contract": { "properties": { "brand": { "additionalProperties": true, "type": "object", "title": "Brand" }, "periods": { "items": { "$ref": "#/components/schemas/PeriodIndexEntry" }, "type": "array", "title": "Periods" }, "quarters": { "items": { "$ref": "#/components/schemas/PeriodIndexEntry" }, "type": "array", "title": "Quarters", "default": [] }, "current": { "$ref": "#/components/schemas/PeriodIndexEntry" } }, "type": "object", "required": [ "brand", "periods", "current" ], "title": "PeriodIndexResponse" } }, { "id": "api:schema:PeriodMeta", "surface": "api", "heading": "API response or request schema: PeriodMeta", "route": "/openapi.json", "anchor": "/components/schemas/PeriodMeta", "url": "/openapi.json#/components/schemas/PeriodMeta", "contract": { "properties": { "key": { "type": "string", "title": "Key" }, "kind": { "type": "string", "title": "Kind" }, "label": { "type": "string", "title": "Label" }, "start": { "type": "string", "title": "Start" }, "end": { "type": "string", "title": "End" }, "status": { "type": "string", "title": "Status" }, "source": { "type": "string", "title": "Source" }, "frozen_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Frozen At" }, "pipeline_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pipeline Version" }, "restated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Restated At" }, "restatements": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Restatements", "default": [] }, "coverage": { "additionalProperties": true, "type": "object", "title": "Coverage", "default": {} }, "fields_computed": { "items": { "type": "string" }, "type": "array", "title": "Fields Computed", "default": [] }, "fields_missing": { "items": { "type": "string" }, "type": "array", "title": "Fields Missing", "default": [] }, "notes": { "items": { "type": "string" }, "type": "array", "title": "Notes", "default": [] }, "months": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Months" }, "rank_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rank Source" } }, "type": "object", "required": [ "key", "kind", "label", "start", "end", "status", "source" ], "title": "PeriodMeta" } }, { "id": "api:schema:PeriodMetricValue", "surface": "api", "heading": "API response or request schema: PeriodMetricValue", "route": "/openapi.json", "anchor": "/components/schemas/PeriodMetricValue", "url": "/openapi.json#/components/schemas/PeriodMetricValue", "contract": { "properties": { "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Value" }, "prior": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Prior" }, "delta": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Delta" }, "delta_pct": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Delta Pct" }, "positions_gained": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Positions Gained" }, "direction": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Direction" } }, "type": "object", "title": "PeriodMetricValue" } }, { "id": "api:schema:PeriodPortfolioBrand", "surface": "api", "heading": "API response or request schema: PeriodPortfolioBrand", "route": "/openapi.json", "anchor": "/components/schemas/PeriodPortfolioBrand", "url": "/openapi.json#/components/schemas/PeriodPortfolioBrand", "contract": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Website" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain" }, "notes": { "items": { "type": "string" }, "type": "array", "title": "Notes", "default": [] } }, "type": "object", "required": [ "id" ], "title": "PeriodPortfolioBrand" } }, { "id": "api:schema:PeriodPortfolioExcluded", "surface": "api", "heading": "API response or request schema: PeriodPortfolioExcluded", "route": "/openapi.json", "anchor": "/components/schemas/PeriodPortfolioExcluded", "url": "/openapi.json#/components/schemas/PeriodPortfolioExcluded", "contract": { "properties": { "brand_id": { "type": "string", "title": "Brand Id" }, "reason": { "type": "string", "title": "Reason" } }, "type": "object", "required": [ "brand_id", "reason" ], "title": "PeriodPortfolioExcluded" } }, { "id": "api:schema:PeriodPortfolioMonth", "surface": "api", "heading": "API response or request schema: PeriodPortfolioMonth", "route": "/openapi.json", "anchor": "/components/schemas/PeriodPortfolioMonth", "url": "/openapi.json#/components/schemas/PeriodPortfolioMonth", "contract": { "properties": { "key": { "type": "string", "title": "Key" }, "label": { "type": "string", "title": "Label" }, "start": { "type": "string", "title": "Start" }, "end": { "type": "string", "title": "End" } }, "type": "object", "required": [ "key", "label", "start", "end" ], "title": "PeriodPortfolioMonth" } }, { "id": "api:schema:PeriodPortfolioResponse", "surface": "api", "heading": "API response or request schema: PeriodPortfolioResponse", "route": "/openapi.json", "anchor": "/components/schemas/PeriodPortfolioResponse", "url": "/openapi.json#/components/schemas/PeriodPortfolioResponse", "contract": { "properties": { "months": { "items": { "$ref": "#/components/schemas/PeriodPortfolioMonth" }, "type": "array", "title": "Months" }, "brands": { "items": { "$ref": "#/components/schemas/PeriodPortfolioBrand" }, "type": "array", "title": "Brands" }, "rows": { "items": { "$ref": "#/components/schemas/PeriodPortfolioRow" }, "type": "array", "title": "Rows" }, "metric_ids": { "items": { "type": "string" }, "type": "array", "title": "Metric Ids" }, "metric_meta": { "additionalProperties": true, "type": "object", "title": "Metric Meta", "default": {} }, "current": { "additionalProperties": true, "type": "object", "title": "Current" }, "notes": { "items": { "type": "string" }, "type": "array", "title": "Notes", "default": [] }, "excluded": { "items": { "$ref": "#/components/schemas/PeriodPortfolioExcluded" }, "type": "array", "title": "Excluded", "default": [] } }, "type": "object", "required": [ "months", "brands", "rows", "metric_ids", "current" ], "title": "PeriodPortfolioResponse" } }, { "id": "api:schema:PeriodPortfolioRow", "surface": "api", "heading": "API response or request schema: PeriodPortfolioRow", "route": "/openapi.json", "anchor": "/components/schemas/PeriodPortfolioRow", "url": "/openapi.json#/components/schemas/PeriodPortfolioRow", "contract": { "properties": { "brand_id": { "type": "string", "title": "Brand Id" }, "period": { "type": "string", "title": "Period" }, "label": { "type": "string", "title": "Label" }, "start": { "type": "string", "title": "Start" }, "end": { "type": "string", "title": "End" }, "status": { "type": "string", "title": "Status" }, "source": { "type": "string", "title": "Source" }, "data_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Data Status" }, "frozen_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Frozen At" }, "restated": { "type": "boolean", "title": "Restated", "default": false }, "report_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Report Days" }, "metrics": { "additionalProperties": { "$ref": "#/components/schemas/PeriodMetricValue" }, "type": "object", "title": "Metrics", "default": {} }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note" } }, "type": "object", "required": [ "brand_id", "period", "label", "start", "end", "status", "source" ], "title": "PeriodPortfolioRow" } }, { "id": "api:schema:PeriodSummaryResponse", "surface": "api", "heading": "API response or request schema: PeriodSummaryResponse", "route": "/openapi.json", "anchor": "/components/schemas/PeriodSummaryResponse", "url": "/openapi.json#/components/schemas/PeriodSummaryResponse", "contract": { "properties": { "brand": { "additionalProperties": true, "type": "object", "title": "Brand" }, "period": { "$ref": "#/components/schemas/PeriodMeta" }, "prior": { "anyOf": [ { "$ref": "#/components/schemas/PeriodMeta" }, { "type": "null" } ] }, "metrics": { "additionalProperties": { "$ref": "#/components/schemas/PeriodMetricValue" }, "type": "object", "title": "Metrics" }, "breakdowns": { "additionalProperties": true, "type": "object", "title": "Breakdowns", "default": {} }, "headline_metric_ids": { "items": { "type": "string" }, "type": "array", "title": "Headline Metric Ids", "default": [] }, "groups": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Groups", "default": [] }, "metric_meta": { "additionalProperties": true, "type": "object", "title": "Metric Meta", "default": {} }, "definitions": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Definitions" } }, "type": "object", "required": [ "brand", "period", "metrics" ], "title": "PeriodSummaryResponse" } }, { "id": "api:schema:PortfolioActionsPublicResponse", "surface": "api", "heading": "API response or request schema: PortfolioActionsPublicResponse", "route": "/openapi.json", "anchor": "/components/schemas/PortfolioActionsPublicResponse", "url": "/openapi.json#/components/schemas/PortfolioActionsPublicResponse", "contract": { "properties": { "actions": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Actions" }, "total": { "type": "integer", "title": "Total" }, "brand_count": { "type": "integer", "title": "Brand Count" }, "withheld_brand_ids": { "items": { "type": "string" }, "type": "array", "title": "Withheld Brand Ids", "default": [] }, "group_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Group Id" }, "quick_win_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Quick Win Only" } }, "additionalProperties": true, "type": "object", "required": [ "actions", "total", "brand_count" ], "title": "PortfolioActionsPublicResponse" } }, { "id": "api:schema:PrismPublicConfig", "surface": "api", "heading": "API response or request schema: PrismPublicConfig", "route": "/openapi.json", "anchor": "/components/schemas/PrismPublicConfig", "url": "/openapi.json#/components/schemas/PrismPublicConfig", "contract": { "properties": { "enabled": { "type": "boolean", "title": "Enabled" }, "domain": { "type": "string", "title": "Domain" }, "platform": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Platform" }, "features": { "items": { "type": "string" }, "type": "array", "title": "Features", "default": [] }, "crawlers": { "items": { "type": "string" }, "type": "array", "title": "Crawlers", "default": [] } }, "type": "object", "required": [ "enabled", "domain" ], "title": "PrismPublicConfig" } }, { "id": "api:schema:PrismPublicUsage", "surface": "api", "heading": "API response or request schema: PrismPublicUsage", "route": "/openapi.json", "anchor": "/components/schemas/PrismPublicUsage", "url": "/openapi.json#/components/schemas/PrismPublicUsage", "contract": { "properties": { "requests_this_month": { "type": "integer", "title": "Requests This Month" }, "requests_limit": { "type": "integer", "title": "Requests Limit" }, "percentage_used": { "type": "number", "title": "Percentage Used" }, "reset_date": { "type": "string", "title": "Reset Date" } }, "type": "object", "required": [ "requests_this_month", "requests_limit", "percentage_used", "reset_date" ], "title": "PrismPublicUsage" } }, { "id": "api:schema:PrismResponse", "surface": "api", "heading": "API response or request schema: PrismResponse", "route": "/openapi.json", "anchor": "/components/schemas/PrismResponse", "url": "/openapi.json#/components/schemas/PrismResponse", "contract": { "properties": { "brand": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Brand" }, "config": { "anyOf": [ { "$ref": "#/components/schemas/PrismPublicConfig" }, { "type": "null" } ] }, "usage": { "anyOf": [ { "$ref": "#/components/schemas/PrismPublicUsage" }, { "type": "null" } ] } }, "type": "object", "required": [ "brand" ], "title": "PrismResponse" } }, { "id": "api:schema:PromptItem", "surface": "api", "heading": "API response or request schema: PromptItem", "route": "/openapi.json", "anchor": "/components/schemas/PromptItem", "url": "/openapi.json#/components/schemas/PromptItem", "contract": { "properties": { "id": { "type": "string", "title": "Id" }, "brand_id": { "type": "string", "title": "Brand Id" }, "text": { "type": "string", "title": "Text" }, "active": { "type": "boolean", "title": "Active", "default": true }, "focus_area": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Focus Area" }, "intent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Intent" }, "audience": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Audience" }, "specificity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Specificity" }, "quality_score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Quality Score" }, "source": { "type": "string", "title": "Source", "default": "api" }, "created_at": { "type": "string", "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "tags": { "anyOf": [ { "items": { "$ref": "#/components/schemas/TagItem" }, "type": "array" }, { "type": "null" } ], "title": "Tags" } }, "type": "object", "required": [ "id", "brand_id", "text", "created_at" ], "title": "PromptItem" } }, { "id": "api:schema:PromptMarketScore", "surface": "api", "heading": "API response or request schema: PromptMarketScore", "route": "/openapi.json", "anchor": "/components/schemas/PromptMarketScore", "url": "/openapi.json#/components/schemas/PromptMarketScore", "contract": { "properties": { "market_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Market Id" }, "location": { "type": "string", "title": "Location" }, "location_region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location Region" }, "location_city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location City" }, "is_primary": { "type": "boolean", "title": "Is Primary" }, "score": { "type": "number", "title": "Score" }, "search_volume": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Search Volume" }, "priority_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Priority Score" } }, "type": "object", "required": [ "location", "is_primary", "score" ], "title": "PromptMarketScore" } }, { "id": "api:schema:PromptPositionSeries", "surface": "api", "heading": "API response or request schema: PromptPositionSeries", "route": "/openapi.json", "anchor": "/components/schemas/PromptPositionSeries", "url": "/openapi.json#/components/schemas/PromptPositionSeries", "contract": { "properties": { "prompt_text": { "type": "string", "title": "Prompt Text" }, "your_positions": { "items": { "$ref": "#/components/schemas/PromptPositionSeriesPoint" }, "type": "array", "title": "Your Positions", "default": [] }, "competitors": { "additionalProperties": { "items": { "$ref": "#/components/schemas/PromptPositionSeriesPoint" }, "type": "array" }, "type": "object", "title": "Competitors", "default": {} }, "days_with_data": { "type": "integer", "title": "Days With Data", "default": 0 }, "best_position": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Best Position" }, "worst_position": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Worst Position" }, "latest_position": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Latest Position" }, "position_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Position Change" } }, "type": "object", "required": [ "prompt_text" ], "title": "PromptPositionSeries" } }, { "id": "api:schema:PromptPositionSeriesPoint", "surface": "api", "heading": "API response or request schema: PromptPositionSeriesPoint", "route": "/openapi.json", "anchor": "/components/schemas/PromptPositionSeriesPoint", "url": "/openapi.json#/components/schemas/PromptPositionSeriesPoint", "contract": { "properties": { "date": { "type": "string", "title": "Date" }, "position": { "type": "number", "title": "Position" } }, "type": "object", "required": [ "date", "position" ], "title": "PromptPositionSeriesPoint" } }, { "id": "api:schema:PromptRanking", "surface": "api", "heading": "API response or request schema: PromptRanking", "route": "/openapi.json", "anchor": "/components/schemas/PromptRanking", "url": "/openapi.json#/components/schemas/PromptRanking", "contract": { "properties": { "prompt_id": { "type": "string", "title": "Prompt Id" }, "prompt_text": { "type": "string", "title": "Prompt Text" }, "markets": { "items": { "$ref": "#/components/schemas/PromptMarketScore" }, "type": "array", "title": "Markets" } }, "type": "object", "required": [ "prompt_id", "prompt_text", "markets" ], "title": "PromptRanking" } }, { "id": "api:schema:PromptsListResponse", "surface": "api", "heading": "API response or request schema: PromptsListResponse", "route": "/openapi.json", "anchor": "/components/schemas/PromptsListResponse", "url": "/openapi.json#/components/schemas/PromptsListResponse", "contract": { "properties": { "prompts": { "items": { "$ref": "#/components/schemas/PromptItem" }, "type": "array", "title": "Prompts" }, "total": { "type": "integer", "title": "Total" }, "limit": { "type": "integer", "title": "Limit" }, "offset": { "type": "integer", "title": "Offset" } }, "type": "object", "required": [ "prompts", "total", "limit", "offset" ], "title": "PromptsListResponse" } }, { "id": "api:schema:ProofResponse", "surface": "api", "heading": "API response or request schema: ProofResponse", "route": "/openapi.json", "anchor": "/components/schemas/ProofResponse", "url": "/openapi.json#/components/schemas/ProofResponse", "contract": { "properties": { "proof": { "items": { "$ref": "#/components/schemas/ResultPublicItem" }, "type": "array", "title": "Proof" }, "meta": { "$ref": "#/components/schemas/UnityListMeta" }, "verdict_counts": { "additionalProperties": { "type": "integer" }, "type": "object", "title": "Verdict Counts" } }, "type": "object", "required": [ "proof", "meta", "verdict_counts" ], "title": "ProofResponse" } }, { "id": "api:schema:PublicApiErrorResponse", "surface": "api", "heading": "API response or request schema: PublicApiErrorResponse", "route": "/openapi.json", "anchor": "/components/schemas/PublicApiErrorResponse", "url": "/openapi.json#/components/schemas/PublicApiErrorResponse", "contract": { "properties": { "detail": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Detail" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" } }, "type": "object", "title": "PublicApiErrorResponse" } }, { "id": "api:schema:PublicDeleteResponse", "surface": "api", "heading": "API response or request schema: PublicDeleteResponse", "route": "/openapi.json", "anchor": "/components/schemas/PublicDeleteResponse", "url": "/openapi.json#/components/schemas/PublicDeleteResponse", "contract": { "properties": { "success": { "type": "boolean", "title": "Success" }, "deleted_id": { "type": "string", "title": "Deleted Id" } }, "type": "object", "required": [ "success", "deleted_id" ], "title": "PublicDeleteResponse" } }, { "id": "api:schema:PublicGenerateArticleRequest", "surface": "api", "heading": "API response or request schema: PublicGenerateArticleRequest", "route": "/openapi.json", "anchor": "/components/schemas/PublicGenerateArticleRequest", "url": "/openapi.json#/components/schemas/PublicGenerateArticleRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "primary_prompt": { "type": "string", "title": "Primary Prompt" }, "secondary_prompts": { "items": { "type": "string" }, "type": "array", "title": "Secondary Prompts" }, "word_target": { "type": "integer", "maximum": 6000.0, "minimum": 300.0, "title": "Word Target", "default": 2000 }, "template_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template Id" } }, "type": "object", "required": [ "brand_id", "primary_prompt" ], "title": "PublicGenerateArticleRequest" } }, { "id": "api:schema:PublicKnowledgeTextRequest", "surface": "api", "heading": "API response or request schema: PublicKnowledgeTextRequest", "route": "/openapi.json", "anchor": "/components/schemas/PublicKnowledgeTextRequest", "url": "/openapi.json#/components/schemas/PublicKnowledgeTextRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "name": { "type": "string", "title": "Name" }, "content": { "type": "string", "title": "Content" } }, "type": "object", "required": [ "brand_id", "name", "content" ], "title": "PublicKnowledgeTextRequest" } }, { "id": "api:schema:PublicKnowledgeUrlRequest", "surface": "api", "heading": "API response or request schema: PublicKnowledgeUrlRequest", "route": "/openapi.json", "anchor": "/components/schemas/PublicKnowledgeUrlRequest", "url": "/openapi.json#/components/schemas/PublicKnowledgeUrlRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "url": { "type": "string", "title": "Url" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" } }, "type": "object", "required": [ "brand_id", "url" ], "title": "PublicKnowledgeUrlRequest" } }, { "id": "api:schema:PublicPortalClient", "surface": "api", "heading": "API response or request schema: PublicPortalClient", "route": "/openapi.json", "anchor": "/components/schemas/PublicPortalClient", "url": "/openapi.json#/components/schemas/PublicPortalClient", "contract": { "properties": { "id": { "type": "string", "title": "Id" }, "email": { "type": "string", "title": "Email" }, "brand_id": { "type": "string", "title": "Brand Id" }, "brand_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Brand Name" }, "client_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Name" }, "status": { "type": "string", "title": "Status" }, "can_export": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Can Export" }, "receives_weekly_reports": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Receives Weekly Reports" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "accepted_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accepted At" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "last_active_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Active At" }, "invite_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Invite Url" }, "email_sent": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Email Sent" } }, "type": "object", "required": [ "id", "email", "brand_id", "status" ], "title": "PublicPortalClient" } }, { "id": "api:schema:PublisherDiscoveryResponse", "surface": "api", "heading": "API response or request schema: PublisherDiscoveryResponse", "route": "/openapi.json", "anchor": "/components/schemas/PublisherDiscoveryResponse", "url": "/openapi.json#/components/schemas/PublisherDiscoveryResponse", "contract": { "properties": { "research_id": { "type": "string", "title": "Research Id" }, "topic": { "type": "string", "title": "Topic" }, "prompt_ids": { "items": { "type": "string" }, "type": "array", "title": "Prompt Ids" }, "candidates": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Candidates" }, "generated_at": { "type": "string", "title": "Generated At" }, "data_status": { "type": "string", "title": "Data Status" }, "cached": { "type": "boolean", "title": "Cached" }, "limitations": { "items": { "type": "string" }, "type": "array", "title": "Limitations" }, "limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Limit" }, "daily_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Daily Limit" }, "next_step": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Step" } }, "additionalProperties": true, "type": "object", "required": [ "research_id", "topic", "generated_at", "data_status", "cached" ], "title": "PublisherDiscoveryResponse" } }, { "id": "api:schema:PublisherShortlistResponse", "surface": "api", "heading": "API response or request schema: PublisherShortlistResponse", "route": "/openapi.json", "anchor": "/components/schemas/PublisherShortlistResponse", "url": "/openapi.json#/components/schemas/PublisherShortlistResponse", "contract": { "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain" }, "shortlist": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Shortlist" }, "counts": { "anyOf": [ { "additionalProperties": { "type": "integer" }, "type": "object" }, { "type": "null" } ], "title": "Counts" }, "already_on_shortlist": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Already On Shortlist" }, "placement_plan_saved": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Placement Plan Saved" }, "removed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Removed" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note" } }, "additionalProperties": true, "type": "object", "title": "PublisherShortlistResponse" } }, { "id": "api:schema:RankedBrand", "surface": "api", "heading": "API response or request schema: RankedBrand", "route": "/openapi.json", "anchor": "/components/schemas/RankedBrand", "url": "/openapi.json#/components/schemas/RankedBrand", "contract": { "properties": { "rank": { "type": "integer", "title": "Rank" }, "name": { "type": "string", "title": "Name" }, "visibility": { "type": "number", "title": "Visibility" }, "visibility_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Visibility Change" }, "is_you": { "type": "boolean", "title": "Is You", "default": false }, "h2h_win_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "H2H Win Rate" } }, "type": "object", "required": [ "rank", "name", "visibility" ], "title": "RankedBrand" } }, { "id": "api:schema:RankingsByPromptResponse", "surface": "api", "heading": "API response or request schema: RankingsByPromptResponse", "route": "/openapi.json", "anchor": "/components/schemas/RankingsByPromptResponse", "url": "/openapi.json#/components/schemas/RankingsByPromptResponse", "contract": { "properties": { "brand": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Brand" }, "prompts": { "items": { "$ref": "#/components/schemas/PromptRanking" }, "type": "array", "title": "Prompts" } }, "type": "object", "required": [ "brand", "prompts" ], "title": "RankingsByPromptResponse" } }, { "id": "api:schema:RankingsOverallResponse", "surface": "api", "heading": "API response or request schema: RankingsOverallResponse", "route": "/openapi.json", "anchor": "/components/schemas/RankingsOverallResponse", "url": "/openapi.json#/components/schemas/RankingsOverallResponse", "contract": { "properties": { "period": { "anyOf": [ { "$ref": "#/components/schemas/PeriodMeta" }, { "type": "null" } ] }, "brand": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Brand" }, "your_rank": { "type": "integer", "title": "Your Rank" }, "total_competitors": { "type": "integer", "title": "Total Competitors" }, "your_visibility": { "type": "number", "title": "Your Visibility" }, "your_visibility_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Your Visibility Change" }, "your_visibility_avg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Your Visibility Avg" }, "your_visibility_avg_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Your Visibility Avg Change" }, "your_rank_by_avg": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Your Rank By Avg" }, "rankings_by_avg": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RankedBrand" }, "type": "array" }, { "type": "null" } ], "title": "Rankings By Avg" }, "win_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Win Rate" }, "threat_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Threat Count" }, "rankings": { "items": { "$ref": "#/components/schemas/RankedBrand" }, "type": "array", "title": "Rankings" }, "days_requested": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Days Requested" }, "days_effective": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Days Effective" }, "window_note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Window Note" } }, "type": "object", "required": [ "brand", "your_rank", "total_competitors", "your_visibility", "rankings" ], "title": "RankingsOverallResponse" } }, { "id": "api:schema:RankingsPromptTrendsResponse", "surface": "api", "heading": "API response or request schema: RankingsPromptTrendsResponse", "route": "/openapi.json", "anchor": "/components/schemas/RankingsPromptTrendsResponse", "url": "/openapi.json#/components/schemas/RankingsPromptTrendsResponse", "contract": { "properties": { "brand": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Brand" }, "prompts": { "items": { "$ref": "#/components/schemas/PromptPositionSeries" }, "type": "array", "title": "Prompts" }, "period_days": { "type": "integer", "title": "Period Days" }, "total_prompts_with_trends": { "type": "integer", "title": "Total Prompts With Trends" }, "tag_ids": { "items": { "type": "string" }, "type": "array", "title": "Tag Ids", "default": [] }, "data_through": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Data Through" }, "note": { "type": "string", "title": "Note", "default": "position is average rank in the answer: lower is better, and a positive position_change means the brand slipped." } }, "type": "object", "required": [ "brand", "prompts", "period_days", "total_prompts_with_trends" ], "title": "RankingsPromptTrendsResponse" } }, { "id": "api:schema:RedditMutationResponse", "surface": "api", "heading": "API response or request schema: RedditMutationResponse", "route": "/openapi.json", "anchor": "/components/schemas/RedditMutationResponse", "url": "/openapi.json#/components/schemas/RedditMutationResponse", "contract": { "properties": { "success": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Success" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Job Id" } }, "additionalProperties": true, "type": "object", "title": "RedditMutationResponse" } }, { "id": "api:schema:RedditOpportunityDismissRequest", "surface": "api", "heading": "API response or request schema: RedditOpportunityDismissRequest", "route": "/openapi.json", "anchor": "/components/schemas/RedditOpportunityDismissRequest", "url": "/openapi.json#/components/schemas/RedditOpportunityDismissRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "is_dismissed": { "type": "boolean", "title": "Is Dismissed", "default": true } }, "type": "object", "required": [ "brand_id" ], "title": "RedditOpportunityDismissRequest" } }, { "id": "api:schema:RedditOpportunityRespondRequest", "surface": "api", "heading": "API response or request schema: RedditOpportunityRespondRequest", "route": "/openapi.json", "anchor": "/components/schemas/RedditOpportunityRespondRequest", "url": "/openapi.json#/components/schemas/RedditOpportunityRespondRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" } }, "type": "object", "required": [ "brand_id" ], "title": "RedditOpportunityRespondRequest" } }, { "id": "api:schema:RedditPublicResponse", "surface": "api", "heading": "API response or request schema: RedditPublicResponse", "route": "/openapi.json", "anchor": "/components/schemas/RedditPublicResponse", "url": "/openapi.json#/components/schemas/RedditPublicResponse", "contract": { "properties": { "brand_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Brand Id" }, "items": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Items" }, "subreddits": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Subreddits" }, "triggers": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Triggers" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total" }, "has_more": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Has More" } }, "additionalProperties": true, "type": "object", "title": "RedditPublicResponse" } }, { "id": "api:schema:RedditScanRequest", "surface": "api", "heading": "API response or request schema: RedditScanRequest", "route": "/openapi.json", "anchor": "/components/schemas/RedditScanRequest", "url": "/openapi.json#/components/schemas/RedditScanRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "max_threads": { "type": "integer", "maximum": 120.0, "minimum": 10.0, "title": "Max Threads", "default": 40 } }, "type": "object", "required": [ "brand_id" ], "title": "RedditScanRequest" } }, { "id": "api:schema:RedditSubredditAddRequest", "surface": "api", "heading": "API response or request schema: RedditSubredditAddRequest", "route": "/openapi.json", "anchor": "/components/schemas/RedditSubredditAddRequest", "url": "/openapi.json#/components/schemas/RedditSubredditAddRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "subreddit_name": { "type": "string", "maxLength": 60, "minLength": 1, "title": "Subreddit Name" } }, "type": "object", "required": [ "brand_id", "subreddit_name" ], "title": "RedditSubredditAddRequest" } }, { "id": "api:schema:RedditTriggerAddRequest", "surface": "api", "heading": "API response or request schema: RedditTriggerAddRequest", "route": "/openapi.json", "anchor": "/components/schemas/RedditTriggerAddRequest", "url": "/openapi.json#/components/schemas/RedditTriggerAddRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "keyword": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Keyword" } }, "type": "object", "required": [ "brand_id", "keyword" ], "title": "RedditTriggerAddRequest" } }, { "id": "api:schema:ReportCompareRequest", "surface": "api", "heading": "API response or request schema: ReportCompareRequest", "route": "/openapi.json", "anchor": "/components/schemas/ReportCompareRequest", "url": "/openapi.json#/components/schemas/ReportCompareRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "baseline": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Baseline" }, "comparison": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Comparison" } }, "type": "object", "required": [ "brand_id", "baseline", "comparison" ], "title": "ReportCompareRequest" } }, { "id": "api:schema:ReportCompareResponse", "surface": "api", "heading": "API response or request schema: ReportCompareResponse", "route": "/openapi.json", "anchor": "/components/schemas/ReportCompareResponse", "url": "/openapi.json#/components/schemas/ReportCompareResponse", "contract": { "properties": { "baseline": { "$ref": "#/components/schemas/ReportPeriodMetrics" }, "comparison": { "$ref": "#/components/schemas/ReportPeriodMetrics" }, "deltas": { "$ref": "#/components/schemas/ReportDeltas" }, "drivers": { "items": { "$ref": "#/components/schemas/ReportPromptChange" }, "type": "array", "title": "Drivers" }, "drops": { "items": { "$ref": "#/components/schemas/ReportPromptChange" }, "type": "array", "title": "Drops" } }, "type": "object", "required": [ "baseline", "comparison", "deltas", "drivers", "drops" ], "title": "ReportCompareResponse" } }, { "id": "api:schema:ReportDelta", "surface": "api", "heading": "API response or request schema: ReportDelta", "route": "/openapi.json", "anchor": "/components/schemas/ReportDelta", "url": "/openapi.json#/components/schemas/ReportDelta", "contract": { "properties": { "value": { "type": "number", "title": "Value" }, "percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Percent" }, "improved": { "type": "boolean", "title": "Improved" } }, "type": "object", "required": [ "value", "improved" ], "title": "ReportDelta" } }, { "id": "api:schema:ReportDeltas", "surface": "api", "heading": "API response or request schema: ReportDeltas", "route": "/openapi.json", "anchor": "/components/schemas/ReportDeltas", "url": "/openapi.json#/components/schemas/ReportDeltas", "contract": { "properties": { "visibility": { "$ref": "#/components/schemas/ReportDelta" }, "presence": { "$ref": "#/components/schemas/ReportDelta" }, "average_rank": { "anyOf": [ { "$ref": "#/components/schemas/ReportDelta" }, { "type": "null" } ] } }, "type": "object", "required": [ "visibility", "presence" ], "title": "ReportDeltas" } }, { "id": "api:schema:ReportDetailPublic", "surface": "api", "heading": "API response or request schema: ReportDetailPublic", "route": "/openapi.json", "anchor": "/components/schemas/ReportDetailPublic", "url": "/openapi.json#/components/schemas/ReportDetailPublic", "contract": { "properties": { "id": { "type": "string", "title": "Id" }, "brand_id": { "type": "string", "title": "Brand Id" }, "report_type": { "type": "string", "title": "Report Type" }, "report_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Report Name" }, "time_range": { "type": "string", "title": "Time Range", "default": "7d" }, "status": { "type": "string", "title": "Status", "default": "pending" }, "file_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Url" }, "file_size_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "File Size Bytes" }, "page_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Page Count" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "created_at": { "type": "string", "title": "Created At" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "report_data": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Report Data" } }, "type": "object", "required": [ "id", "brand_id", "report_type", "created_at" ], "title": "ReportDetailPublic" } }, { "id": "api:schema:ReportMentionsResponse", "surface": "api", "heading": "API response or request schema: ReportMentionsResponse", "route": "/openapi.json", "anchor": "/components/schemas/ReportMentionsResponse", "url": "/openapi.json#/components/schemas/ReportMentionsResponse", "contract": { "properties": { "brand": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Brand" }, "time_series": { "items": { "$ref": "#/components/schemas/MentionsTimeSeriesPoint" }, "type": "array", "title": "Time Series" }, "period_days": { "type": "integer", "title": "Period Days" } }, "type": "object", "required": [ "brand", "time_series", "period_days" ], "title": "ReportMentionsResponse" } }, { "id": "api:schema:ReportModelScore", "surface": "api", "heading": "API response or request schema: ReportModelScore", "route": "/openapi.json", "anchor": "/components/schemas/ReportModelScore", "url": "/openapi.json#/components/schemas/ReportModelScore", "contract": { "properties": { "model": { "type": "string", "title": "Model" }, "visibility": { "type": "number", "title": "Visibility" }, "presence": { "type": "number", "title": "Presence" }, "mentions": { "type": "integer", "title": "Mentions", "default": 0 } }, "type": "object", "required": [ "model", "visibility", "presence" ], "title": "ReportModelScore" } }, { "id": "api:schema:ReportPeriodMetrics", "surface": "api", "heading": "API response or request schema: ReportPeriodMetrics", "route": "/openapi.json", "anchor": "/components/schemas/ReportPeriodMetrics", "url": "/openapi.json#/components/schemas/ReportPeriodMetrics", "contract": { "properties": { "visibility": { "type": "number", "title": "Visibility" }, "presence": { "type": "number", "title": "Presence" }, "average_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Rank" }, "report_count": { "type": "integer", "title": "Report Count" }, "date_range": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Date Range" } }, "type": "object", "required": [ "visibility", "presence", "report_count", "date_range" ], "title": "ReportPeriodMetrics" } }, { "id": "api:schema:ReportPromptChange", "surface": "api", "heading": "API response or request schema: ReportPromptChange", "route": "/openapi.json", "anchor": "/components/schemas/ReportPromptChange", "url": "/openapi.json#/components/schemas/ReportPromptChange", "contract": { "properties": { "prompt_text": { "type": "string", "title": "Prompt Text" }, "change": { "type": "number", "title": "Change" } }, "type": "object", "required": [ "prompt_text", "change" ], "title": "ReportPromptChange" } }, { "id": "api:schema:ReportPromptScore", "surface": "api", "heading": "API response or request schema: ReportPromptScore", "route": "/openapi.json", "anchor": "/components/schemas/ReportPromptScore", "url": "/openapi.json#/components/schemas/ReportPromptScore", "contract": { "properties": { "prompt_text": { "type": "string", "title": "Prompt Text" }, "visibility": { "type": "number", "title": "Visibility" }, "presence": { "type": "number", "title": "Presence" }, "average_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Rank" } }, "type": "object", "required": [ "prompt_text", "visibility", "presence" ], "title": "ReportPromptScore" } }, { "id": "api:schema:ReportPublicItem", "surface": "api", "heading": "API response or request schema: ReportPublicItem", "route": "/openapi.json", "anchor": "/components/schemas/ReportPublicItem", "url": "/openapi.json#/components/schemas/ReportPublicItem", "contract": { "properties": { "id": { "type": "string", "title": "Id" }, "brand_id": { "type": "string", "title": "Brand Id" }, "report_type": { "type": "string", "title": "Report Type" }, "report_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Report Name" }, "time_range": { "type": "string", "title": "Time Range", "default": "7d" }, "status": { "type": "string", "title": "Status", "default": "pending" }, "file_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Url" }, "file_size_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "File Size Bytes" }, "page_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Page Count" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "created_at": { "type": "string", "title": "Created At" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expires At" } }, "type": "object", "required": [ "id", "brand_id", "report_type", "created_at" ], "title": "ReportPublicItem" } }, { "id": "api:schema:ReportResultsResponse", "surface": "api", "heading": "API response or request schema: ReportResultsResponse", "route": "/openapi.json", "anchor": "/components/schemas/ReportResultsResponse", "url": "/openapi.json#/components/schemas/ReportResultsResponse", "contract": { "properties": { "report_id": { "type": "string", "title": "Report Id" }, "brand_id": { "type": "string", "title": "Brand Id" }, "date": { "type": "string", "title": "Date" }, "visibility": { "type": "number", "title": "Visibility" }, "presence": { "type": "number", "title": "Presence" }, "average_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Rank" }, "model_scores": { "items": { "$ref": "#/components/schemas/ReportModelScore" }, "type": "array", "title": "Model Scores" }, "prompt_scores": { "items": { "$ref": "#/components/schemas/ReportPromptScore" }, "type": "array", "title": "Prompt Scores" } }, "type": "object", "required": [ "report_id", "brand_id", "date", "visibility", "presence", "model_scores", "prompt_scores" ], "title": "ReportResultsResponse" } }, { "id": "api:schema:ReportSentimentResponse", "surface": "api", "heading": "API response or request schema: ReportSentimentResponse", "route": "/openapi.json", "anchor": "/components/schemas/ReportSentimentResponse", "url": "/openapi.json#/components/schemas/ReportSentimentResponse", "contract": { "properties": { "brand": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Brand" }, "distribution": { "$ref": "#/components/schemas/SentimentDistribution" }, "trend": { "items": { "$ref": "#/components/schemas/SentimentTrendPoint" }, "type": "array", "title": "Trend" }, "period_days": { "type": "integer", "title": "Period Days" } }, "type": "object", "required": [ "brand", "distribution", "trend", "period_days" ], "title": "ReportSentimentResponse" } }, { "id": "api:schema:ReportSinglePublicResponse", "surface": "api", "heading": "API response or request schema: ReportSinglePublicResponse", "route": "/openapi.json", "anchor": "/components/schemas/ReportSinglePublicResponse", "url": "/openapi.json#/components/schemas/ReportSinglePublicResponse", "contract": { "properties": { "report": { "$ref": "#/components/schemas/ReportDetailPublic" } }, "type": "object", "required": [ "report" ], "title": "ReportSinglePublicResponse" } }, { "id": "api:schema:ReportsListPublicResponse", "surface": "api", "heading": "API response or request schema: ReportsListPublicResponse", "route": "/openapi.json", "anchor": "/components/schemas/ReportsListPublicResponse", "url": "/openapi.json#/components/schemas/ReportsListPublicResponse", "contract": { "properties": { "reports": { "items": { "$ref": "#/components/schemas/ReportPublicItem" }, "type": "array", "title": "Reports" }, "pagination": { "$ref": "#/components/schemas/PaginationInfo" } }, "type": "object", "required": [ "reports", "pagination" ], "title": "ReportsListPublicResponse" } }, { "id": "api:schema:RerunPromptRequest", "surface": "api", "heading": "API response or request schema: RerunPromptRequest", "route": "/openapi.json", "anchor": "/components/schemas/RerunPromptRequest", "url": "/openapi.json#/components/schemas/RerunPromptRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "prompt_id": { "type": "string", "format": "uuid", "title": "Prompt Id" } }, "type": "object", "required": [ "brand_id", "prompt_id" ], "title": "RerunPromptRequest" } }, { "id": "api:schema:RerunPromptResponse", "surface": "api", "heading": "API response or request schema: RerunPromptResponse", "route": "/openapi.json", "anchor": "/components/schemas/RerunPromptResponse", "url": "/openapi.json#/components/schemas/RerunPromptResponse", "contract": { "properties": { "queued": { "type": "boolean", "title": "Queued" }, "prompt_id": { "type": "string", "title": "Prompt Id" }, "message": { "type": "string", "title": "Message" } }, "type": "object", "required": [ "queued", "prompt_id", "message" ], "title": "RerunPromptResponse" } }, { "id": "api:schema:ResearchRunDetailResponse", "surface": "api", "heading": "API response or request schema: ResearchRunDetailResponse", "route": "/openapi.json", "anchor": "/components/schemas/ResearchRunDetailResponse", "url": "/openapi.json#/components/schemas/ResearchRunDetailResponse", "contract": { "properties": { "id": { "type": "string", "title": "Id" }, "brand_id": { "type": "string", "title": "Brand Id" }, "created_at": { "type": "string", "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "ready": { "type": "boolean", "title": "Ready", "default": false }, "report_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Report Type" }, "topic": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Topic" }, "topic_context": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Topic Context" }, "primary_brand_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primary Brand Name" }, "competitors": { "items": { "type": "string" }, "type": "array", "title": "Competitors" }, "summary": { "additionalProperties": true, "type": "object", "title": "Summary" }, "visibility": { "additionalProperties": true, "type": "object", "title": "Visibility" }, "position_distribution": { "additionalProperties": true, "type": "object", "title": "Position Distribution" }, "competitors_breakdown": { "additionalProperties": true, "type": "object", "title": "Competitors Breakdown" }, "intent_breakdown": { "additionalProperties": true, "type": "object", "title": "Intent Breakdown" }, "focus_area_breakdown": { "additionalProperties": true, "type": "object", "title": "Focus Area Breakdown" }, "topic_breakdown": { "additionalProperties": true, "type": "object", "title": "Topic Breakdown" }, "insights": { "additionalProperties": true, "type": "object", "title": "Insights" }, "market": { "additionalProperties": true, "type": "object", "title": "Market" }, "results": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Results" }, "results_truncated": { "type": "boolean", "title": "Results Truncated", "default": false }, "total_results": { "type": "integer", "title": "Total Results", "default": 0 } }, "type": "object", "required": [ "id", "brand_id", "created_at" ], "title": "ResearchRunDetailResponse" } }, { "id": "api:schema:ResearchRunListItem", "surface": "api", "heading": "API response or request schema: ResearchRunListItem", "route": "/openapi.json", "anchor": "/components/schemas/ResearchRunListItem", "url": "/openapi.json#/components/schemas/ResearchRunListItem", "contract": { "properties": { "id": { "type": "string", "title": "Id" }, "brand_id": { "type": "string", "title": "Brand Id" }, "created_at": { "type": "string", "title": "Created At" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "ready": { "type": "boolean", "title": "Ready", "default": false }, "report_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Report Type" }, "topic": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Topic" }, "topic_context": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Topic Context" }, "total_prompts": { "type": "integer", "title": "Total Prompts", "default": 0 }, "model_used": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Used" }, "duration_seconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Duration Seconds" }, "visibility_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Visibility Score" }, "brand_mention_count": { "type": "integer", "title": "Brand Mention Count", "default": 0 }, "brand_mention_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Brand Mention Rate" }, "avg_brand_position": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Avg Brand Position" }, "top_position": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Top Position" }, "win_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Win Rate" }, "top_3_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Top 3 Rate" }, "share_of_voice": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Share Of Voice" }, "brand_rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Brand Rank" }, "top_competitors": { "items": { "type": "string" }, "type": "array", "title": "Top Competitors" }, "market": { "additionalProperties": true, "type": "object", "title": "Market" } }, "type": "object", "required": [ "id", "brand_id", "created_at" ], "title": "ResearchRunListItem" } }, { "id": "api:schema:ResearchRunsListResponse", "surface": "api", "heading": "API response or request schema: ResearchRunsListResponse", "route": "/openapi.json", "anchor": "/components/schemas/ResearchRunsListResponse", "url": "/openapi.json#/components/schemas/ResearchRunsListResponse", "contract": { "properties": { "runs": { "items": { "$ref": "#/components/schemas/ResearchRunListItem" }, "type": "array", "title": "Runs" }, "total": { "type": "integer", "title": "Total" }, "limit": { "type": "integer", "title": "Limit" }, "offset": { "type": "integer", "title": "Offset" } }, "type": "object", "required": [ "runs", "total", "limit", "offset" ], "title": "ResearchRunsListResponse" } }, { "id": "api:schema:ResearchSnapshotCreditsResponse", "surface": "api", "heading": "API response or request schema: ResearchSnapshotCreditsResponse", "route": "/openapi.json", "anchor": "/components/schemas/ResearchSnapshotCreditsResponse", "url": "/openapi.json#/components/schemas/ResearchSnapshotCreditsResponse", "contract": { "properties": { "used": { "type": "integer", "title": "Used" }, "limit": { "type": "integer", "title": "Limit" }, "remaining": { "type": "integer", "title": "Remaining" }, "plan": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Plan" } }, "type": "object", "required": [ "used", "limit", "remaining" ], "title": "ResearchSnapshotCreditsResponse" } }, { "id": "api:schema:ResultPublicItem", "surface": "api", "heading": "API response or request schema: ResultPublicItem", "route": "/openapi.json", "anchor": "/components/schemas/ResultPublicItem", "url": "/openapi.json#/components/schemas/ResultPublicItem", "contract": { "properties": { "id": { "type": "string", "title": "Id" }, "action_id": { "type": "string", "title": "Action Id" }, "verdict": { "type": "string", "title": "Verdict" }, "family": { "type": "string", "title": "Family" }, "summary": { "type": "string", "title": "Summary" }, "primary_metric": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Primary Metric" }, "window_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Window Days" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "measured_at": { "type": "string", "title": "Measured At" }, "rolled_back": { "type": "boolean", "title": "Rolled Back", "default": false }, "page_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Url" } }, "type": "object", "required": [ "id", "action_id", "verdict", "family", "summary", "measured_at" ], "title": "ResultPublicItem" } }, { "id": "api:schema:ResultsResponse", "surface": "api", "heading": "API response or request schema: ResultsResponse", "route": "/openapi.json", "anchor": "/components/schemas/ResultsResponse", "url": "/openapi.json#/components/schemas/ResultsResponse", "contract": { "properties": { "results": { "items": { "$ref": "#/components/schemas/ResultPublicItem" }, "type": "array", "title": "Results" }, "meta": { "$ref": "#/components/schemas/UnityListMeta" }, "verdict_counts": { "additionalProperties": { "type": "integer" }, "type": "object", "title": "Verdict Counts" } }, "type": "object", "required": [ "results", "meta", "verdict_counts" ], "title": "ResultsResponse" } }, { "id": "api:schema:RunSnapshotPublicRequest", "surface": "api", "heading": "API response or request schema: RunSnapshotPublicRequest", "route": "/openapi.json", "anchor": "/components/schemas/RunSnapshotPublicRequest", "url": "/openapi.json#/components/schemas/RunSnapshotPublicRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "topic": { "type": "string", "maxLength": 200, "minLength": 2, "title": "Topic" }, "topic_context": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Topic Context" } }, "type": "object", "required": [ "brand_id", "topic" ], "title": "RunSnapshotPublicRequest" } }, { "id": "api:schema:RunSnapshotPublicResponse", "surface": "api", "heading": "API response or request schema: RunSnapshotPublicResponse", "route": "/openapi.json", "anchor": "/components/schemas/RunSnapshotPublicResponse", "url": "/openapi.json#/components/schemas/RunSnapshotPublicResponse", "contract": { "properties": { "success": { "type": "boolean", "title": "Success" }, "message": { "type": "string", "title": "Message" }, "placeholder_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Placeholder Id" }, "remaining": { "type": "integer", "title": "Remaining" }, "limit": { "type": "integer", "title": "Limit" } }, "type": "object", "required": [ "success", "message", "remaining", "limit" ], "title": "RunSnapshotPublicResponse" } }, { "id": "api:schema:ScoresResponse", "surface": "api", "heading": "API response or request schema: ScoresResponse", "route": "/openapi.json", "anchor": "/components/schemas/ScoresResponse", "url": "/openapi.json#/components/schemas/ScoresResponse", "contract": { "properties": { "period": { "anyOf": [ { "$ref": "#/components/schemas/PeriodMeta" }, { "type": "null" } ] }, "brand": { "additionalProperties": true, "type": "object", "title": "Brand" }, "latest_scores": { "$ref": "#/components/schemas/LatestScores" }, "trend": { "$ref": "#/components/schemas/TrendInfo" }, "historical": { "items": { "$ref": "#/components/schemas/HistoricalPoint" }, "type": "array", "title": "Historical" }, "filters_applied": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Filters Applied" } }, "type": "object", "required": [ "brand", "latest_scores", "trend", "historical" ], "title": "ScoresResponse" } }, { "id": "api:schema:SentimentDistribution", "surface": "api", "heading": "API response or request schema: SentimentDistribution", "route": "/openapi.json", "anchor": "/components/schemas/SentimentDistribution", "url": "/openapi.json#/components/schemas/SentimentDistribution", "contract": { "properties": { "positive": { "type": "integer", "title": "Positive", "default": 0 }, "neutral": { "type": "integer", "title": "Neutral", "default": 0 }, "negative": { "type": "integer", "title": "Negative", "default": 0 }, "mixed": { "type": "integer", "title": "Mixed", "default": 0 } }, "type": "object", "title": "SentimentDistribution" } }, { "id": "api:schema:SentimentTrendPoint", "surface": "api", "heading": "API response or request schema: SentimentTrendPoint", "route": "/openapi.json", "anchor": "/components/schemas/SentimentTrendPoint", "url": "/openapi.json#/components/schemas/SentimentTrendPoint", "contract": { "properties": { "date": { "type": "string", "title": "Date" }, "avg_sentiment": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Avg Sentiment" } }, "type": "object", "required": [ "date" ], "title": "SentimentTrendPoint" } }, { "id": "api:schema:SetConversionRequest", "surface": "api", "heading": "API response or request schema: SetConversionRequest", "route": "/openapi.json", "anchor": "/components/schemas/SetConversionRequest", "url": "/openapi.json#/components/schemas/SetConversionRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "event_name": { "type": "string", "title": "Event Name" }, "value_per_conversion": { "type": "number", "title": "Value Per Conversion" } }, "type": "object", "required": [ "brand_id", "event_name", "value_per_conversion" ], "title": "SetConversionRequest" } }, { "id": "api:schema:SourceTypeStats", "surface": "api", "heading": "API response or request schema: SourceTypeStats", "route": "/openapi.json", "anchor": "/components/schemas/SourceTypeStats", "url": "/openapi.json#/components/schemas/SourceTypeStats", "contract": { "properties": { "source_type": { "type": "string", "title": "Source Type" }, "count": { "type": "integer", "title": "Count" }, "percentage": { "type": "number", "title": "Percentage" } }, "type": "object", "required": [ "source_type", "count", "percentage" ], "title": "SourceTypeStats" } }, { "id": "api:schema:SuggestPromptsApiRequest", "surface": "api", "heading": "API response or request schema: SuggestPromptsApiRequest", "route": "/openapi.json", "anchor": "/components/schemas/SuggestPromptsApiRequest", "url": "/openapi.json#/components/schemas/SuggestPromptsApiRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "focus": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ], "title": "Focus" }, "limit": { "type": "integer", "maximum": 10.0, "minimum": 1.0, "title": "Limit", "default": 8 }, "exclude_tracked": { "type": "boolean", "title": "Exclude Tracked", "default": true } }, "type": "object", "required": [ "brand_id" ], "title": "SuggestPromptsApiRequest" } }, { "id": "api:schema:SuggestPromptsApiResponse", "surface": "api", "heading": "API response or request schema: SuggestPromptsApiResponse", "route": "/openapi.json", "anchor": "/components/schemas/SuggestPromptsApiResponse", "url": "/openapi.json#/components/schemas/SuggestPromptsApiResponse", "contract": { "properties": { "brand_id": { "type": "string", "title": "Brand Id" }, "brand": { "type": "string", "title": "Brand" }, "focus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Focus" }, "language": { "type": "string", "title": "Language" }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location" }, "count": { "type": "integer", "title": "Count" }, "suggestions": { "items": { "type": "string" }, "type": "array", "title": "Suggestions" }, "excluded_as_tracked": { "type": "integer", "title": "Excluded As Tracked" }, "note": { "type": "string", "title": "Note" } }, "type": "object", "required": [ "brand_id", "brand", "language", "count", "suggestions", "excluded_as_tracked", "note" ], "title": "SuggestPromptsApiResponse" } }, { "id": "api:schema:SuggestedAction", "surface": "api", "heading": "API response or request schema: SuggestedAction", "route": "/openapi.json", "anchor": "/components/schemas/SuggestedAction", "url": "/openapi.json#/components/schemas/SuggestedAction", "contract": { "properties": { "opportunity_id": { "type": "string", "title": "Opportunity Id" }, "title": { "type": "string", "title": "Title" }, "status": { "type": "string", "title": "Status" }, "family": { "type": "string", "title": "Family" }, "action_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action Type" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Detail" }, "first_step": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First Step" }, "impact": { "type": "string", "title": "Impact" }, "effort": { "type": "string", "title": "Effort" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "deep_link": { "type": "string", "title": "Deep Link" } }, "type": "object", "required": [ "opportunity_id", "title", "status", "family", "impact", "effort", "deep_link" ], "title": "SuggestedAction" } }, { "id": "api:schema:TagItem", "surface": "api", "heading": "API response or request schema: TagItem", "route": "/openapi.json", "anchor": "/components/schemas/TagItem", "url": "/openapi.json#/components/schemas/TagItem", "contract": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "colour": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Colour" } }, "type": "object", "required": [ "id", "name" ], "title": "TagItem" } }, { "id": "api:schema:TagListItem", "surface": "api", "heading": "API response or request schema: TagListItem", "route": "/openapi.json", "anchor": "/components/schemas/TagListItem", "url": "/openapi.json#/components/schemas/TagListItem", "contract": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "colour": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Colour" }, "prompt_count": { "type": "integer", "title": "Prompt Count", "default": 0 } }, "type": "object", "required": [ "id", "name" ], "title": "TagListItem" } }, { "id": "api:schema:TagsListResponse", "surface": "api", "heading": "API response or request schema: TagsListResponse", "route": "/openapi.json", "anchor": "/components/schemas/TagsListResponse", "url": "/openapi.json#/components/schemas/TagsListResponse", "contract": { "properties": { "tags": { "items": { "$ref": "#/components/schemas/TagListItem" }, "type": "array", "title": "Tags" }, "total": { "type": "integer", "title": "Total" } }, "type": "object", "required": [ "tags", "total" ], "title": "TagsListResponse" } }, { "id": "api:schema:TopSpotOwnership", "surface": "api", "heading": "API response or request schema: TopSpotOwnership", "route": "/openapi.json", "anchor": "/components/schemas/TopSpotOwnership", "url": "/openapi.json#/components/schemas/TopSpotOwnership", "contract": { "properties": { "prompt": { "type": "string", "title": "Prompt" }, "top_brand": { "type": "string", "title": "Top Brand" }, "count": { "type": "integer", "title": "Count" } }, "type": "object", "required": [ "prompt", "top_brand", "count" ], "title": "TopSpotOwnership" } }, { "id": "api:schema:TrackedArticleMutationResponse", "surface": "api", "heading": "API response or request schema: TrackedArticleMutationResponse", "route": "/openapi.json", "anchor": "/components/schemas/TrackedArticleMutationResponse", "url": "/openapi.json#/components/schemas/TrackedArticleMutationResponse", "contract": { "properties": { "action": { "type": "string", "title": "Action" }, "article": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Article" }, "tracking_changed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Tracking Changed" }, "owned_site": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Owned Site" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note" } }, "additionalProperties": true, "type": "object", "required": [ "action" ], "title": "TrackedArticleMutationResponse" } }, { "id": "api:schema:TrackedArticlesResponse", "surface": "api", "heading": "API response or request schema: TrackedArticlesResponse", "route": "/openapi.json", "anchor": "/components/schemas/TrackedArticlesResponse", "url": "/openapi.json#/components/schemas/TrackedArticlesResponse", "contract": { "properties": { "brand_id": { "type": "string", "title": "Brand Id" }, "articles": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Articles" }, "summary": { "additionalProperties": { "type": "integer" }, "type": "object", "title": "Summary" }, "answers_checked_through": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Answers Checked Through" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note" } }, "additionalProperties": true, "type": "object", "required": [ "brand_id" ], "title": "TrackedArticlesResponse" } }, { "id": "api:schema:TrafficConversionMutationResponse", "surface": "api", "heading": "API response or request schema: TrafficConversionMutationResponse", "route": "/openapi.json", "anchor": "/components/schemas/TrafficConversionMutationResponse", "url": "/openapi.json#/components/schemas/TrafficConversionMutationResponse", "contract": { "properties": { "success": { "type": "boolean", "title": "Success" }, "event_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Event Name" }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Value" }, "deleted": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deleted" } }, "additionalProperties": true, "type": "object", "required": [ "success" ], "title": "TrafficConversionMutationResponse" } }, { "id": "api:schema:TrafficDeviceItem", "surface": "api", "heading": "API response or request schema: TrafficDeviceItem", "route": "/openapi.json", "anchor": "/components/schemas/TrafficDeviceItem", "url": "/openapi.json#/components/schemas/TrafficDeviceItem", "contract": { "properties": { "device": { "type": "string", "title": "Device" }, "sessions": { "type": "integer", "title": "Sessions" }, "percentage": { "type": "number", "title": "Percentage" } }, "type": "object", "required": [ "device", "sessions", "percentage" ], "title": "TrafficDeviceItem" } }, { "id": "api:schema:TrafficGeoItem", "surface": "api", "heading": "API response or request schema: TrafficGeoItem", "route": "/openapi.json", "anchor": "/components/schemas/TrafficGeoItem", "url": "/openapi.json#/components/schemas/TrafficGeoItem", "contract": { "properties": { "country": { "type": "string", "title": "Country" }, "sessions": { "type": "integer", "title": "Sessions" } }, "type": "object", "required": [ "country", "sessions" ], "title": "TrafficGeoItem" } }, { "id": "api:schema:TrafficHourlyPoint", "surface": "api", "heading": "API response or request schema: TrafficHourlyPoint", "route": "/openapi.json", "anchor": "/components/schemas/TrafficHourlyPoint", "url": "/openapi.json#/components/schemas/TrafficHourlyPoint", "contract": { "properties": { "hour": { "type": "integer", "title": "Hour" }, "count": { "type": "integer", "title": "Count" } }, "type": "object", "required": [ "hour", "count" ], "title": "TrafficHourlyPoint" } }, { "id": "api:schema:TrafficLandingPage", "surface": "api", "heading": "API response or request schema: TrafficLandingPage", "route": "/openapi.json", "anchor": "/components/schemas/TrafficLandingPage", "url": "/openapi.json#/components/schemas/TrafficLandingPage", "contract": { "properties": { "page": { "type": "string", "title": "Page" }, "sessions": { "type": "integer", "title": "Sessions" }, "engagement_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Engagement Rate" } }, "type": "object", "required": [ "page", "sessions" ], "title": "TrafficLandingPage" } }, { "id": "api:schema:TrafficReportResponse", "surface": "api", "heading": "API response or request schema: TrafficReportResponse", "route": "/openapi.json", "anchor": "/components/schemas/TrafficReportResponse", "url": "/openapi.json#/components/schemas/TrafficReportResponse", "contract": { "properties": { "ai_sessions": { "type": "integer", "title": "Ai Sessions" }, "total_sessions": { "type": "integer", "title": "Total Sessions" }, "ai_percentage": { "type": "number", "title": "Ai Percentage" }, "ai_engagement_rate": { "type": "number", "title": "Ai Engagement Rate" }, "ai_avg_duration": { "type": "number", "title": "Ai Avg Duration" }, "ai_sources": { "items": { "$ref": "#/components/schemas/TrafficSourceItem" }, "type": "array", "title": "Ai Sources" }, "trend_data": { "items": { "$ref": "#/components/schemas/TrafficTrendPoint" }, "type": "array", "title": "Trend Data" }, "top_landing_pages": { "items": { "$ref": "#/components/schemas/TrafficLandingPage" }, "type": "array", "title": "Top Landing Pages" }, "geo_data": { "items": { "$ref": "#/components/schemas/TrafficGeoItem" }, "type": "array", "title": "Geo Data" }, "device_data": { "items": { "$ref": "#/components/schemas/TrafficDeviceItem" }, "type": "array", "title": "Device Data" }, "cached_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cached At" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" } }, "type": "object", "required": [ "ai_sessions", "total_sessions", "ai_percentage", "ai_engagement_rate", "ai_avg_duration", "ai_sources", "trend_data", "top_landing_pages", "geo_data", "device_data" ], "title": "TrafficReportResponse" } }, { "id": "api:schema:TrafficSourceItem", "surface": "api", "heading": "API response or request schema: TrafficSourceItem", "route": "/openapi.json", "anchor": "/components/schemas/TrafficSourceItem", "url": "/openapi.json#/components/schemas/TrafficSourceItem", "contract": { "properties": { "source": { "type": "string", "title": "Source" }, "sessions": { "type": "integer", "title": "Sessions" }, "percentage": { "type": "number", "title": "Percentage" } }, "type": "object", "required": [ "source", "sessions", "percentage" ], "title": "TrafficSourceItem" } }, { "id": "api:schema:TrafficStatusResponse", "surface": "api", "heading": "API response or request schema: TrafficStatusResponse", "route": "/openapi.json", "anchor": "/components/schemas/TrafficStatusResponse", "url": "/openapi.json#/components/schemas/TrafficStatusResponse", "contract": { "properties": { "connected": { "type": "boolean", "title": "Connected" }, "property_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Property Name" }, "last_refreshed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Refreshed" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" } }, "type": "object", "required": [ "connected" ], "title": "TrafficStatusResponse" } }, { "id": "api:schema:TrafficTrendPoint", "surface": "api", "heading": "API response or request schema: TrafficTrendPoint", "route": "/openapi.json", "anchor": "/components/schemas/TrafficTrendPoint", "url": "/openapi.json#/components/schemas/TrafficTrendPoint", "contract": { "properties": { "date": { "type": "string", "title": "Date" }, "ai_sessions": { "type": "integer", "title": "Ai Sessions" }, "total_sessions": { "type": "integer", "title": "Total Sessions" } }, "type": "object", "required": [ "date", "ai_sessions", "total_sessions" ], "title": "TrafficTrendPoint" } }, { "id": "api:schema:TrafficVisitorItem", "surface": "api", "heading": "API response or request schema: TrafficVisitorItem", "route": "/openapi.json", "anchor": "/components/schemas/TrafficVisitorItem", "url": "/openapi.json#/components/schemas/TrafficVisitorItem", "contract": { "properties": { "session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "landing_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Landing Page" }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Timestamp" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" }, "device": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Device" }, "pages_viewed": { "type": "integer", "title": "Pages Viewed", "default": 0 }, "duration_seconds": { "type": "number", "title": "Duration Seconds", "default": 0 } }, "type": "object", "title": "TrafficVisitorItem" } }, { "id": "api:schema:TrafficVisitorsResponse", "surface": "api", "heading": "API response or request schema: TrafficVisitorsResponse", "route": "/openapi.json", "anchor": "/components/schemas/TrafficVisitorsResponse", "url": "/openapi.json#/components/schemas/TrafficVisitorsResponse", "contract": { "properties": { "sessions": { "items": { "$ref": "#/components/schemas/TrafficVisitorItem" }, "type": "array", "title": "Sessions" }, "total_today": { "type": "integer", "title": "Total Today" }, "last_hour": { "type": "integer", "title": "Last Hour" }, "hourly_data": { "items": { "$ref": "#/components/schemas/TrafficHourlyPoint" }, "type": "array", "title": "Hourly Data" } }, "type": "object", "required": [ "sessions", "total_today", "last_hour", "hourly_data" ], "title": "TrafficVisitorsResponse" } }, { "id": "api:schema:TrendInfo", "surface": "api", "heading": "API response or request schema: TrendInfo", "route": "/openapi.json", "anchor": "/components/schemas/TrendInfo", "url": "/openapi.json#/components/schemas/TrendInfo", "contract": { "properties": { "visibility_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Visibility Change" }, "presence_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Presence Change" }, "period_days": { "type": "integer", "title": "Period Days" }, "reports_count": { "type": "integer", "title": "Reports Count", "default": 0 } }, "type": "object", "required": [ "period_days" ], "title": "TrendInfo" } }, { "id": "api:schema:UnityListMeta", "surface": "api", "heading": "API response or request schema: UnityListMeta", "route": "/openapi.json", "anchor": "/components/schemas/UnityListMeta", "url": "/openapi.json#/components/schemas/UnityListMeta", "contract": { "properties": { "total": { "type": "integer", "title": "Total" }, "limit": { "type": "integer", "title": "Limit" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "type": "object", "required": [ "total", "limit" ], "title": "UnityListMeta" } }, { "id": "api:schema:UpdateAliasesApiRequest", "surface": "api", "heading": "API response or request schema: UpdateAliasesApiRequest", "route": "/openapi.json", "anchor": "/components/schemas/UpdateAliasesApiRequest", "url": "/openapi.json#/components/schemas/UpdateAliasesApiRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "aliases": { "items": { "type": "string" }, "type": "array", "title": "Aliases" } }, "type": "object", "required": [ "brand_id", "aliases" ], "title": "UpdateAliasesApiRequest" } }, { "id": "api:schema:UpdateBrandLocationRequest", "surface": "api", "heading": "API response or request schema: UpdateBrandLocationRequest", "route": "/openapi.json", "anchor": "/components/schemas/UpdateBrandLocationRequest", "url": "/openapi.json#/components/schemas/UpdateBrandLocationRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "country": { "type": "string", "title": "Country" }, "location_region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location Region" }, "location_city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location City" }, "location_dataseo_code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Location Dataseo Code" } }, "type": "object", "required": [ "brand_id", "country" ], "title": "UpdateBrandLocationRequest" } }, { "id": "api:schema:UpdateBrandLocationResponse", "surface": "api", "heading": "API response or request schema: UpdateBrandLocationResponse", "route": "/openapi.json", "anchor": "/components/schemas/UpdateBrandLocationResponse", "url": "/openapi.json#/components/schemas/UpdateBrandLocationResponse", "contract": { "properties": { "brand_id": { "type": "string", "title": "Brand Id" }, "location": { "type": "string", "title": "Location" }, "location_region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location Region" }, "location_city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location City" }, "location_dataseo_code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Location Dataseo Code" }, "primary_market": { "anyOf": [ { "$ref": "#/components/schemas/MarketItem" }, { "type": "null" } ] } }, "type": "object", "required": [ "brand_id", "location" ], "title": "UpdateBrandLocationResponse" } }, { "id": "api:schema:UpdatePromptRequest", "surface": "api", "heading": "API response or request schema: UpdatePromptRequest", "route": "/openapi.json", "anchor": "/components/schemas/UpdatePromptRequest", "url": "/openapi.json#/components/schemas/UpdatePromptRequest", "contract": { "properties": { "prompt_id": { "type": "string", "format": "uuid", "title": "Prompt Id" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Text" }, "active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Active" }, "focus_area": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Focus Area" }, "intent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Intent" }, "audience": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Audience" } }, "type": "object", "required": [ "prompt_id" ], "title": "UpdatePromptRequest" } }, { "id": "api:schema:ValidationError", "surface": "api", "heading": "API response or request schema: ValidationError", "route": "/openapi.json", "anchor": "/components/schemas/ValidationError", "url": "/openapi.json#/components/schemas/ValidationError", "contract": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" } }, { "id": "api:schema:VisibilityByModelItem", "surface": "api", "heading": "API response or request schema: VisibilityByModelItem", "route": "/openapi.json", "anchor": "/components/schemas/VisibilityByModelItem", "url": "/openapi.json#/components/schemas/VisibilityByModelItem", "contract": { "properties": { "model": { "type": "string", "title": "Model" }, "visibility": { "type": "number", "title": "Visibility" }, "presence": { "type": "number", "title": "Presence" }, "trend": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Trend" } }, "type": "object", "required": [ "model", "visibility", "presence" ], "title": "VisibilityByModelItem" } }, { "id": "api:schema:VisibilityByModelResponse", "surface": "api", "heading": "API response or request schema: VisibilityByModelResponse", "route": "/openapi.json", "anchor": "/components/schemas/VisibilityByModelResponse", "url": "/openapi.json#/components/schemas/VisibilityByModelResponse", "contract": { "properties": { "period": { "anyOf": [ { "$ref": "#/components/schemas/PeriodMeta" }, { "type": "null" } ] }, "brand": { "additionalProperties": true, "type": "object", "title": "Brand" }, "models": { "items": { "$ref": "#/components/schemas/VisibilityByModelItem" }, "type": "array", "title": "Models" }, "period_days": { "type": "integer", "title": "Period Days" } }, "type": "object", "required": [ "brand", "models", "period_days" ], "title": "VisibilityByModelResponse" } }, { "id": "api:schema:VisibilityByPromptItem", "surface": "api", "heading": "API response or request schema: VisibilityByPromptItem", "route": "/openapi.json", "anchor": "/components/schemas/VisibilityByPromptItem", "url": "/openapi.json#/components/schemas/VisibilityByPromptItem", "contract": { "properties": { "prompt_id": { "type": "string", "title": "Prompt Id" }, "prompt_text": { "type": "string", "title": "Prompt Text" }, "visibility": { "type": "number", "title": "Visibility" }, "presence": { "type": "number", "title": "Presence" }, "average_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Rank" } }, "type": "object", "required": [ "prompt_id", "prompt_text", "visibility", "presence" ], "title": "VisibilityByPromptItem" } }, { "id": "api:schema:VisibilityByPromptResponse", "surface": "api", "heading": "API response or request schema: VisibilityByPromptResponse", "route": "/openapi.json", "anchor": "/components/schemas/VisibilityByPromptResponse", "url": "/openapi.json#/components/schemas/VisibilityByPromptResponse", "contract": { "properties": { "period": { "anyOf": [ { "$ref": "#/components/schemas/PeriodMeta" }, { "type": "null" } ] }, "brand": { "additionalProperties": true, "type": "object", "title": "Brand" }, "prompts": { "items": { "$ref": "#/components/schemas/VisibilityByPromptItem" }, "type": "array", "title": "Prompts" }, "period_days": { "type": "integer", "title": "Period Days" } }, "type": "object", "required": [ "brand", "prompts", "period_days" ], "title": "VisibilityByPromptResponse" } }, { "id": "api:schema:VisibilityTimeSeriesPoint", "surface": "api", "heading": "API response or request schema: VisibilityTimeSeriesPoint", "route": "/openapi.json", "anchor": "/components/schemas/VisibilityTimeSeriesPoint", "url": "/openapi.json#/components/schemas/VisibilityTimeSeriesPoint", "contract": { "properties": { "date": { "type": "string", "title": "Date" }, "visibility": { "type": "number", "title": "Visibility" }, "presence": { "type": "number", "title": "Presence" }, "average_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Rank" }, "mentions": { "type": "integer", "title": "Mentions", "default": 0 }, "models_mentioned": { "type": "integer", "title": "Models Mentioned", "default": 0 } }, "type": "object", "required": [ "date", "visibility", "presence" ], "title": "VisibilityTimeSeriesPoint" } }, { "id": "api:schema:VisibilityTimeSeriesResponse", "surface": "api", "heading": "API response or request schema: VisibilityTimeSeriesResponse", "route": "/openapi.json", "anchor": "/components/schemas/VisibilityTimeSeriesResponse", "url": "/openapi.json#/components/schemas/VisibilityTimeSeriesResponse", "contract": { "properties": { "period": { "anyOf": [ { "$ref": "#/components/schemas/PeriodMeta" }, { "type": "null" } ] }, "brand": { "additionalProperties": true, "type": "object", "title": "Brand" }, "time_series": { "items": { "$ref": "#/components/schemas/VisibilityTimeSeriesPoint" }, "type": "array", "title": "Time Series" }, "period_days": { "type": "integer", "title": "Period Days" } }, "type": "object", "required": [ "brand", "time_series", "period_days" ], "title": "VisibilityTimeSeriesResponse" } }, { "id": "api:schema:WebhookCreateBody", "surface": "api", "heading": "API response or request schema: WebhookCreateBody", "route": "/openapi.json", "anchor": "/components/schemas/WebhookCreateBody", "url": "/openapi.json#/components/schemas/WebhookCreateBody", "contract": { "properties": { "url": { "type": "string", "title": "Url" }, "events": { "items": { "type": "string" }, "type": "array", "title": "Events" }, "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "auth_type": { "anyOf": [ { "type": "string", "enum": [ "none", "bearer", "basic", "api_key" ] }, { "type": "null" } ], "title": "Auth Type", "default": "none" }, "auth_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth Token" }, "auth_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth Username" }, "auth_password": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth Password" }, "api_key_header": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key Header" }, "api_key_value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key Value" }, "signing_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Signing Secret" }, "headers": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Headers" }, "payload_template": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Payload Template" } }, "type": "object", "required": [ "url", "events", "brand_id" ], "title": "WebhookCreateBody" } }, { "id": "api:schema:WebhookListResponse", "surface": "api", "heading": "API response or request schema: WebhookListResponse", "route": "/openapi.json", "anchor": "/components/schemas/WebhookListResponse", "url": "/openapi.json#/components/schemas/WebhookListResponse", "contract": { "properties": { "webhooks": { "items": { "$ref": "#/components/schemas/WebhookPublicResponse" }, "type": "array", "title": "Webhooks" }, "total": { "type": "integer", "title": "Total" } }, "type": "object", "required": [ "webhooks", "total" ], "title": "WebhookListResponse" } }, { "id": "api:schema:WebhookPublicResponse", "surface": "api", "heading": "API response or request schema: WebhookPublicResponse", "route": "/openapi.json", "anchor": "/components/schemas/WebhookPublicResponse", "url": "/openapi.json#/components/schemas/WebhookPublicResponse", "contract": { "properties": { "id": { "type": "string", "title": "Id" }, "object": { "type": "string", "title": "Object", "default": "webhook" }, "url": { "type": "string", "title": "Url" }, "events": { "items": { "type": "string" }, "type": "array", "title": "Events" }, "brand_id": { "type": "string", "title": "Brand Id" }, "provider": { "type": "string", "title": "Provider" }, "active": { "type": "boolean", "title": "Active" }, "signing_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Signing Secret" }, "created_at": { "type": "string", "title": "Created At" } }, "type": "object", "required": [ "id", "url", "events", "brand_id", "provider", "active", "created_at" ], "title": "WebhookPublicResponse" } }, { "id": "api:schema:WebhookTestResponse", "surface": "api", "heading": "API response or request schema: WebhookTestResponse", "route": "/openapi.json", "anchor": "/components/schemas/WebhookTestResponse", "url": "/openapi.json#/components/schemas/WebhookTestResponse", "contract": { "properties": { "success": { "type": "boolean", "title": "Success" }, "status_code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Status Code" }, "response_time_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Response Time Ms" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" } }, "type": "object", "required": [ "success" ], "title": "WebhookTestResponse" } }, { "id": "api:schema:WorkflowFromTemplateRequest", "surface": "api", "heading": "API response or request schema: WorkflowFromTemplateRequest", "route": "/openapi.json", "anchor": "/components/schemas/WorkflowFromTemplateRequest", "url": "/openapi.json#/components/schemas/WorkflowFromTemplateRequest", "contract": { "properties": { "brand_id": { "type": "string", "format": "uuid", "title": "Brand Id" }, "template_id": { "type": "string", "title": "Template Id" }, "name": { "anyOf": [ { "type": "string", "maxLength": 120, "minLength": 1 }, { "type": "null" } ], "title": "Name" } }, "type": "object", "required": [ "brand_id", "template_id" ], "title": "WorkflowFromTemplateRequest" } }, { "id": "api:schema:WorkflowPublicResponse", "surface": "api", "heading": "API response or request schema: WorkflowPublicResponse", "route": "/openapi.json", "anchor": "/components/schemas/WorkflowPublicResponse", "url": "/openapi.json#/components/schemas/WorkflowPublicResponse", "contract": { "properties": { "workflows": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Workflows" }, "runs": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Runs" }, "run": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Run" }, "templates": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Templates" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total" }, "limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Limit" }, "offset": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Offset" }, "success": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Success" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "additionalProperties": true, "type": "object", "title": "WorkflowPublicResponse" } }, { "id": "api:schema:WorkflowStatusPatchRequest", "surface": "api", "heading": "API response or request schema: WorkflowStatusPatchRequest", "route": "/openapi.json", "anchor": "/components/schemas/WorkflowStatusPatchRequest", "url": "/openapi.json#/components/schemas/WorkflowStatusPatchRequest", "contract": { "properties": { "status": { "type": "string", "enum": [ "active", "paused", "deleted" ], "title": "Status" } }, "type": "object", "required": [ "status" ], "title": "WorkflowStatusPatchRequest" } }, { "id": "mcp:authenticated:add_knowledge", "surface": "api", "heading": "Authenticated MCP tool: add_knowledge", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "add_knowledge", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "source_type": { "enum": [ "text", "url" ], "title": "Source Type", "type": "string" }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Content" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" } }, "required": [ "brand_id", "source_type" ], "title": "add_knowledgeArguments", "type": "object" }, "annotations": { "title": "Add Brand Knowledge", "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": true }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "source_type": { "enum": [ "text", "url" ], "title": "Source Type", "type": "string" }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Content" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id", "source_type" ], "title": "add_knowledgeArguments", "type": "object" } } }, { "id": "mcp:authenticated:bulk_manage_prompts", "surface": "api", "heading": "Authenticated MCP tool: bulk_manage_prompts", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "bulk_manage_prompts", "inputSchema": { "properties": { "action": { "enum": [ "bulk_create", "bulk_delete", "activate", "deactivate" ], "title": "Action", "type": "string" }, "brand_id": { "title": "Brand Id", "type": "string" }, "prompts": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Prompts" }, "prompt_ids": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Prompt Ids" } }, "required": [ "action", "brand_id" ], "title": "bulk_manage_promptsArguments", "type": "object" }, "annotations": { "title": "Manage Prompts in Bulk", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": false, "openWorldHint": false }, "hostedInputSchema": { "properties": { "action": { "enum": [ "bulk_create", "bulk_delete", "activate", "deactivate" ], "title": "Action", "type": "string" }, "brand_id": { "title": "Brand Id", "type": "string" }, "prompts": { "anyOf": [ { "type": "string" }, { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Prompts" }, "prompt_ids": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Prompt Ids" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "action", "brand_id" ], "title": "bulk_manage_promptsArguments", "type": "object" } } }, { "id": "mcp:authenticated:commit_opportunity", "surface": "api", "heading": "Authenticated MCP tool: commit_opportunity", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "commit_opportunity", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "opportunity_id": { "title": "Opportunity Id", "type": "string" }, "action": { "default": "commit", "enum": [ "commit", "dismiss", "snooze" ], "title": "Action", "type": "string" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Reason" }, "snooze_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "maximum": 90, "minimum": 1, "title": "Snooze Days" } }, "required": [ "brand_id", "opportunity_id" ], "title": "commit_opportunityArguments", "type": "object" }, "annotations": { "title": "Decide on an Opportunity", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": false, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "opportunity_id": { "title": "Opportunity Id", "type": "string" }, "action": { "default": "commit", "enum": [ "commit", "dismiss", "snooze" ], "title": "Action", "type": "string" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Reason" }, "snooze_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "maximum": 90, "minimum": 1, "title": "Snooze Days" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id", "opportunity_id" ], "title": "commit_opportunityArguments", "type": "object" } } }, { "id": "mcp:authenticated:compare_brands", "surface": "api", "heading": "Authenticated MCP tool: compare_brands", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "compare_brands", "inputSchema": { "properties": { "brand_ids": { "items": { "type": "string" }, "title": "Brand Ids", "type": "array" }, "days": { "default": 30, "maximum": 365, "minimum": 7, "title": "Days", "type": "integer" }, "metrics": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Metrics" } }, "required": [ "brand_ids" ], "title": "compare_brandsArguments", "type": "object" }, "annotations": { "title": "Compare Brands", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_ids": { "items": { "type": "string" }, "title": "Brand Ids", "type": "array" }, "days": { "default": 30, "maximum": 365, "minimum": 7, "title": "Days", "type": "integer" }, "metrics": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Metrics" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_ids" ], "title": "compare_brandsArguments", "type": "object" } } }, { "id": "mcp:authenticated:compare_reports", "surface": "api", "heading": "Authenticated MCP tool: compare_reports", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "compare_reports", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "baseline_start": { "title": "Baseline Start", "type": "string" }, "baseline_end": { "title": "Baseline End", "type": "string" }, "comparison_start": { "title": "Comparison Start", "type": "string" }, "comparison_end": { "title": "Comparison End", "type": "string" } }, "required": [ "brand_id", "baseline_start", "baseline_end", "comparison_start", "comparison_end" ], "title": "compare_reportsArguments", "type": "object" }, "annotations": { "title": "Compare Reports", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "baseline_start": { "title": "Baseline Start", "type": "string" }, "baseline_end": { "title": "Baseline End", "type": "string" }, "comparison_start": { "title": "Comparison Start", "type": "string" }, "comparison_end": { "title": "Comparison End", "type": "string" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id", "baseline_start", "baseline_end", "comparison_start", "comparison_end" ], "title": "compare_reportsArguments", "type": "object" } } }, { "id": "mcp:authenticated:discover_publishers", "surface": "api", "heading": "Authenticated MCP tool: discover_publishers", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "discover_publishers", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "topic": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Topic" }, "prompt_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Prompt Ids" }, "seed_domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Seed Domain" }, "market": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Market" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Language" }, "new_only": { "default": true, "title": "New Only", "type": "boolean" } }, "required": [ "brand_id" ], "title": "discover_publishersArguments", "type": "object" }, "annotations": { "title": "Discover Publishers", "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": true }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "topic": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Topic" }, "prompt_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Prompt Ids" }, "seed_domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Seed Domain" }, "market": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Market" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Language" }, "new_only": { "default": true, "title": "New Only", "type": "boolean" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "discover_publishersArguments", "type": "object" } } }, { "id": "mcp:authenticated:export_data", "surface": "api", "heading": "Authenticated MCP tool: export_data", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "export_data", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "data_type": { "enum": [ "prompts", "results", "citations", "reports", "collection_coverage" ], "title": "Data Type", "type": "string" }, "format": { "default": "json", "enum": [ "json", "csv" ], "title": "Format", "type": "string" }, "days": { "default": 30, "maximum": 365, "minimum": 1, "title": "Days", "type": "integer" }, "limit": { "default": 1000, "maximum": 10000, "minimum": 1, "title": "Limit", "type": "integer" }, "start_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Start Date" }, "end_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "End Date" } }, "required": [ "brand_id", "data_type" ], "title": "export_dataArguments", "type": "object" }, "annotations": { "title": "Export Trakkr Data", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "data_type": { "enum": [ "prompts", "results", "citations", "reports", "collection_coverage" ], "title": "Data Type", "type": "string" }, "format": { "default": "json", "enum": [ "json", "csv" ], "title": "Format", "type": "string" }, "days": { "default": 30, "maximum": 365, "minimum": 1, "title": "Days", "type": "integer" }, "limit": { "default": 1000, "maximum": 10000, "minimum": 1, "title": "Limit", "type": "integer" }, "start_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Start Date" }, "end_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "End Date" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id", "data_type" ], "title": "export_dataArguments", "type": "object" } } }, { "id": "mcp:authenticated:generate_article", "surface": "api", "heading": "Authenticated MCP tool: generate_article", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "generate_article", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "primary_prompt": { "title": "Primary Prompt", "type": "string" }, "secondary_prompts": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Secondary Prompts" }, "word_target": { "default": 2000, "maximum": 6000, "minimum": 300, "title": "Word Target", "type": "integer" }, "template_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Template Id" } }, "required": [ "brand_id", "primary_prompt" ], "title": "generate_articleArguments", "type": "object" }, "annotations": { "title": "Generate an Article", "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "primary_prompt": { "title": "Primary Prompt", "type": "string" }, "secondary_prompts": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Secondary Prompts" }, "word_target": { "default": 2000, "maximum": 6000, "minimum": 300, "title": "Word Target", "type": "integer" }, "template_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Template Id" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id", "primary_prompt" ], "title": "generate_articleArguments", "type": "object" } } }, { "id": "mcp:authenticated:generate_report", "surface": "api", "heading": "Authenticated MCP tool: generate_report", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "generate_report", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "report_type": { "default": "executive", "enum": [ "executive", "weekly", "full" ], "title": "Report Type", "type": "string" }, "time_range": { "default": "7d", "enum": [ "7d", "14d", "30d" ], "title": "Time Range", "type": "string" } }, "required": [ "brand_id" ], "title": "generate_reportArguments", "type": "object" }, "annotations": { "title": "Generate a Report", "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "report_type": { "default": "executive", "enum": [ "executive", "weekly", "full" ], "title": "Report Type", "type": "string" }, "time_range": { "default": "7d", "enum": [ "7d", "14d", "30d" ], "title": "Time Range", "type": "string" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "generate_reportArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_action_stats", "surface": "api", "heading": "Authenticated MCP tool: get_action_stats", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_action_stats", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" } }, "required": [ "brand_id" ], "title": "get_action_statsArguments", "type": "object" }, "annotations": { "title": "Get Action Statistics", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_action_statsArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_actions", "surface": "api", "heading": "Authenticated MCP tool: get_actions", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_actions", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "status": { "default": "open", "enum": [ "open", "active", "pending", "in_progress", "completed", "dismissed", "snoozed", "expired", "superseded" ], "title": "Status", "type": "string" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Category" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Source" }, "action_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action Type" }, "lens": { "anyOf": [ { "enum": [ "crawler", "content", "competitive", "technical", "citation" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Lens" }, "quick_win": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Quick Win" }, "search": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Search" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" }, "sort_by": { "default": "priority_score", "enum": [ "priority_score", "created_at", "updated_at" ], "title": "Sort By", "type": "string" }, "sort_dir": { "default": "desc", "enum": [ "asc", "desc" ], "title": "Sort Dir", "type": "string" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "maximum": 1000000, "minimum": 0, "title": "Offset", "type": "integer" } }, "required": [ "brand_id" ], "title": "get_actionsArguments", "type": "object" }, "annotations": { "title": "Get Actions", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "status": { "default": "open", "enum": [ "open", "active", "pending", "in_progress", "completed", "dismissed", "snoozed", "expired", "superseded" ], "title": "Status", "type": "string" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Category" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Source" }, "action_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action Type" }, "lens": { "anyOf": [ { "enum": [ "crawler", "content", "competitive", "technical", "citation" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Lens" }, "quick_win": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Quick Win" }, "search": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Search" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" }, "sort_by": { "default": "priority_score", "enum": [ "priority_score", "created_at", "updated_at" ], "title": "Sort By", "type": "string" }, "sort_dir": { "default": "desc", "enum": [ "asc", "desc" ], "title": "Sort Dir", "type": "string" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "maximum": 1000000, "minimum": 0, "title": "Offset", "type": "integer" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_actionsArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_articles", "surface": "api", "heading": "Authenticated MCP tool: get_articles", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_articles", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "view": { "default": "list", "enum": [ "list", "detail" ], "title": "View", "type": "string" }, "article_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Article Id" }, "status": { "anyOf": [ { "enum": [ "draft", "review", "ready", "published" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "standalone_only": { "default": false, "title": "Standalone Only", "type": "boolean" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "maximum": 1000000, "minimum": 0, "title": "Offset", "type": "integer" } }, "required": [ "brand_id" ], "title": "get_articlesArguments", "type": "object" }, "annotations": { "title": "Get Articles", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "view": { "default": "list", "enum": [ "list", "detail" ], "title": "View", "type": "string" }, "article_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Article Id" }, "status": { "anyOf": [ { "enum": [ "draft", "review", "ready", "published" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "standalone_only": { "default": false, "title": "Standalone Only", "type": "boolean" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "maximum": 1000000, "minimum": 0, "title": "Offset", "type": "integer" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_articlesArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_audit_findings", "surface": "api", "heading": "Authenticated MCP tool: get_audit_findings", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_audit_findings", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "audit_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Audit Id" }, "severity": { "default": "critical,high", "title": "Severity", "type": "string" }, "issue_status": { "default": "open,in_progress", "title": "Issue Status", "type": "string" }, "check_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Check Name" }, "page_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Page Url" }, "page_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Page Type" }, "url_pattern": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url Pattern" }, "min_score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "maximum": 100, "minimum": 0, "title": "Min Score" }, "max_score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "maximum": 100, "minimum": 0, "title": "Max Score" }, "issues_limit": { "default": 20, "maximum": 50, "minimum": 1, "title": "Issues Limit", "type": "integer" }, "pages_limit": { "default": 20, "maximum": 100, "minimum": 1, "title": "Pages Limit", "type": "integer" } }, "required": [ "brand_id" ], "title": "get_audit_findingsArguments", "type": "object" }, "annotations": { "title": "Get Audit Findings", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "audit_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Audit Id" }, "severity": { "default": "critical,high", "title": "Severity", "type": "string" }, "issue_status": { "default": "open,in_progress", "title": "Issue Status", "type": "string" }, "check_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Check Name" }, "page_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Page Url" }, "page_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Page Type" }, "url_pattern": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url Pattern" }, "min_score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "maximum": 100, "minimum": 0, "title": "Min Score" }, "max_score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "maximum": 100, "minimum": 0, "title": "Max Score" }, "issues_limit": { "default": 20, "maximum": 50, "minimum": 1, "title": "Issues Limit", "type": "integer" }, "pages_limit": { "default": 20, "maximum": 100, "minimum": 1, "title": "Pages Limit", "type": "integer" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_audit_findingsArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_business_context", "surface": "api", "heading": "Authenticated MCP tool: get_business_context", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_business_context", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" } }, "required": [ "brand_id" ], "title": "get_business_contextArguments", "type": "object" }, "annotations": { "title": "Get Business Context", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_business_contextArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_changes", "surface": "api", "heading": "Authenticated MCP tool: get_changes", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_changes", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "since": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Since" }, "days": { "default": 7, "maximum": 180, "minimum": 1, "title": "Days", "type": "integer" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, "required": [ "brand_id" ], "title": "get_changesArguments", "type": "object" }, "annotations": { "title": "Get Recent Changes", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "since": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Since" }, "days": { "default": 7, "maximum": 180, "minimum": 1, "title": "Days", "type": "integer" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_changesArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_citations", "surface": "api", "heading": "Authenticated MCP tool: get_citations", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_citations", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "view": { "default": "list", "enum": [ "list", "history", "queries", "sources", "feed", "recent", "heatmap", "analytics", "detail", "by_model", "top_pages" ], "title": "View", "type": "string" }, "days": { "default": 30, "maximum": 365, "minimum": 7, "title": "Days", "type": "integer" }, "period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Period" }, "limit": { "default": 100, "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "maximum": 1000000, "minimum": 0, "title": "Offset", "type": "integer" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Domain" }, "days_back": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "maximum": 30, "minimum": 1, "title": "Days Back" }, "tag_ids": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag Ids" }, "prompt_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Prompt Text" }, "response_format": { "default": "concise", "enum": [ "concise", "detailed" ], "title": "Response Format", "type": "string" } }, "required": [ "brand_id" ], "title": "get_citationsArguments", "type": "object" }, "annotations": { "title": "Get Citations", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "view": { "default": "list", "enum": [ "list", "history", "queries", "sources", "feed", "recent", "heatmap", "analytics", "detail", "by_model", "top_pages" ], "title": "View", "type": "string" }, "days": { "default": 30, "maximum": 365, "minimum": 7, "title": "Days", "type": "integer" }, "period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Period" }, "limit": { "default": 100, "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "maximum": 1000000, "minimum": 0, "title": "Offset", "type": "integer" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Domain" }, "days_back": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "maximum": 30, "minimum": 1, "title": "Days Back" }, "tag_ids": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag Ids" }, "prompt_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Prompt Text" }, "response_format": { "default": "concise", "enum": [ "concise", "detailed" ], "title": "Response Format", "type": "string" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_citationsArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_competitors", "surface": "api", "heading": "Authenticated MCP tool: get_competitors", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_competitors", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "view": { "default": "summary", "enum": [ "summary", "arena", "head-to-head", "by-model", "threats", "heatmap", "over_time" ], "title": "View", "type": "string" }, "competitor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Competitor" }, "days": { "default": 30, "enum": [ 7, 14, 30, 90 ], "title": "Days", "type": "integer" }, "period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Period" }, "tag_ids": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag Ids" }, "limit": { "default": 10, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "response_format": { "default": "concise", "enum": [ "concise", "detailed" ], "title": "Response Format", "type": "string" } }, "required": [ "brand_id" ], "title": "get_competitorsArguments", "type": "object" }, "annotations": { "title": "Get Competitors", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "view": { "default": "summary", "enum": [ "summary", "arena", "head-to-head", "by-model", "threats", "heatmap", "over_time" ], "title": "View", "type": "string" }, "competitor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Competitor" }, "days": { "default": 30, "enum": [ 7, 14, 30, 90 ], "title": "Days", "type": "integer" }, "period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Period" }, "tag_ids": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag Ids" }, "limit": { "default": 10, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "response_format": { "default": "concise", "enum": [ "concise", "detailed" ], "title": "Response Format", "type": "string" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_competitorsArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_content_ideas", "surface": "api", "heading": "Authenticated MCP tool: get_content_ideas", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_content_ideas", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "maximum": 1000000, "minimum": 0, "title": "Offset", "type": "integer" }, "status": { "anyOf": [ { "enum": [ "active", "dismissed", "implemented" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" } }, "required": [ "brand_id" ], "title": "get_content_ideasArguments", "type": "object" }, "annotations": { "title": "Get Content Ideas", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "maximum": 1000000, "minimum": 0, "title": "Offset", "type": "integer" }, "status": { "anyOf": [ { "enum": [ "active", "dismissed", "implemented" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_content_ideasArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_crawler_access", "surface": "api", "heading": "Authenticated MCP tool: get_crawler_access", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_crawler_access", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "range_preset": { "default": "30d", "enum": [ "24h", "7d", "30d", "90d", "custom" ], "title": "Range Preset", "type": "string" }, "start_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Start Date" }, "end_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "End Date" } }, "required": [ "brand_id" ], "title": "get_crawler_accessArguments", "type": "object" }, "annotations": { "title": "Get Crawler Access", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "range_preset": { "default": "30d", "enum": [ "24h", "7d", "30d", "90d", "custom" ], "title": "Range Preset", "type": "string" }, "start_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Start Date" }, "end_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "End Date" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_crawler_accessArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_crawler_detail", "surface": "api", "heading": "Authenticated MCP tool: get_crawler_detail", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_crawler_detail", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "kind": { "enum": [ "page", "path", "bot" ], "title": "Kind", "type": "string" }, "entity_id": { "title": "Entity Id", "type": "string" }, "range_preset": { "default": "30d", "enum": [ "24h", "7d", "30d", "90d", "custom" ], "title": "Range Preset", "type": "string" }, "start_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Start Date" }, "end_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "End Date" }, "intent": { "default": "all", "enum": [ "all", "interaction", "search", "training" ], "title": "Intent", "type": "string" }, "platform": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Platform" }, "search": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Search" }, "status": { "default": "all", "enum": [ "all", "converting", "cited", "crawled", "healthy", "cold" ], "title": "Status", "type": "string" } }, "required": [ "brand_id", "kind", "entity_id" ], "title": "get_crawler_detailArguments", "type": "object" }, "annotations": { "title": "Get Crawler Visit Detail", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "kind": { "enum": [ "page", "path", "bot" ], "title": "Kind", "type": "string" }, "entity_id": { "title": "Entity Id", "type": "string" }, "range_preset": { "default": "30d", "enum": [ "24h", "7d", "30d", "90d", "custom" ], "title": "Range Preset", "type": "string" }, "start_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Start Date" }, "end_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "End Date" }, "intent": { "default": "all", "enum": [ "all", "interaction", "search", "training" ], "title": "Intent", "type": "string" }, "platform": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Platform" }, "search": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Search" }, "status": { "default": "all", "enum": [ "all", "converting", "cited", "crawled", "healthy", "cold" ], "title": "Status", "type": "string" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id", "kind", "entity_id" ], "title": "get_crawler_detailArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_crawler_live", "surface": "api", "heading": "Authenticated MCP tool: get_crawler_live", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_crawler_live", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "view": { "default": "activity", "enum": [ "activity", "pages", "sessions" ], "title": "View", "type": "string" }, "range_preset": { "default": "30d", "enum": [ "24h", "7d", "30d", "90d", "custom" ], "title": "Range Preset", "type": "string" }, "start_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Start Date" }, "end_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "End Date" }, "intent": { "default": "all", "enum": [ "all", "interaction", "search", "training" ], "title": "Intent", "type": "string" }, "platform": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Platform" }, "http_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Http Status" }, "search": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Search" }, "sort_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Sort By" }, "sort_dir": { "default": "desc", "enum": [ "asc", "desc" ], "title": "Sort Dir", "type": "string" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 25, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, "required": [ "brand_id" ], "title": "get_crawler_liveArguments", "type": "object" }, "annotations": { "title": "Get Live Crawler Visits", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "view": { "default": "activity", "enum": [ "activity", "pages", "sessions" ], "title": "View", "type": "string" }, "range_preset": { "default": "30d", "enum": [ "24h", "7d", "30d", "90d", "custom" ], "title": "Range Preset", "type": "string" }, "start_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Start Date" }, "end_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "End Date" }, "intent": { "default": "all", "enum": [ "all", "interaction", "search", "training" ], "title": "Intent", "type": "string" }, "platform": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Platform" }, "http_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Http Status" }, "search": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Search" }, "sort_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Sort By" }, "sort_dir": { "default": "desc", "enum": [ "asc", "desc" ], "title": "Sort Dir", "type": "string" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 25, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_crawler_liveArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_crawler_overview", "surface": "api", "heading": "Authenticated MCP tool: get_crawler_overview", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_crawler_overview", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "range_preset": { "default": "30d", "enum": [ "24h", "7d", "30d", "90d", "custom" ], "title": "Range Preset", "type": "string" }, "start_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Start Date" }, "end_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "End Date" }, "compare_to": { "default": "none", "enum": [ "none", "previous_period" ], "title": "Compare To", "type": "string" } }, "required": [ "brand_id" ], "title": "get_crawler_overviewArguments", "type": "object" }, "annotations": { "title": "Get Crawler Overview", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "range_preset": { "default": "30d", "enum": [ "24h", "7d", "30d", "90d", "custom" ], "title": "Range Preset", "type": "string" }, "start_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Start Date" }, "end_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "End Date" }, "compare_to": { "default": "none", "enum": [ "none", "previous_period" ], "title": "Compare To", "type": "string" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_crawler_overviewArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_crawler_pages", "surface": "api", "heading": "Authenticated MCP tool: get_crawler_pages", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_crawler_pages", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "lens": { "default": "pages", "enum": [ "pages", "paths", "bots" ], "title": "Lens", "type": "string" }, "range_preset": { "default": "30d", "enum": [ "24h", "7d", "30d", "90d", "custom" ], "title": "Range Preset", "type": "string" }, "start_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Start Date" }, "end_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "End Date" }, "intent": { "default": "all", "enum": [ "all", "interaction", "search", "training" ], "title": "Intent", "type": "string" }, "platform": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Platform" }, "search": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Search" }, "status": { "default": "all", "enum": [ "all", "converting", "cited", "crawled", "healthy", "cold" ], "title": "Status", "type": "string" }, "sort_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Sort By" }, "sort_dir": { "default": "desc", "enum": [ "asc", "desc" ], "title": "Sort Dir", "type": "string" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 25, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, "required": [ "brand_id" ], "title": "get_crawler_pagesArguments", "type": "object" }, "annotations": { "title": "Get Crawler Pages", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "lens": { "default": "pages", "enum": [ "pages", "paths", "bots" ], "title": "Lens", "type": "string" }, "range_preset": { "default": "30d", "enum": [ "24h", "7d", "30d", "90d", "custom" ], "title": "Range Preset", "type": "string" }, "start_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Start Date" }, "end_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "End Date" }, "intent": { "default": "all", "enum": [ "all", "interaction", "search", "training" ], "title": "Intent", "type": "string" }, "platform": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Platform" }, "search": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Search" }, "status": { "default": "all", "enum": [ "all", "converting", "cited", "crawled", "healthy", "cold" ], "title": "Status", "type": "string" }, "sort_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Sort By" }, "sort_dir": { "default": "desc", "enum": [ "asc", "desc" ], "title": "Sort Dir", "type": "string" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 25, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_crawler_pagesArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_crawler_submit_status", "surface": "api", "heading": "Authenticated MCP tool: get_crawler_submit_status", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_crawler_submit_status", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "range_preset": { "default": "30d", "enum": [ "24h", "7d", "30d", "90d", "custom" ], "title": "Range Preset", "type": "string" }, "start_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Start Date" }, "end_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "End Date" }, "urls": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Urls" }, "status": { "anyOf": [ { "enum": [ "pending", "success", "failed" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" } }, "required": [ "brand_id" ], "title": "get_crawler_submit_statusArguments", "type": "object" }, "annotations": { "title": "Get Search Submission Status", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "range_preset": { "default": "30d", "enum": [ "24h", "7d", "30d", "90d", "custom" ], "title": "Range Preset", "type": "string" }, "start_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Start Date" }, "end_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "End Date" }, "urls": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Urls" }, "status": { "anyOf": [ { "enum": [ "pending", "success", "failed" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_crawler_submit_statusArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_diagnosis_result", "surface": "api", "heading": "Authenticated MCP tool: get_diagnosis_result", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_diagnosis_result", "inputSchema": { "properties": { "brand_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Brand Id" }, "diagnosis_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Diagnosis Id" }, "view": { "anyOf": [ { "enum": [ "result", "history", "usage" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "View" }, "limit": { "default": 20, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, "title": "get_diagnosis_resultArguments", "type": "object" }, "annotations": { "title": "Get Diagnosis Result", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Brand Id" }, "diagnosis_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Diagnosis Id" }, "view": { "anyOf": [ { "enum": [ "result", "history", "usage" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "View" }, "limit": { "default": 20, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "user_intent": { "type": "string", "maxLength": 600 } }, "title": "get_diagnosis_resultArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_knowledge", "surface": "api", "heading": "Authenticated MCP tool: get_knowledge", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_knowledge", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "view": { "default": "sources", "enum": [ "sources", "stats" ], "title": "View", "type": "string" } }, "required": [ "brand_id" ], "title": "get_knowledgeArguments", "type": "object" }, "annotations": { "title": "Get Brand Knowledge", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "view": { "default": "sources", "enum": [ "sources", "stats" ], "title": "View", "type": "string" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_knowledgeArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_latest_research", "surface": "api", "heading": "Authenticated MCP tool: get_latest_research", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_latest_research", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "report_type": { "anyOf": [ { "enum": [ "full_research", "topic_snapshot" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Report Type" }, "results_limit": { "default": 100, "maximum": 500, "minimum": 1, "title": "Results Limit", "type": "integer" }, "results_offset": { "default": 0, "maximum": 1000000, "minimum": 0, "title": "Results Offset", "type": "integer" } }, "required": [ "brand_id" ], "title": "get_latest_researchArguments", "type": "object" }, "annotations": { "title": "Get Latest Research", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "report_type": { "anyOf": [ { "enum": [ "full_research", "topic_snapshot" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Report Type" }, "results_limit": { "default": 100, "maximum": 500, "minimum": 1, "title": "Results Limit", "type": "integer" }, "results_offset": { "default": 0, "maximum": 1000000, "minimum": 0, "title": "Results Offset", "type": "integer" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_latest_researchArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_model_breakdown", "surface": "api", "heading": "Authenticated MCP tool: get_model_breakdown", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_model_breakdown", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "days": { "default": 30, "maximum": 365, "minimum": 7, "title": "Days", "type": "integer" }, "period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Period" }, "include_trends": { "default": false, "title": "Include Trends", "type": "boolean" } }, "required": [ "brand_id" ], "title": "get_model_breakdownArguments", "type": "object" }, "annotations": { "title": "Get AI Model Breakdown", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "days": { "default": 30, "maximum": 365, "minimum": 7, "title": "Days", "type": "integer" }, "period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Period" }, "include_trends": { "default": false, "title": "Include Trends", "type": "boolean" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_model_breakdownArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_narratives", "surface": "api", "heading": "Authenticated MCP tool: get_narratives", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_narratives", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "narrative_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Narrative Id" }, "include": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Include" }, "days": { "default": 90, "maximum": 365, "minimum": 7, "title": "Days", "type": "integer" } }, "required": [ "brand_id" ], "title": "get_narrativesArguments", "type": "object" }, "annotations": { "title": "Get Brand Narratives", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "narrative_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Narrative Id" }, "include": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Include" }, "days": { "default": 90, "maximum": 365, "minimum": 7, "title": "Days", "type": "integer" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_narrativesArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_notifications", "surface": "api", "heading": "Authenticated MCP tool: get_notifications", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_notifications", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "view": { "default": "list", "enum": [ "list", "unread_count" ], "title": "View", "type": "string" }, "unread_only": { "default": false, "title": "Unread Only", "type": "boolean" }, "event_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Event Type" }, "days": { "default": 30, "maximum": 180, "minimum": 1, "title": "Days", "type": "integer" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, "required": [ "brand_id" ], "title": "get_notificationsArguments", "type": "object" }, "annotations": { "title": "Get Notifications", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "view": { "default": "list", "enum": [ "list", "unread_count" ], "title": "View", "type": "string" }, "unread_only": { "default": false, "title": "Unread Only", "type": "boolean" }, "event_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Event Type" }, "days": { "default": 30, "maximum": 180, "minimum": 1, "title": "Days", "type": "integer" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_notificationsArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_opportunities", "surface": "api", "heading": "Authenticated MCP tool: get_opportunities", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_opportunities", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "maximum": 365, "minimum": 1, "title": "Days" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, "required": [ "brand_id" ], "title": "get_opportunitiesArguments", "type": "object" }, "annotations": { "title": "Get Opportunities", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "maximum": 365, "minimum": 1, "title": "Days" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_opportunitiesArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_page_analysis", "surface": "api", "heading": "Authenticated MCP tool: get_page_analysis", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_page_analysis", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" }, "max_age_days": { "default": 30, "maximum": 365, "minimum": 1, "title": "Max Age Days", "type": "integer" } }, "required": [ "brand_id" ], "title": "get_page_analysisArguments", "type": "object" }, "annotations": { "title": "Get Page Analysis", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" }, "max_age_days": { "default": 30, "maximum": 365, "minimum": 1, "title": "Max Age Days", "type": "integer" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_page_analysisArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_perception", "surface": "api", "heading": "Authenticated MCP tool: get_perception", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_perception", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "view": { "default": "dashboard", "enum": [ "dashboard", "metrics", "story", "narrative_drift", "narrative" ], "title": "View", "type": "string" }, "days": { "default": 90, "maximum": 365, "minimum": 7, "title": "Days", "type": "integer" }, "period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Period" }, "tracked_brand": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tracked Brand" } }, "required": [ "brand_id" ], "title": "get_perceptionArguments", "type": "object" }, "annotations": { "title": "Get Brand Perception", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "view": { "default": "dashboard", "enum": [ "dashboard", "metrics", "story", "narrative_drift", "narrative" ], "title": "View", "type": "string" }, "days": { "default": 90, "maximum": 365, "minimum": 7, "title": "Days", "type": "integer" }, "period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Period" }, "tracked_brand": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tracked Brand" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_perceptionArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_period_summary", "surface": "api", "heading": "Authenticated MCP tool: get_period_summary", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_period_summary", "inputSchema": { "properties": { "brand_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Brand Id" }, "period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Period" }, "view": { "default": "summary", "enum": [ "summary", "list" ], "title": "View", "type": "string" }, "compare": { "default": true, "title": "Compare", "type": "boolean" }, "include_definitions": { "default": false, "title": "Include Definitions", "type": "boolean" }, "months": { "default": 12, "maximum": 36, "minimum": 1, "title": "Months", "type": "integer" }, "response_format": { "default": "concise", "enum": [ "concise", "detailed" ], "title": "Response Format", "type": "string" }, "brand_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Brand Ids" } }, "title": "get_period_summaryArguments", "type": "object" }, "annotations": { "title": "Get Period Summary", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Brand Id" }, "period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Period" }, "view": { "default": "summary", "enum": [ "summary", "list" ], "title": "View", "type": "string" }, "compare": { "default": true, "title": "Compare", "type": "boolean" }, "include_definitions": { "default": false, "title": "Include Definitions", "type": "boolean" }, "months": { "default": 12, "maximum": 36, "minimum": 1, "title": "Months", "type": "integer" }, "response_format": { "default": "concise", "enum": [ "concise", "detailed" ], "title": "Response Format", "type": "string" }, "brand_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Brand Ids" }, "user_intent": { "type": "string", "maxLength": 600 } }, "title": "get_period_summaryArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_portfolio_actions", "surface": "api", "heading": "Authenticated MCP tool: get_portfolio_actions", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_portfolio_actions", "inputSchema": { "properties": { "group_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Group Id" }, "quick_win": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Quick Win" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, "title": "get_portfolio_actionsArguments", "type": "object" }, "annotations": { "title": "Get Portfolio Actions", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "group_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Group Id" }, "quick_win": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Quick Win" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "user_intent": { "type": "string", "maxLength": 600 } }, "title": "get_portfolio_actionsArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_prism", "surface": "api", "heading": "Authenticated MCP tool: get_prism", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_prism", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" } }, "required": [ "brand_id" ], "title": "get_prismArguments", "type": "object" }, "annotations": { "title": "Get AI Pages", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_prismArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_proof", "surface": "api", "heading": "Authenticated MCP tool: get_proof", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_proof", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "verdict": { "anyOf": [ { "enum": [ "earned", "no_change", "harm", "couldnt_measure" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Verdict" }, "family": { "anyOf": [ { "enum": [ "fix", "refresh", "create", "earn", "discuss", "optimize", "setup", "play" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Family" }, "days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "maximum": 3650, "minimum": 1, "title": "Days" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" } }, "required": [ "brand_id" ], "title": "get_proofArguments", "type": "object" }, "annotations": { "title": "Get Supporting Proof", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "verdict": { "anyOf": [ { "enum": [ "earned", "no_change", "harm", "couldnt_measure" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Verdict" }, "family": { "anyOf": [ { "enum": [ "fix", "refresh", "create", "earn", "discuss", "optimize", "setup", "play" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Family" }, "days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "maximum": 3650, "minimum": 1, "title": "Days" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_proofArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_rankings", "surface": "api", "heading": "Authenticated MCP tool: get_rankings", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_rankings", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "view": { "default": "overall", "enum": [ "overall", "by-prompt", "prompt-trends" ], "title": "View", "type": "string" }, "days": { "default": 30, "maximum": 365, "minimum": 1, "title": "Days", "type": "integer" }, "period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Period" }, "include_volume": { "default": false, "title": "Include Volume", "type": "boolean" }, "tag_ids": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag Ids" }, "limit": { "default": 25, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, "required": [ "brand_id" ], "title": "get_rankingsArguments", "type": "object" }, "annotations": { "title": "Get AI Rankings", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "view": { "default": "overall", "enum": [ "overall", "by-prompt", "prompt-trends" ], "title": "View", "type": "string" }, "days": { "default": 30, "maximum": 365, "minimum": 1, "title": "Days", "type": "integer" }, "period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Period" }, "include_volume": { "default": false, "title": "Include Volume", "type": "boolean" }, "tag_ids": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag Ids" }, "limit": { "default": 25, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_rankingsArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_reddit", "surface": "api", "heading": "Authenticated MCP tool: get_reddit", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_reddit", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "view": { "default": "overview", "enum": [ "overview", "feed", "opportunities", "thread", "subreddits", "triggers", "analytics" ], "title": "View", "type": "string" }, "thread_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Thread Id" }, "status": { "anyOf": [ { "enum": [ "all", "open", "responded" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "subreddit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Subreddit" }, "days": { "default": 30, "maximum": 180, "minimum": 1, "title": "Days", "type": "integer" }, "page_size": { "default": 30, "maximum": 100, "minimum": 1, "title": "Page Size", "type": "integer" } }, "required": [ "brand_id" ], "title": "get_redditArguments", "type": "object" }, "annotations": { "title": "Get Reddit Intelligence", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "view": { "default": "overview", "enum": [ "overview", "feed", "opportunities", "thread", "subreddits", "triggers", "analytics" ], "title": "View", "type": "string" }, "thread_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Thread Id" }, "status": { "anyOf": [ { "enum": [ "all", "open", "responded" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "subreddit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Subreddit" }, "days": { "default": 30, "maximum": 180, "minimum": 1, "title": "Days", "type": "integer" }, "page_size": { "default": 30, "maximum": 100, "minimum": 1, "title": "Page Size", "type": "integer" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_redditArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_reports", "surface": "api", "heading": "Authenticated MCP tool: get_reports", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_reports", "inputSchema": { "properties": { "brand_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Brand Id" }, "report_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Report Id" }, "view": { "default": "list", "enum": [ "list", "results", "sentiment", "mentions_time_series" ], "title": "View", "type": "string" }, "report_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Report Type" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "days": { "default": 30, "maximum": 365, "minimum": 1, "title": "Days", "type": "integer" }, "limit": { "default": 20, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "maximum": 1000000, "minimum": 0, "title": "Offset", "type": "integer" }, "response_format": { "default": "concise", "enum": [ "concise", "detailed" ], "title": "Response Format", "type": "string" } }, "title": "get_reportsArguments", "type": "object" }, "annotations": { "title": "Get Reports", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Brand Id" }, "report_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Report Id" }, "view": { "default": "list", "enum": [ "list", "results", "sentiment", "mentions_time_series" ], "title": "View", "type": "string" }, "report_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Report Type" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "days": { "default": 30, "maximum": 365, "minimum": 1, "title": "Days", "type": "integer" }, "limit": { "default": 20, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "maximum": 1000000, "minimum": 0, "title": "Offset", "type": "integer" }, "response_format": { "default": "concise", "enum": [ "concise", "detailed" ], "title": "Response Format", "type": "string" }, "user_intent": { "type": "string", "maxLength": 600 } }, "title": "get_reportsArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_research_credits", "surface": "api", "heading": "Authenticated MCP tool: get_research_credits", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_research_credits", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" } }, "required": [ "brand_id" ], "title": "get_research_creditsArguments", "type": "object" }, "annotations": { "title": "Get Research Credits", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_research_creditsArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_research_run", "surface": "api", "heading": "Authenticated MCP tool: get_research_run", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_research_run", "inputSchema": { "properties": { "run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Run Id" }, "results_limit": { "default": 100, "maximum": 500, "minimum": 1, "title": "Results Limit", "type": "integer" }, "results_offset": { "default": 0, "maximum": 1000000, "minimum": 0, "title": "Results Offset", "type": "integer" }, "response_format": { "default": "concise", "enum": [ "concise", "detailed" ], "title": "Response Format", "type": "string" } }, "title": "get_research_runArguments", "type": "object" }, "annotations": { "title": "Get a Research Run", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Run Id" }, "results_limit": { "default": 100, "maximum": 500, "minimum": 1, "title": "Results Limit", "type": "integer" }, "results_offset": { "default": 0, "maximum": 1000000, "minimum": 0, "title": "Results Offset", "type": "integer" }, "response_format": { "default": "concise", "enum": [ "concise", "detailed" ], "title": "Response Format", "type": "string" }, "user_intent": { "type": "string", "maxLength": 600 } }, "title": "get_research_runArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_research_runs", "surface": "api", "heading": "Authenticated MCP tool: get_research_runs", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_research_runs", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "report_type": { "anyOf": [ { "enum": [ "full_research", "topic_snapshot" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Report Type" }, "ready_only": { "default": true, "title": "Ready Only", "type": "boolean" }, "limit": { "default": 20, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "maximum": 1000000, "minimum": 0, "title": "Offset", "type": "integer" } }, "required": [ "brand_id" ], "title": "get_research_runsArguments", "type": "object" }, "annotations": { "title": "Get Research Runs", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "report_type": { "anyOf": [ { "enum": [ "full_research", "topic_snapshot" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Report Type" }, "ready_only": { "default": true, "title": "Ready Only", "type": "boolean" }, "limit": { "default": 20, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "maximum": 1000000, "minimum": 0, "title": "Offset", "type": "integer" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_research_runsArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_results", "surface": "api", "heading": "Authenticated MCP tool: get_results", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_results", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "verdict": { "anyOf": [ { "enum": [ "earned", "no_change", "harm", "couldnt_measure" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Verdict" }, "family": { "anyOf": [ { "enum": [ "fix", "refresh", "create", "earn", "discuss", "optimize", "setup", "play" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Family" }, "days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "maximum": 3650, "minimum": 1, "title": "Days" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" } }, "required": [ "brand_id" ], "title": "get_resultsArguments", "type": "object" }, "annotations": { "title": "Get Measured Results", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "verdict": { "anyOf": [ { "enum": [ "earned", "no_change", "harm", "couldnt_measure" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Verdict" }, "family": { "anyOf": [ { "enum": [ "fix", "refresh", "create", "earn", "discuss", "optimize", "setup", "play" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Family" }, "days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "maximum": 3650, "minimum": 1, "title": "Days" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_resultsArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_search_performance", "surface": "api", "heading": "Authenticated MCP tool: get_search_performance", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_search_performance", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" }, "days": { "default": 28, "maximum": 90, "minimum": 1, "title": "Days", "type": "integer" }, "compare_previous_period": { "default": false, "title": "Compare Previous Period", "type": "boolean" } }, "required": [ "brand_id" ], "title": "get_search_performanceArguments", "type": "object" }, "annotations": { "title": "Get Search Performance", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" }, "days": { "default": 28, "maximum": 90, "minimum": 1, "title": "Days", "type": "integer" }, "compare_previous_period": { "default": false, "title": "Compare Previous Period", "type": "boolean" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_search_performanceArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_tracked_articles", "surface": "api", "heading": "Authenticated MCP tool: get_tracked_articles", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_tracked_articles", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Domain" } }, "required": [ "brand_id" ], "title": "get_tracked_articlesArguments", "type": "object" }, "annotations": { "title": "Get Tracked Articles", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Domain" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_tracked_articlesArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_traffic", "surface": "api", "heading": "Authenticated MCP tool: get_traffic", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_traffic", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "view": { "default": "status", "enum": [ "status", "report", "visitors" ], "title": "View", "type": "string" }, "days": { "default": 30, "maximum": 365, "minimum": 1, "title": "Days", "type": "integer" } }, "required": [ "brand_id" ], "title": "get_trafficArguments", "type": "object" }, "annotations": { "title": "Get Website Traffic", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "view": { "default": "status", "enum": [ "status", "report", "visitors" ], "title": "View", "type": "string" }, "days": { "default": 30, "maximum": 365, "minimum": 1, "title": "Days", "type": "integer" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_trafficArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_visibility_scores", "surface": "api", "heading": "Authenticated MCP tool: get_visibility_scores", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_visibility_scores", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "view": { "default": "summary", "enum": [ "summary", "time_series", "by_model", "by_prompt" ], "title": "View", "type": "string" }, "days": { "default": 90, "maximum": 365, "minimum": 7, "title": "Days", "type": "integer" }, "period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Period" }, "tag_ids": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag Ids" }, "prompt_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Prompt Id" } }, "required": [ "brand_id" ], "title": "get_visibility_scoresArguments", "type": "object" }, "annotations": { "title": "Get Visibility Scores", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "view": { "default": "summary", "enum": [ "summary", "time_series", "by_model", "by_prompt" ], "title": "View", "type": "string" }, "days": { "default": 90, "maximum": 365, "minimum": 7, "title": "Days", "type": "integer" }, "period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Period" }, "tag_ids": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag Ids" }, "prompt_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Prompt Id" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_visibility_scoresArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_workflows", "surface": "api", "heading": "Authenticated MCP tool: get_workflows", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_workflows", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "view": { "default": "list", "enum": [ "list", "get", "runs", "run_detail", "templates" ], "title": "View", "type": "string" }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workflow Id" }, "run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Run Id" }, "status": { "anyOf": [ { "enum": [ "active", "paused", "deleted" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "days": { "default": 30, "maximum": 90, "minimum": 1, "title": "Days", "type": "integer" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "maximum": 1000000, "minimum": 0, "title": "Offset", "type": "integer" } }, "required": [ "brand_id" ], "title": "get_workflowsArguments", "type": "object" }, "annotations": { "title": "Get Workflows", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "view": { "default": "list", "enum": [ "list", "get", "runs", "run_detail", "templates" ], "title": "View", "type": "string" }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workflow Id" }, "run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Run Id" }, "status": { "anyOf": [ { "enum": [ "active", "paused", "deleted" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "days": { "default": 30, "maximum": 90, "minimum": 1, "title": "Days", "type": "integer" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "maximum": 1000000, "minimum": 0, "title": "Offset", "type": "integer" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_workflowsArguments", "type": "object" } } }, { "id": "mcp:authenticated:get_writing_style", "surface": "api", "heading": "Authenticated MCP tool: get_writing_style", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "get_writing_style", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "view": { "default": "profile", "enum": [ "profile", "samples" ], "title": "View", "type": "string" } }, "required": [ "brand_id" ], "title": "get_writing_styleArguments", "type": "object" }, "annotations": { "title": "Get Writing Style", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "view": { "default": "profile", "enum": [ "profile", "samples" ], "title": "View", "type": "string" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "get_writing_styleArguments", "type": "object" } } }, { "id": "mcp:authenticated:list_audits", "surface": "api", "heading": "Authenticated MCP tool: list_audits", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "list_audits", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "audit_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Audit Id" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "limit": { "default": 20, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Period" } }, "required": [ "brand_id" ], "title": "list_auditsArguments", "type": "object" }, "annotations": { "title": "List Site Audits", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "audit_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Audit Id" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "limit": { "default": 20, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Period" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "list_auditsArguments", "type": "object" } } }, { "id": "mcp:authenticated:list_brand_groups", "surface": "api", "heading": "Authenticated MCP tool: list_brand_groups", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "list_brand_groups", "inputSchema": { "properties": {}, "title": "list_brand_groupsArguments", "type": "object" }, "annotations": { "title": "List Brand Groups", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "user_intent": { "type": "string", "maxLength": 600 } }, "title": "list_brand_groupsArguments", "type": "object" } } }, { "id": "mcp:authenticated:list_brands", "surface": "api", "heading": "Authenticated MCP tool: list_brands", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "list_brands", "inputSchema": { "properties": { "brand_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Brand Id" }, "include": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Include" } }, "title": "list_brandsArguments", "type": "object" }, "annotations": { "title": "List Brands", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Brand Id" }, "include": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Include" }, "user_intent": { "type": "string", "maxLength": 600 } }, "title": "list_brandsArguments", "type": "object" } } }, { "id": "mcp:authenticated:list_opportunity_pool", "surface": "api", "heading": "Authenticated MCP tool: list_opportunity_pool", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "list_opportunity_pool", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "family": { "anyOf": [ { "enum": [ "fix", "refresh", "create", "earn", "discuss", "optimize", "setup", "play" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Family" }, "kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Kind" }, "impact": { "anyOf": [ { "enum": [ "low", "medium", "high" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Impact" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" } }, "required": [ "brand_id" ], "title": "list_opportunity_poolArguments", "type": "object" }, "annotations": { "title": "List Opportunity Pool", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "family": { "anyOf": [ { "enum": [ "fix", "refresh", "create", "earn", "discuss", "optimize", "setup", "play" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Family" }, "kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Kind" }, "impact": { "anyOf": [ { "enum": [ "low", "medium", "high" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Impact" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "list_opportunity_poolArguments", "type": "object" } } }, { "id": "mcp:authenticated:list_page_analyses", "surface": "api", "heading": "Authenticated MCP tool: list_page_analyses", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "list_page_analyses", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "limit": { "default": 20, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, "required": [ "brand_id" ], "title": "list_page_analysesArguments", "type": "object" }, "annotations": { "title": "List Page Analyses", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "limit": { "default": 20, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "list_page_analysesArguments", "type": "object" } } }, { "id": "mcp:authenticated:list_pages", "surface": "api", "heading": "Authenticated MCP tool: list_pages", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "list_pages", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "ownership": { "anyOf": [ { "enum": [ "owned", "competitor", "editorial", "social", "video", "other" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Ownership" }, "tracked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Tracked" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" } }, "required": [ "brand_id" ], "title": "list_pagesArguments", "type": "object" }, "annotations": { "title": "List Tracked Pages", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "ownership": { "anyOf": [ { "enum": [ "owned", "competitor", "editorial", "social", "video", "other" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Ownership" }, "tracked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Tracked" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "list_pagesArguments", "type": "object" } } }, { "id": "mcp:authenticated:list_prompts", "surface": "api", "heading": "Authenticated MCP tool: list_prompts", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "list_prompts", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "active_only": { "default": false, "title": "Active Only", "type": "boolean" }, "tag_ids": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag Ids" }, "limit": { "default": 100, "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "maximum": 1000000, "minimum": 0, "title": "Offset", "type": "integer" } }, "required": [ "brand_id" ], "title": "list_promptsArguments", "type": "object" }, "annotations": { "title": "List Prompts", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "active_only": { "default": false, "title": "Active Only", "type": "boolean" }, "tag_ids": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag Ids" }, "limit": { "default": 100, "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "maximum": 1000000, "minimum": 0, "title": "Offset", "type": "integer" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "list_promptsArguments", "type": "object" } } }, { "id": "mcp:authenticated:list_tags", "surface": "api", "heading": "Authenticated MCP tool: list_tags", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "list_tags", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" } }, "required": [ "brand_id" ], "title": "list_tagsArguments", "type": "object" }, "annotations": { "title": "List Prompt Tags", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "list_tagsArguments", "type": "object" } } }, { "id": "mcp:authenticated:manage_action", "surface": "api", "heading": "Authenticated MCP tool: manage_action", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "manage_action", "inputSchema": { "properties": { "action": { "enum": [ "complete", "dismiss", "reopen", "start", "snooze", "unsnooze", "pin", "unpin", "assign", "note" ], "title": "Action", "type": "string" }, "brand_id": { "title": "Brand Id", "type": "string" }, "action_id": { "title": "Action Id", "type": "string" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Note" }, "snooze_until": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Snooze Until" }, "assignee": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assignee" } }, "required": [ "action", "brand_id", "action_id" ], "title": "manage_actionArguments", "type": "object" }, "annotations": { "title": "Manage an Action", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": false, "openWorldHint": false }, "hostedInputSchema": { "properties": { "action": { "enum": [ "complete", "dismiss", "reopen", "start", "snooze", "unsnooze", "pin", "unpin", "assign", "note" ], "title": "Action", "type": "string" }, "brand_id": { "title": "Brand Id", "type": "string" }, "action_id": { "title": "Action Id", "type": "string" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Note" }, "snooze_until": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Snooze Until" }, "assignee": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assignee" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "action", "brand_id", "action_id" ], "title": "manage_actionArguments", "type": "object" } } }, { "id": "mcp:authenticated:manage_competitor", "surface": "api", "heading": "Authenticated MCP tool: manage_competitor", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "manage_competitor", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "action": { "enum": [ "list", "add", "remove", "hide", "unhide" ], "title": "Action", "type": "string" }, "competitor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Competitor" } }, "required": [ "brand_id", "action" ], "title": "manage_competitorArguments", "type": "object" }, "annotations": { "title": "Manage a Competitor", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": false, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "action": { "enum": [ "list", "add", "remove", "hide", "unhide" ], "title": "Action", "type": "string" }, "competitor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Competitor" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id", "action" ], "title": "manage_competitorArguments", "type": "object" } } }, { "id": "mcp:authenticated:manage_conversions", "surface": "api", "heading": "Authenticated MCP tool: manage_conversions", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "manage_conversions", "inputSchema": { "properties": { "action": { "enum": [ "list", "set", "delete" ], "title": "Action", "type": "string" }, "brand_id": { "title": "Brand Id", "type": "string" }, "event_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Event Name" }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Value" } }, "required": [ "action", "brand_id" ], "title": "manage_conversionsArguments", "type": "object" }, "annotations": { "title": "Manage Conversions", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": false, "openWorldHint": false }, "hostedInputSchema": { "properties": { "action": { "enum": [ "list", "set", "delete" ], "title": "Action", "type": "string" }, "brand_id": { "title": "Brand Id", "type": "string" }, "event_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Event Name" }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Value" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "action", "brand_id" ], "title": "manage_conversionsArguments", "type": "object" } } }, { "id": "mcp:authenticated:manage_knowledge", "surface": "api", "heading": "Authenticated MCP tool: manage_knowledge", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "manage_knowledge", "inputSchema": { "properties": { "action": { "enum": [ "delete", "reprocess" ], "title": "Action", "type": "string" }, "source_id": { "title": "Source Id", "type": "string" } }, "required": [ "action", "source_id" ], "title": "manage_knowledgeArguments", "type": "object" }, "annotations": { "title": "Manage Brand Knowledge", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": false, "openWorldHint": false }, "hostedInputSchema": { "properties": { "action": { "enum": [ "delete", "reprocess" ], "title": "Action", "type": "string" }, "source_id": { "title": "Source Id", "type": "string" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "action", "source_id" ], "title": "manage_knowledgeArguments", "type": "object" } } }, { "id": "mcp:authenticated:manage_prompt", "surface": "api", "heading": "Authenticated MCP tool: manage_prompt", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "manage_prompt", "inputSchema": { "properties": { "action": { "enum": [ "create", "update", "delete" ], "title": "Action", "type": "string" }, "brand_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Brand Id" }, "prompt_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Prompt Id" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Text" }, "active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Active" }, "intent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Intent" } }, "required": [ "action" ], "title": "manage_promptArguments", "type": "object" }, "annotations": { "title": "Manage a Prompt", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": false, "openWorldHint": false }, "hostedInputSchema": { "properties": { "action": { "enum": [ "create", "update", "delete" ], "title": "Action", "type": "string" }, "brand_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Brand Id" }, "prompt_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Prompt Id" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Text" }, "active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Active" }, "intent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Intent" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "action" ], "title": "manage_promptArguments", "type": "object" } } }, { "id": "mcp:authenticated:manage_prompt_tags", "surface": "api", "heading": "Authenticated MCP tool: manage_prompt_tags", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "manage_prompt_tags", "inputSchema": { "properties": { "action": { "enum": [ "create", "update", "delete", "add", "remove" ], "title": "Action", "type": "string" }, "brand_id": { "title": "Brand Id", "type": "string" }, "tag_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag Id" }, "tag_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag Name" }, "colour": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Colour" }, "prompt_ids": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Prompt Ids" }, "create_if_missing": { "default": true, "title": "Create If Missing", "type": "boolean" } }, "required": [ "action", "brand_id" ], "title": "manage_prompt_tagsArguments", "type": "object" }, "annotations": { "title": "Manage Prompt Tags", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "action": { "enum": [ "create", "update", "delete", "add", "remove" ], "title": "Action", "type": "string" }, "brand_id": { "title": "Brand Id", "type": "string" }, "tag_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag Id" }, "tag_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag Name" }, "colour": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Colour" }, "prompt_ids": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Prompt Ids" }, "create_if_missing": { "default": true, "title": "Create If Missing", "type": "boolean" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "action", "brand_id" ], "title": "manage_prompt_tagsArguments", "type": "object" } } }, { "id": "mcp:authenticated:manage_publisher_shortlist", "surface": "api", "heading": "Authenticated MCP tool: manage_publisher_shortlist", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "manage_publisher_shortlist", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "action": { "enum": [ "list", "add", "remove" ], "title": "Action", "type": "string" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Domain" }, "research_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Research Id" }, "article_idea": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Article Idea" }, "rationale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Rationale" }, "proposed_route": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Proposed Route" } }, "required": [ "brand_id", "action" ], "title": "manage_publisher_shortlistArguments", "type": "object" }, "annotations": { "title": "Manage the Publisher Shortlist", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": false, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "action": { "enum": [ "list", "add", "remove" ], "title": "Action", "type": "string" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Domain" }, "research_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Research Id" }, "article_idea": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Article Idea" }, "rationale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Rationale" }, "proposed_route": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Proposed Route" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id", "action" ], "title": "manage_publisher_shortlistArguments", "type": "object" } } }, { "id": "mcp:authenticated:manage_reddit_opportunity", "surface": "api", "heading": "Authenticated MCP tool: manage_reddit_opportunity", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "manage_reddit_opportunity", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "opportunity_id": { "title": "Opportunity Id", "type": "string" }, "action": { "enum": [ "dismiss", "mark_responded" ], "title": "Action", "type": "string" } }, "required": [ "brand_id", "opportunity_id", "action" ], "title": "manage_reddit_opportunityArguments", "type": "object" }, "annotations": { "title": "Manage a Reddit Opportunity", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": false, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "opportunity_id": { "title": "Opportunity Id", "type": "string" }, "action": { "enum": [ "dismiss", "mark_responded" ], "title": "Action", "type": "string" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id", "opportunity_id", "action" ], "title": "manage_reddit_opportunityArguments", "type": "object" } } }, { "id": "mcp:authenticated:manage_reddit_subreddit", "surface": "api", "heading": "Authenticated MCP tool: manage_reddit_subreddit", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "manage_reddit_subreddit", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "action": { "enum": [ "add", "remove" ], "title": "Action", "type": "string" }, "subreddit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Subreddit" }, "subreddit_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Subreddit Id" } }, "required": [ "brand_id", "action" ], "title": "manage_reddit_subredditArguments", "type": "object" }, "annotations": { "title": "Manage a Tracked Subreddit", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": false, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "action": { "enum": [ "add", "remove" ], "title": "Action", "type": "string" }, "subreddit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Subreddit" }, "subreddit_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Subreddit Id" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id", "action" ], "title": "manage_reddit_subredditArguments", "type": "object" } } }, { "id": "mcp:authenticated:manage_reddit_trigger", "surface": "api", "heading": "Authenticated MCP tool: manage_reddit_trigger", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "manage_reddit_trigger", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "action": { "enum": [ "add", "remove" ], "title": "Action", "type": "string" }, "keyword": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Keyword" }, "trigger_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Trigger Id" } }, "required": [ "brand_id", "action" ], "title": "manage_reddit_triggerArguments", "type": "object" }, "annotations": { "title": "Manage a Reddit Trigger", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": false, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "action": { "enum": [ "add", "remove" ], "title": "Action", "type": "string" }, "keyword": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Keyword" }, "trigger_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Trigger Id" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id", "action" ], "title": "manage_reddit_triggerArguments", "type": "object" } } }, { "id": "mcp:authenticated:manage_tracked_article", "surface": "api", "heading": "Authenticated MCP tool: manage_tracked_article", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "manage_tracked_article", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "action": { "enum": [ "track", "stop", "restore" ], "title": "Action", "type": "string" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" }, "article_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Article Id" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" }, "prompt_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Prompt Ids" }, "published_on": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Published On" } }, "required": [ "brand_id", "action" ], "title": "manage_tracked_articleArguments", "type": "object" }, "annotations": { "title": "Manage a Tracked Article", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": false, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "action": { "enum": [ "track", "stop", "restore" ], "title": "Action", "type": "string" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" }, "article_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Article Id" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" }, "prompt_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Prompt Ids" }, "published_on": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Published On" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id", "action" ], "title": "manage_tracked_articleArguments", "type": "object" } } }, { "id": "mcp:authenticated:manage_webhook", "surface": "api", "heading": "Authenticated MCP tool: manage_webhook", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "manage_webhook", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "action": { "enum": [ "list", "get", "create", "delete", "test" ], "title": "Action", "type": "string" }, "webhook_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Webhook Id" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" }, "events": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Events" }, "signing_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Signing Secret" } }, "required": [ "brand_id", "action" ], "title": "manage_webhookArguments", "type": "object" }, "annotations": { "title": "Manage a Webhook", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": false, "openWorldHint": true }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "action": { "enum": [ "list", "get", "create", "delete", "test" ], "title": "Action", "type": "string" }, "webhook_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Webhook Id" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" }, "events": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Events" }, "signing_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Signing Secret" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id", "action" ], "title": "manage_webhookArguments", "type": "object" } } }, { "id": "mcp:authenticated:manage_workflow", "surface": "api", "heading": "Authenticated MCP tool: manage_workflow", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "manage_workflow", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "action": { "enum": [ "pause", "resume", "delete", "from_template" ], "title": "Action", "type": "string" }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workflow Id" }, "template_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Template Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" } }, "required": [ "brand_id", "action" ], "title": "manage_workflowArguments", "type": "object" }, "annotations": { "title": "Manage a Workflow", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": false, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "action": { "enum": [ "pause", "resume", "delete", "from_template" ], "title": "Action", "type": "string" }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workflow Id" }, "template_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Template Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id", "action" ], "title": "manage_workflowArguments", "type": "object" } } }, { "id": "mcp:authenticated:mark_notifications_read", "surface": "api", "heading": "Authenticated MCP tool: mark_notifications_read", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "mark_notifications_read", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "notification_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Notification Ids" }, "mark_all": { "default": false, "title": "Mark All", "type": "boolean" } }, "required": [ "brand_id" ], "title": "mark_notifications_readArguments", "type": "object" }, "annotations": { "title": "Mark Notifications Read", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "notification_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Notification Ids" }, "mark_all": { "default": false, "title": "Mark All", "type": "boolean" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "mark_notifications_readArguments", "type": "object" } } }, { "id": "mcp:authenticated:preview_crawler_access_fix", "surface": "api", "heading": "Authenticated MCP tool: preview_crawler_access_fix", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "preview_crawler_access_fix", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "finding_id": { "title": "Finding Id", "type": "string" }, "range_preset": { "default": "30d", "enum": [ "24h", "7d", "30d", "90d", "custom" ], "title": "Range Preset", "type": "string" }, "start_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Start Date" }, "end_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "End Date" } }, "required": [ "brand_id", "finding_id" ], "title": "preview_crawler_access_fixArguments", "type": "object" }, "annotations": { "title": "Preview a Crawler Access Fix", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "finding_id": { "title": "Finding Id", "type": "string" }, "range_preset": { "default": "30d", "enum": [ "24h", "7d", "30d", "90d", "custom" ], "title": "Range Preset", "type": "string" }, "start_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Start Date" }, "end_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "End Date" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id", "finding_id" ], "title": "preview_crawler_access_fixArguments", "type": "object" } } }, { "id": "mcp:authenticated:report_unmet_need", "surface": "api", "heading": "Authenticated MCP tool: report_unmet_need", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "report_unmet_need", "inputSchema": { "properties": { "user_request": { "title": "User Request", "type": "string" }, "missing_capability": { "title": "Missing Capability", "type": "string" }, "attempted_tools": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Attempted Tools" } }, "required": [ "user_request", "missing_capability" ], "title": "report_unmet_needArguments", "type": "object" }, "annotations": { "title": "Report an Unmet Need", "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false }, "hostedInputSchema": { "properties": { "user_request": { "title": "User Request", "type": "string" }, "missing_capability": { "title": "Missing Capability", "type": "string" }, "attempted_tools": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Attempted Tools" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "user_request", "missing_capability" ], "title": "report_unmet_needArguments", "type": "object" } } }, { "id": "mcp:authenticated:run_diagnosis", "surface": "api", "heading": "Authenticated MCP tool: run_diagnosis", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "run_diagnosis", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "query": { "title": "Query", "type": "string" } }, "required": [ "brand_id", "query" ], "title": "run_diagnosisArguments", "type": "object" }, "annotations": { "title": "Run a Site Diagnosis", "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": true }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "query": { "title": "Query", "type": "string" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id", "query" ], "title": "run_diagnosisArguments", "type": "object" } } }, { "id": "mcp:authenticated:run_research_snapshot", "surface": "api", "heading": "Authenticated MCP tool: run_research_snapshot", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "run_research_snapshot", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "topic": { "title": "Topic", "type": "string" }, "topic_context": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Topic Context" } }, "required": [ "brand_id", "topic" ], "title": "run_research_snapshotArguments", "type": "object" }, "annotations": { "title": "Run a Research Snapshot", "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": true }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "topic": { "title": "Topic", "type": "string" }, "topic_context": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Topic Context" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id", "topic" ], "title": "run_research_snapshotArguments", "type": "object" } } }, { "id": "mcp:authenticated:scan_reddit", "surface": "api", "heading": "Authenticated MCP tool: scan_reddit", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "scan_reddit", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" } }, "required": [ "brand_id" ], "title": "scan_redditArguments", "type": "object" }, "annotations": { "title": "Scan Reddit", "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": true }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "scan_redditArguments", "type": "object" } } }, { "id": "mcp:authenticated:send_crawler_verification_ping", "surface": "api", "heading": "Authenticated MCP tool: send_crawler_verification_ping", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "send_crawler_verification_ping", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" } }, "required": [ "brand_id" ], "title": "send_crawler_verification_pingArguments", "type": "object" }, "annotations": { "title": "Send a Crawler Verification Ping", "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": true }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "send_crawler_verification_pingArguments", "type": "object" } } }, { "id": "mcp:authenticated:set_brand_location", "surface": "api", "heading": "Authenticated MCP tool: set_brand_location", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "set_brand_location", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "country": { "title": "Country", "type": "string" }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Region" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "City" } }, "required": [ "brand_id", "country" ], "title": "set_brand_locationArguments", "type": "object" }, "annotations": { "title": "Set Brand Location", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "country": { "title": "Country", "type": "string" }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Region" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "City" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id", "country" ], "title": "set_brand_locationArguments", "type": "object" } } }, { "id": "mcp:authenticated:submit_crawler_to_search", "surface": "api", "heading": "Authenticated MCP tool: submit_crawler_to_search", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "submit_crawler_to_search", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "urls": { "title": "Urls", "type": "string" } }, "required": [ "brand_id", "urls" ], "title": "submit_crawler_to_searchArguments", "type": "object" }, "annotations": { "title": "Submit Pages to Search Engines", "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": true }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "urls": { "title": "Urls", "type": "string" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id", "urls" ], "title": "submit_crawler_to_searchArguments", "type": "object" } } }, { "id": "mcp:authenticated:suggest_prompts", "surface": "api", "heading": "Authenticated MCP tool: suggest_prompts", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "suggest_prompts", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "focus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Focus" }, "limit": { "default": 8, "maximum": 10, "minimum": 1, "title": "Limit", "type": "integer" } }, "required": [ "brand_id" ], "title": "suggest_promptsArguments", "type": "object" }, "annotations": { "title": "Suggest Prompts", "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": true }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "focus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Focus" }, "limit": { "default": 8, "maximum": 10, "minimum": 1, "title": "Limit", "type": "integer" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id" ], "title": "suggest_promptsArguments", "type": "object" } } }, { "id": "mcp:authenticated:update_brand_aliases", "surface": "api", "heading": "Authenticated MCP tool: update_brand_aliases", "route": "/learn/api/mcp", "anchor": "tools", "url": "/learn/api/mcp#tools", "contract": { "name": "update_brand_aliases", "inputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "aliases": { "title": "Aliases", "type": "string" }, "action": { "default": "add", "enum": [ "add", "remove", "set" ], "title": "Action", "type": "string" } }, "required": [ "brand_id", "aliases" ], "title": "update_brand_aliasesArguments", "type": "object" }, "annotations": { "title": "Update Brand Aliases", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": false }, "hostedInputSchema": { "properties": { "brand_id": { "title": "Brand Id", "type": "string" }, "aliases": { "title": "Aliases", "type": "string" }, "action": { "default": "add", "enum": [ "add", "remove", "set" ], "title": "Action", "type": "string" }, "user_intent": { "type": "string", "maxLength": 600 } }, "required": [ "brand_id", "aliases" ], "title": "update_brand_aliasesArguments", "type": "object" } } }, { "id": "mcp:public:fetch", "surface": "api", "heading": "Public MCP tool: fetch", "route": "/learn/api/mcp", "anchor": "public-knowledge-mcp", "url": "/learn/api/mcp#public-knowledge-mcp", "contract": { "name": "fetch", "inputSchema": { "properties": { "id": { "title": "Id", "type": "string" } }, "required": [ "id" ], "title": "fetchArguments", "type": "object" }, "outputSchema": { "additionalProperties": true, "title": "fetchDictOutput", "type": "object" }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false } }, "public_description": "Fetch full citeable public Trakkr content by id returned from search." }, { "id": "mcp:public:get_authenticated_mcp_setup", "surface": "api", "heading": "Public MCP tool: get_authenticated_mcp_setup", "route": "/learn/api/mcp", "anchor": "public-knowledge-mcp", "url": "/learn/api/mcp#public-knowledge-mcp", "contract": { "name": "get_authenticated_mcp_setup", "inputSchema": { "properties": { "client": { "default": "chatgpt", "title": "Client", "type": "string" } }, "title": "get_authenticated_mcp_setupArguments", "type": "object" }, "outputSchema": { "additionalProperties": true, "title": "get_authenticated_mcp_setupDictOutput", "type": "object" }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false } }, "public_description": "Explain when and how to connect the paid authenticated Trakkr MCP." }, { "id": "mcp:public:get_public_dataset", "surface": "api", "heading": "Public MCP tool: get_public_dataset", "route": "/learn/api/mcp", "anchor": "public-knowledge-mcp", "url": "/learn/api/mcp#public-knowledge-mcp", "contract": { "name": "get_public_dataset", "inputSchema": { "properties": { "key": { "title": "Key", "type": "string" } }, "required": [ "key" ], "title": "get_public_datasetArguments", "type": "object" }, "outputSchema": { "additionalProperties": true, "title": "get_public_datasetDictOutput", "type": "object" }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false } }, "public_description": "Return metadata and download URLs for a whitelisted public Trakkr dataset." }, { "id": "mcp:public:search", "surface": "api", "heading": "Public MCP tool: search", "route": "/learn/api/mcp", "anchor": "public-knowledge-mcp", "url": "/learn/api/mcp#public-knowledge-mcp", "contract": { "name": "search", "inputSchema": { "properties": { "query": { "title": "Query", "type": "string" } }, "required": [ "query" ], "title": "searchArguments", "type": "object" }, "outputSchema": { "additionalProperties": true, "title": "searchDictOutput", "type": "object" }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false } }, "public_description": "Search Trakkr's public marketing, docs, research and dataset corpus. Call this before fetch." } ], "revision": "28173ff7112a016e4d2c91a0ace2ae4144b8b9366d0716ae5446944da7a3b685" }