{ "openapi": "3.1.0", "info": { "title": "Visiblee Public API", "version": "1.0.0", "description": "Read-only API for core Visiblee dashboard data." }, "servers": [ { "url": "https://api.visiblee.ai/v1/public" } ], "security": [ { "ApiKeyAuth": [] } ], "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-API-Key", "description": "Visiblee API key from the Developer API portal." } }, "schemas": { "SegmentSuggestionOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "project_id": { "type": "string", "format": "uuid", "title": "Project Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "status": { "type": "string", "title": "Status" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "accepted_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Accepted At" }, "dismissed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Dismissed At" } }, "type": "object", "required": [ "id", "project_id", "name", "status", "created_at" ], "title": "SegmentSuggestionOut" }, "SegmentPromptMapping": { "properties": { "prompt_id": { "type": "string", "format": "uuid", "title": "Prompt Id" }, "prompt": { "type": "string", "title": "Prompt" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" }, "applies": { "type": "boolean", "title": "Applies" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" } }, "type": "object", "required": [ "prompt_id", "prompt", "applies" ], "title": "SegmentPromptMapping" }, "EngineOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "provider": { "type": "string", "title": "Provider" }, "model": { "type": "string", "title": "Model" }, "display_name": { "type": "string", "title": "Display Name" }, "surface": { "type": "string", "title": "Surface" }, "active": { "type": "boolean", "title": "Active" } }, "type": "object", "required": [ "id", "provider", "model", "display_name", "surface", "active" ], "title": "EngineOut" }, "MentionOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "response_id": { "type": "string", "format": "uuid", "title": "Response Id" }, "entity_name": { "type": "string", "title": "Entity Name" }, "entity_type": { "type": "string", "title": "Entity Type" }, "matched_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Matched Term" }, "rank_position": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rank Position" }, "sentiment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sentiment" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "confidence": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Confidence" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "response_id", "entity_name", "entity_type", "matched_term", "rank_position", "sentiment", "description", "confidence", "created_at" ], "title": "MentionOut" }, "RunGroupDetail": { "properties": { "run_group": { "$ref": "#/components/schemas/RunGroupOut" }, "prompt_runs": { "items": { "$ref": "#/components/schemas/PromptRunOut" }, "type": "array", "title": "Prompt Runs" } }, "type": "object", "required": [ "run_group", "prompt_runs" ], "title": "RunGroupDetail" }, "PromptRunOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "run_group_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Run Group Id" }, "project_id": { "type": "string", "format": "uuid", "title": "Project Id" }, "prompt_id": { "type": "string", "format": "uuid", "title": "Prompt Id" }, "engine_id": { "type": "string", "format": "uuid", "title": "Engine Id" }, "status": { "type": "string", "title": "Status" }, "scheduled_for": { "type": "string", "format": "date-time", "title": "Scheduled For" }, "started_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Started At" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At" }, "latency_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Latency Ms" }, "cost_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cost Usd" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "run_group_id", "project_id", "prompt_id", "engine_id", "status", "scheduled_for", "started_at", "completed_at", "latency_ms", "cost_usd", "error", "created_at" ], "title": "PromptRunOut" }, "RunGroupOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "project_id": { "type": "string", "format": "uuid", "title": "Project Id" }, "run_type": { "type": "string", "title": "Run Type" }, "status": { "type": "string", "title": "Status" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At" }, "total_runs": { "type": "integer", "title": "Total Runs", "default": 0 }, "completed_runs": { "type": "integer", "title": "Completed Runs", "default": 0 } }, "type": "object", "required": [ "id", "project_id", "run_type", "status", "created_at", "completed_at" ], "title": "RunGroupOut" }, "TopicDetail": { "properties": { "label": { "type": "string", "title": "Label" }, "kind": { "type": "string", "title": "Kind" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "answer_count": { "type": "integer", "title": "Answer Count" }, "own_score": { "type": "number", "title": "Own Score" }, "own_mention_rate": { "type": "number", "title": "Own Mention Rate" }, "own_average_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Own Average Rank" }, "own_avg_sentiment": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Own Avg Sentiment" }, "overall_rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Overall Rank" }, "entity_count": { "type": "integer", "title": "Entity Count" }, "entities": { "items": { "$ref": "#/components/schemas/TopicEntityStat" }, "type": "array", "title": "Entities" }, "by_model": { "items": { "$ref": "#/components/schemas/TopicModelStat" }, "type": "array", "title": "By Model" }, "evidence": { "items": { "$ref": "#/components/schemas/TopicEvidence" }, "type": "array", "title": "Evidence" } }, "type": "object", "required": [ "label", "kind", "answer_count", "own_score", "own_mention_rate", "entity_count", "entities", "by_model", "evidence" ], "title": "TopicDetail" }, "TopicEvidence": { "properties": { "evidence": { "type": "string", "title": "Evidence" }, "engine_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Engine Id" }, "engine": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Engine" } }, "type": "object", "required": [ "evidence" ], "title": "TopicEvidence", "description": "A supporting snippet where the answer cited this topic as a reason." }, "TopicModelStat": { "properties": { "engine_id": { "type": "string", "format": "uuid", "title": "Engine Id" }, "engine": { "type": "string", "title": "Engine" }, "own_mention_rate": { "type": "number", "title": "Own Mention Rate" }, "own_average_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Own Average Rank" }, "own_score": { "type": "number", "title": "Own Score" }, "top_competitor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Top Competitor" } }, "type": "object", "required": [ "engine_id", "engine", "own_mention_rate", "own_score" ], "title": "TopicModelStat", "description": "A topic's competitive picture broken down per engine/model." }, "TopicEntityStat": { "properties": { "entity_name": { "type": "string", "title": "Entity Name" }, "entity_type": { "type": "string", "title": "Entity Type" }, "mention_count": { "type": "integer", "title": "Mention Count" }, "mention_rate": { "type": "number", "title": "Mention Rate" }, "top_pick_count": { "type": "integer", "title": "Top Pick Count", "default": 0 }, "average_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Rank" }, "avg_sentiment": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Avg Sentiment" }, "score": { "type": "number", "title": "Score" } }, "type": "object", "required": [ "entity_name", "entity_type", "mention_count", "mention_rate", "score" ], "title": "TopicEntityStat", "description": "One tool's standing within a single topic (powers the per-topic bar chart)." }, "ReferrerRanking": { "properties": { "domain": { "type": "string", "title": "Domain" }, "citation_count": { "type": "integer", "title": "Citation Count" }, "share": { "type": "number", "title": "Share" } }, "type": "object", "required": [ "domain", "citation_count", "share" ], "title": "ReferrerRanking" }, "ProjectRegionSetRequest": { "properties": { "region_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "minItems": 1, "title": "Region Ids" } }, "type": "object", "required": [ "region_ids" ], "title": "ProjectRegionSetRequest" }, "PromptRunDetail": { "properties": { "prompt_run": { "$ref": "#/components/schemas/PromptRunOut" }, "response": { "anyOf": [ { "$ref": "#/components/schemas/ResponseOut" }, { "type": "null" } ] } }, "type": "object", "required": [ "prompt_run" ], "title": "PromptRunDetail" }, "ResponseOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "prompt_run_id": { "type": "string", "format": "uuid", "title": "Prompt Run Id" }, "raw_text": { "type": "string", "title": "Raw Text" }, "model_used": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Used" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "prompt_run_id", "raw_text", "model_used", "provider", "created_at" ], "title": "ResponseOut" }, "RunGroupResults": { "properties": { "run_group": { "$ref": "#/components/schemas/RunGroupOut" }, "results": { "items": { "$ref": "#/components/schemas/RunResult" }, "type": "array", "title": "Results" } }, "type": "object", "required": [ "run_group", "results" ], "title": "RunGroupResults" }, "RunResult": { "properties": { "prompt_run_id": { "type": "string", "format": "uuid", "title": "Prompt Run Id" }, "prompt": { "type": "string", "title": "Prompt" }, "engine": { "type": "string", "title": "Engine" }, "status": { "type": "string", "title": "Status" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At" }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Score" }, "mentioned": { "type": "boolean", "title": "Mentioned", "default": false }, "rank_position": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rank Position" }, "sentiment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sentiment" }, "latency_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Latency Ms" }, "cost_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cost Usd" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "answer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Answer" }, "answer_summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Answer Summary" }, "mentions": { "items": { "$ref": "#/components/schemas/RunResultMention" }, "type": "array", "title": "Mentions", "default": [] }, "citations": { "items": { "$ref": "#/components/schemas/RunResultCitation" }, "type": "array", "title": "Citations", "default": [] }, "search_queries": { "items": { "type": "string" }, "type": "array", "title": "Search Queries", "default": [] }, "sources": { "items": { "$ref": "#/components/schemas/RunResultSource" }, "type": "array", "title": "Sources", "default": [] }, "research": { "items": { "$ref": "#/components/schemas/ResearchStep" }, "type": "array", "title": "Research", "default": [] }, "competitors": { "items": { "$ref": "#/components/schemas/CompetitorMention" }, "type": "array", "title": "Competitors", "default": [] } }, "type": "object", "required": [ "prompt_run_id", "prompt", "engine", "status" ], "title": "RunResult" }, "CompetitorMention": { "properties": { "name": { "type": "string", "title": "Name" }, "sentiment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sentiment" }, "rank_position": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rank Position" } }, "type": "object", "required": [ "name" ], "title": "CompetitorMention" }, "ResearchStep": { "properties": { "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Query" }, "sources": { "items": { "$ref": "#/components/schemas/RunResultSource" }, "type": "array", "title": "Sources", "default": [] } }, "type": "object", "title": "ResearchStep", "description": "A question the engine researched, plus the sources it pulled in to answer it." }, "RunResultSource": { "properties": { "stage": { "type": "string", "title": "Stage" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Query" } }, "type": "object", "required": [ "stage" ], "title": "RunResultSource" }, "RunResultCitation": { "properties": { "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" } }, "type": "object", "title": "RunResultCitation" }, "RunResultMention": { "properties": { "entity_name": { "type": "string", "title": "Entity Name" }, "entity_type": { "type": "string", "title": "Entity Type" }, "rank_position": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rank Position" }, "sentiment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sentiment" } }, "type": "object", "required": [ "entity_name", "entity_type" ], "title": "RunResultMention" }, "ProjectOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "company_id": { "type": "string", "format": "uuid", "title": "Company Id" }, "name": { "type": "string", "title": "Name" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "category_summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category Summary" }, "status": { "type": "string", "title": "Status" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" } }, "type": "object", "required": [ "id", "company_id", "name", "domain", "description", "category_summary", "status", "created_at", "updated_at" ], "title": "ProjectOut" }, "RegionUsageOut": { "properties": { "active_prompts": { "type": "integer", "title": "Active Prompts" }, "tracked_regions": { "type": "integer", "title": "Tracked Regions" }, "effective_prompts": { "type": "integer", "title": "Effective Prompts" }, "limit": { "type": "integer", "title": "Limit" }, "plan": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Plan" } }, "type": "object", "required": [ "active_prompts", "tracked_regions", "effective_prompts", "limit" ], "title": "RegionUsageOut" }, "PromptSuggestionOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "project_id": { "type": "string", "format": "uuid", "title": "Project Id" }, "text": { "type": "string", "title": "Text" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" }, "intent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Intent" }, "importance": { "type": "integer", "title": "Importance" }, "status": { "type": "string", "title": "Status" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "accepted_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Accepted At" }, "dismissed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Dismissed At" } }, "type": "object", "required": [ "id", "project_id", "text", "importance", "status", "created_at" ], "title": "PromptSuggestionOut" }, "PromptOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "project_id": { "type": "string", "format": "uuid", "title": "Project Id" }, "text": { "type": "string", "title": "Text" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" }, "intent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Intent" }, "importance": { "type": "integer", "title": "Importance" }, "active": { "type": "boolean", "title": "Active" }, "source": { "type": "string", "title": "Source" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" } }, "type": "object", "required": [ "id", "project_id", "text", "category", "intent", "importance", "active", "source", "created_at", "updated_at" ], "title": "PromptOut" }, "ProjectEngineSetRequest": { "properties": { "engine_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "minItems": 1, "title": "Engine Ids" } }, "type": "object", "required": [ "engine_ids" ], "title": "ProjectEngineSetRequest" }, "PromptUpdate": { "properties": { "text": { "anyOf": [ { "type": "string", "maxLength": 600, "minLength": 1 }, { "type": "null" } ], "title": "Text" }, "category": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ], "title": "Category" }, "intent": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ], "title": "Intent" }, "importance": { "anyOf": [ { "type": "integer", "maximum": 5.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Importance" }, "active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Active" } }, "type": "object", "title": "PromptUpdate" }, "SuggestionOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "type": { "type": "string", "title": "Type" }, "title": { "type": "string", "title": "Title" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Detail" }, "rationale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rationale" }, "priority": { "type": "integer", "title": "Priority" }, "status": { "type": "string", "title": "Status" }, "evidence": { "additionalProperties": true, "type": "object", "title": "Evidence", "default": {} }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "resolved_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Resolved At" }, "dismissed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Dismissed At" } }, "type": "object", "required": [ "id", "type", "title", "priority", "status", "created_at" ], "title": "SuggestionOut" }, "PublicRedditLead": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "subreddit_name": { "type": "string", "title": "Subreddit Name" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "body": { "type": "string", "title": "Body" }, "permalink": { "type": "string", "title": "Permalink" }, "author": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author" }, "matched_terms": { "items": { "type": "string" }, "type": "array", "title": "Matched Terms" }, "total_score": { "type": "integer", "title": "Total Score" }, "reddit_score": { "type": "integer", "title": "Reddit Score" }, "reddit_num_comments": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Reddit Num Comments" }, "discovered_at": { "type": "string", "format": "date-time", "title": "Discovered At" }, "is_lead": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Lead" }, "relevance_score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Relevance Score" }, "relevance_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Relevance Reason" } }, "type": "object", "required": [ "id", "subreddit_name", "title", "body", "permalink", "author", "matched_terms", "total_score", "reddit_score", "reddit_num_comments", "discovered_at" ], "title": "PublicRedditLead", "description": "A Reddit thread where the brand could plausibly join the conversation.\n\nA lean, public-safe projection of an internal RedditOpportunity (no\nreview/curation internals exposed)." }, "DailyScoreOut": { "properties": { "date": { "type": "string", "format": "date", "title": "Date" }, "visibility_score": { "type": "number", "title": "Visibility Score" }, "mention_rate": { "type": "number", "title": "Mention Rate" }, "average_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Rank" }, "positive_sentiment_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Positive Sentiment Rate" }, "prompt_count": { "type": "integer", "title": "Prompt Count" }, "run_count": { "type": "integer", "title": "Run Count" } }, "type": "object", "required": [ "date", "visibility_score", "mention_rate", "average_rank", "positive_sentiment_rate", "prompt_count", "run_count" ], "title": "DailyScoreOut" }, "PublicCompetitors": { "properties": { "competitors": { "items": { "$ref": "#/components/schemas/CompetitorOut" }, "type": "array", "title": "Competitors" }, "rankings": { "items": { "$ref": "#/components/schemas/CompetitorRanking" }, "type": "array", "title": "Rankings" } }, "type": "object", "required": [ "competitors", "rankings" ], "title": "PublicCompetitors" }, "CompetitorRanking": { "properties": { "name": { "type": "string", "title": "Name" }, "mention_count": { "type": "integer", "title": "Mention Count" }, "mention_rate": { "type": "number", "title": "Mention Rate" }, "average_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Rank" }, "avg_sentiment": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Avg Sentiment" }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Score" } }, "type": "object", "required": [ "name", "mention_count", "mention_rate" ], "title": "CompetitorRanking" }, "CompetitorOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "project_id": { "type": "string", "format": "uuid", "title": "Project Id" }, "name": { "type": "string", "title": "Name" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain" }, "aliases": { "items": { "type": "string" }, "type": "array", "title": "Aliases", "default": [] }, "source": { "type": "string", "title": "Source" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" } }, "type": "object", "required": [ "id", "project_id", "name", "domain", "source", "created_at", "updated_at" ], "title": "CompetitorOut" }, "PromptDetail": { "properties": { "prompt_id": { "type": "string", "format": "uuid", "title": "Prompt Id" }, "prompt": { "type": "string", "title": "Prompt" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" }, "intent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Intent" }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Score" }, "mention_rate": { "type": "number", "title": "Mention Rate" }, "average_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Rank" }, "sentiment": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Sentiment" }, "rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rank" }, "competitor_count": { "type": "integer", "title": "Competitor Count" }, "top_competitors": { "items": { "$ref": "#/components/schemas/PromptCompetitorStat" }, "type": "array", "title": "Top Competitors" }, "by_model": { "items": { "$ref": "#/components/schemas/PromptModelStat" }, "type": "array", "title": "By Model" }, "by_segment": { "items": { "$ref": "#/components/schemas/PromptSegmentStat" }, "type": "array", "title": "By Segment" } }, "type": "object", "required": [ "prompt_id", "prompt", "mention_rate", "competitor_count", "top_competitors", "by_model", "by_segment" ], "title": "PromptDetail" }, "PromptSegmentStat": { "properties": { "segment_id": { "type": "string", "format": "uuid", "title": "Segment Id" }, "name": { "type": "string", "title": "Name" }, "spend_propensity": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Spend Propensity" }, "buyer_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Buyer Type" }, "applies": { "type": "boolean", "title": "Applies" }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Score" }, "mention_rate": { "type": "number", "title": "Mention Rate", "default": 0.0 }, "average_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Rank" }, "avg_sentiment": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Avg Sentiment" }, "rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rank" }, "prompt_count": { "type": "integer", "title": "Prompt Count", "default": 0 } }, "type": "object", "required": [ "segment_id", "name", "applies" ], "title": "PromptSegmentStat" }, "PromptModelStat": { "properties": { "engine_id": { "type": "string", "format": "uuid", "title": "Engine Id" }, "engine": { "type": "string", "title": "Engine" }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Score" }, "mention_rate": { "type": "number", "title": "Mention Rate" }, "average_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Rank" }, "avg_sentiment": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Avg Sentiment" } }, "type": "object", "required": [ "engine_id", "engine", "mention_rate" ], "title": "PromptModelStat" }, "PromptCompetitorStat": { "properties": { "name": { "type": "string", "title": "Name" }, "mention_rate": { "type": "number", "title": "Mention Rate" }, "average_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Rank" }, "avg_sentiment": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Avg Sentiment" }, "score": { "type": "number", "title": "Score" }, "rank": { "type": "integer", "title": "Rank" } }, "type": "object", "required": [ "name", "mention_rate", "score", "rank" ], "title": "PromptCompetitorStat" }, "RegionOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "code": { "type": "string", "title": "Code" }, "name": { "type": "string", "title": "Name" }, "sort_order": { "type": "integer", "title": "Sort Order" }, "active": { "type": "boolean", "title": "Active" } }, "type": "object", "required": [ "id", "code", "name", "sort_order", "active" ], "title": "RegionOut" }, "CompetitorDetail": { "properties": { "name": { "type": "string", "title": "Name" }, "score": { "type": "number", "title": "Score" }, "mention_count": { "type": "integer", "title": "Mention Count" }, "mention_rate": { "type": "number", "title": "Mention Rate" }, "average_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Rank" }, "avg_sentiment": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Avg Sentiment" }, "overall_rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Overall Rank" }, "competitor_count": { "type": "integer", "title": "Competitor Count" }, "top_prompts": { "items": { "$ref": "#/components/schemas/CompetitorPromptStat" }, "type": "array", "title": "Top Prompts" }, "segments": { "items": { "$ref": "#/components/schemas/CompetitorSegmentStat" }, "type": "array", "title": "Segments" }, "by_model": { "items": { "$ref": "#/components/schemas/CompetitorModelStat" }, "type": "array", "title": "By Model" } }, "type": "object", "required": [ "name", "score", "mention_count", "mention_rate", "competitor_count", "top_prompts", "segments", "by_model" ], "title": "CompetitorDetail" }, "CompetitorModelStat": { "properties": { "engine_id": { "type": "string", "format": "uuid", "title": "Engine Id" }, "engine": { "type": "string", "title": "Engine" }, "mention_rate": { "type": "number", "title": "Mention Rate" }, "average_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Rank" }, "avg_sentiment": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Avg Sentiment" }, "score": { "type": "number", "title": "Score" } }, "type": "object", "required": [ "engine_id", "engine", "mention_rate", "score" ], "title": "CompetitorModelStat" }, "CompetitorSegmentStat": { "properties": { "segment_id": { "type": "string", "format": "uuid", "title": "Segment Id" }, "name": { "type": "string", "title": "Name" }, "spend_propensity": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Spend Propensity" }, "buyer_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Buyer Type" }, "rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rank" }, "competitor_count": { "type": "integer", "title": "Competitor Count" }, "mention_rate": { "type": "number", "title": "Mention Rate" }, "average_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Rank" }, "score": { "type": "number", "title": "Score" } }, "type": "object", "required": [ "segment_id", "name", "competitor_count", "mention_rate", "score" ], "title": "CompetitorSegmentStat" }, "CompetitorPromptStat": { "properties": { "prompt_id": { "type": "string", "format": "uuid", "title": "Prompt Id" }, "prompt": { "type": "string", "title": "Prompt" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" }, "mention_count": { "type": "integer", "title": "Mention Count" }, "mention_rate": { "type": "number", "title": "Mention Rate" }, "average_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Rank" }, "rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rank" }, "competitor_count": { "type": "integer", "title": "Competitor Count", "default": 0 }, "score": { "type": "number", "title": "Score" } }, "type": "object", "required": [ "prompt_id", "prompt", "mention_count", "mention_rate", "score" ], "title": "CompetitorPromptStat" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "PublicTopics": { "properties": { "topics": { "items": { "$ref": "#/components/schemas/TopicOut" }, "type": "array", "title": "Topics" }, "rankings": { "items": { "$ref": "#/components/schemas/TopicRanking" }, "type": "array", "title": "Rankings" } }, "type": "object", "required": [ "topics", "rankings" ], "title": "PublicTopics" }, "TopicRanking": { "properties": { "label": { "type": "string", "title": "Label" }, "kind": { "type": "string", "title": "Kind" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "answer_count": { "type": "integer", "title": "Answer Count" }, "own_mention_count": { "type": "integer", "title": "Own Mention Count", "default": 0 }, "own_mention_rate": { "type": "number", "title": "Own Mention Rate", "default": 0.0 }, "own_top_pick_count": { "type": "integer", "title": "Own Top Pick Count", "default": 0 }, "own_average_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Own Average Rank" }, "own_avg_sentiment": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Own Avg Sentiment" }, "own_score": { "type": "number", "title": "Own Score", "default": 0.0 }, "strength": { "type": "string", "title": "Strength", "default": "absent" }, "top_competitor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Top Competitor" }, "competitor_count": { "type": "integer", "title": "Competitor Count", "default": 0 } }, "type": "object", "required": [ "label", "kind", "answer_count" ], "title": "TopicRanking", "description": "One topic in the leaderboard, summarising where the tracked brand stands on it." }, "TopicOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "project_id": { "type": "string", "format": "uuid", "title": "Project Id" }, "label": { "type": "string", "title": "Label" }, "kind": { "type": "string", "title": "Kind" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "aliases": { "items": { "type": "string" }, "type": "array", "title": "Aliases", "default": [] }, "source": { "type": "string", "title": "Source" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" } }, "type": "object", "required": [ "id", "project_id", "label", "kind", "source", "created_at", "updated_at" ], "title": "TopicOut" }, "PublicSegments": { "properties": { "segments": { "items": { "$ref": "#/components/schemas/SegmentOut" }, "type": "array", "title": "Segments" }, "analytics": { "items": { "$ref": "#/components/schemas/SegmentVisibility" }, "type": "array", "title": "Analytics" } }, "type": "object", "required": [ "segments", "analytics" ], "title": "PublicSegments" }, "SegmentVisibility": { "properties": { "segment_id": { "type": "string", "format": "uuid", "title": "Segment Id" }, "name": { "type": "string", "title": "Name" }, "spend_propensity": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Spend Propensity" }, "buyer_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Buyer Type" }, "importance": { "type": "integer", "title": "Importance" }, "analysis_status": { "type": "string", "title": "Analysis Status" }, "current_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Current Score" }, "score_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Score Change" }, "mention_rate": { "type": "number", "title": "Mention Rate", "default": 0.0 }, "mention_rate_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Mention Rate Change" }, "average_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Rank" }, "prompt_count": { "type": "integer", "title": "Prompt Count", "default": 0 }, "run_count": { "type": "integer", "title": "Run Count", "default": 0 } }, "type": "object", "required": [ "segment_id", "name", "importance", "analysis_status" ], "title": "SegmentVisibility" }, "SegmentOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "project_id": { "type": "string", "format": "uuid", "title": "Project Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "ai_summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ai Summary" }, "spend_propensity": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Spend Propensity" }, "buyer_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Buyer Type" }, "importance": { "type": "integer", "title": "Importance" }, "source": { "type": "string", "title": "Source" }, "active": { "type": "boolean", "title": "Active" }, "analysis_status": { "type": "string", "title": "Analysis Status" }, "prompt_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Prompt Count" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" } }, "type": "object", "required": [ "id", "project_id", "name", "importance", "source", "active", "analysis_status", "created_at", "updated_at" ], "title": "SegmentOut" }, "PublicProjectDetail": { "properties": { "project": { "$ref": "#/components/schemas/ProjectOut" }, "terms": { "items": { "$ref": "#/components/schemas/TermOut" }, "type": "array", "title": "Terms" }, "engines": { "items": { "$ref": "#/components/schemas/EngineOut" }, "type": "array", "title": "Engines" }, "regions": { "items": { "$ref": "#/components/schemas/RegionOut" }, "type": "array", "title": "Regions" } }, "type": "object", "required": [ "project", "terms", "engines", "regions" ], "title": "PublicProjectDetail" }, "TermOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "project_id": { "type": "string", "format": "uuid", "title": "Project Id" }, "term": { "type": "string", "title": "Term" }, "term_type": { "type": "string", "title": "Term Type" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "project_id", "term", "term_type", "created_at" ], "title": "TermOut" }, "PromptHistory": { "properties": { "prompt": { "$ref": "#/components/schemas/PromptOut" }, "summary": { "$ref": "#/components/schemas/PromptHistorySummary" }, "results": { "items": { "$ref": "#/components/schemas/RunResult" }, "type": "array", "title": "Results" } }, "type": "object", "required": [ "prompt", "summary", "results" ], "title": "PromptHistory" }, "PromptHistorySummary": { "properties": { "runs": { "type": "integer", "title": "Runs" }, "mention_rate": { "type": "number", "title": "Mention Rate" }, "average_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Rank" }, "average_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Score" } }, "type": "object", "required": [ "runs", "mention_rate" ], "title": "PromptHistorySummary" }, "VisibilityTimeseries": { "properties": { "own_name": { "type": "string", "title": "Own Name" }, "competitors": { "items": { "type": "string" }, "type": "array", "title": "Competitors" }, "points": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Points" }, "score_points": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Score Points", "default": [] }, "sentiment_points": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Sentiment Points", "default": [] } }, "type": "object", "required": [ "own_name", "competitors", "points" ], "title": "VisibilityTimeseries" }, "PromptCreate": { "properties": { "text": { "type": "string", "maxLength": 600, "minLength": 1, "title": "Text" }, "category": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ], "title": "Category" }, "intent": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ], "title": "Intent" }, "importance": { "type": "integer", "maximum": 5.0, "minimum": 1.0, "title": "Importance", "default": 1 } }, "type": "object", "required": [ "text" ], "title": "PromptCreate" }, "VisibilityReport": { "properties": { "project_id": { "type": "string", "format": "uuid", "title": "Project Id" }, "current_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Current Score" }, "mention_rate": { "type": "number", "title": "Mention Rate" }, "average_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Rank" }, "sentiment": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Sentiment" }, "score_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Score Change" }, "mention_rate_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Mention Rate Change" }, "average_rank_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Rank Change" }, "sentiment_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Sentiment Change" }, "prompt_count": { "type": "integer", "title": "Prompt Count" }, "run_count": { "type": "integer", "title": "Run Count" }, "top_competitors": { "items": { "$ref": "#/components/schemas/CompetitorVisibility" }, "type": "array", "title": "Top Competitors" }, "prompt_breakdown": { "items": { "$ref": "#/components/schemas/PromptBreakdown" }, "type": "array", "title": "Prompt Breakdown" }, "engine_breakdown": { "items": { "$ref": "#/components/schemas/EngineBreakdown" }, "type": "array", "title": "Engine Breakdown" } }, "type": "object", "required": [ "project_id", "mention_rate", "prompt_count", "run_count", "top_competitors", "prompt_breakdown", "engine_breakdown" ], "title": "VisibilityReport" }, "EngineBreakdown": { "properties": { "engine_id": { "type": "string", "format": "uuid", "title": "Engine Id" }, "engine": { "type": "string", "title": "Engine" }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Score" }, "mention_rate": { "type": "number", "title": "Mention Rate" } }, "type": "object", "required": [ "engine_id", "engine", "mention_rate" ], "title": "EngineBreakdown" }, "PromptBreakdown": { "properties": { "prompt_id": { "type": "string", "format": "uuid", "title": "Prompt Id" }, "prompt": { "type": "string", "title": "Prompt" }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Score" }, "mentioned": { "type": "boolean", "title": "Mentioned" }, "mention_rate": { "type": "number", "title": "Mention Rate", "default": 0.0 }, "average_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Rank" }, "rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rank" }, "competitor_count": { "type": "integer", "title": "Competitor Count", "default": 0 }, "top_competitor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Top Competitor" }, "sentiment": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Sentiment" } }, "type": "object", "required": [ "prompt_id", "prompt", "mentioned" ], "title": "PromptBreakdown" }, "CompetitorVisibility": { "properties": { "name": { "type": "string", "title": "Name" }, "mention_rate": { "type": "number", "title": "Mention Rate" }, "average_rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Rank" } }, "type": "object", "required": [ "name", "mention_rate" ], "title": "CompetitorVisibility" }, "TopicAnswers": { "properties": { "label": { "type": "string", "title": "Label" }, "answer_count": { "type": "integer", "title": "Answer Count" }, "answers": { "items": { "$ref": "#/components/schemas/TopicAnswer" }, "type": "array", "title": "Answers" } }, "type": "object", "required": [ "label", "answer_count", "answers" ], "title": "TopicAnswers" }, "TopicAnswer": { "properties": { "response_id": { "type": "string", "format": "uuid", "title": "Response Id" }, "prompt_id": { "type": "string", "format": "uuid", "title": "Prompt Id" }, "prompt": { "type": "string", "title": "Prompt" }, "engine_id": { "type": "string", "format": "uuid", "title": "Engine Id" }, "engine": { "type": "string", "title": "Engine" }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Region" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "evidence": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evidence" }, "own_present": { "type": "boolean", "title": "Own Present", "default": false }, "answer_text": { "type": "string", "title": "Answer Text" }, "entities": { "items": { "$ref": "#/components/schemas/TopicAnswerEntity" }, "type": "array", "title": "Entities", "default": [] } }, "type": "object", "required": [ "response_id", "prompt_id", "prompt", "engine_id", "engine", "answer_text" ], "title": "TopicAnswer", "description": "One concrete answer where the topic appeared \u2014 the raw text plus the per-topic verdict.\n\nBuilt for agents/MCP to read WHY the brand does or doesn't surface for a topic: the full\nanswer, the snippet that cited the topic, and which tools the answer tied to it." }, "TopicAnswerEntity": { "properties": { "entity_name": { "type": "string", "title": "Entity Name" }, "entity_type": { "type": "string", "title": "Entity Type" }, "stance": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stance" }, "is_top_pick": { "type": "boolean", "title": "Is Top Pick", "default": false }, "rank_within_topic": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rank Within Topic" } }, "type": "object", "required": [ "entity_name", "entity_type" ], "title": "TopicAnswerEntity", "description": "How one tool was treated on this topic within a single answer." }, "SuggestionsStatusOut": { "properties": { "generating": { "type": "boolean", "title": "Generating" } }, "type": "object", "required": [ "generating" ], "title": "SuggestionsStatusOut" }, "WarmLead": { "properties": { "url": { "type": "string", "title": "Url" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain" }, "citation_count": { "type": "integer", "title": "Citation Count" }, "community": { "type": "boolean", "title": "Community", "default": false } }, "type": "object", "required": [ "url", "citation_count" ], "title": "WarmLead" }, "CitationOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "response_id": { "type": "string", "format": "uuid", "title": "Response Id" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "entity_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entity Name" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "response_id", "url", "domain", "title", "entity_name", "created_at" ], "title": "CitationOut" }, "FanoutQuery": { "properties": { "query": { "type": "string", "title": "Query" }, "tool": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tool" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" }, "occurrences": { "type": "integer", "title": "Occurrences", "default": 0 }, "sources": { "items": { "$ref": "#/components/schemas/FanoutSource" }, "type": "array", "title": "Sources", "default": [] } }, "type": "object", "required": [ "query" ], "title": "FanoutQuery", "description": "A search query an engine issued while researching, with the sources it surfaced." }, "FanoutSource": { "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "stage": { "type": "string", "title": "Stage" } }, "type": "object", "required": [ "stage" ], "title": "FanoutSource" }, "SourceRanking": { "properties": { "domain": { "type": "string", "title": "Domain" }, "citation_count": { "type": "integer", "title": "Citation Count" }, "share": { "type": "number", "title": "Share" }, "answer_count": { "type": "integer", "title": "Answer Count", "default": 0 }, "answer_share": { "type": "number", "title": "Answer Share", "default": 0.0 }, "origins": { "items": { "type": "string" }, "type": "array", "title": "Origins", "default": [] }, "is_own": { "type": "boolean", "title": "Is Own", "default": false }, "pages": { "items": { "$ref": "#/components/schemas/SourcePage" }, "type": "array", "title": "Pages", "default": [] } }, "type": "object", "required": [ "domain", "citation_count", "share" ], "title": "SourceRanking", "description": "A domain encountered while answering, with how it was met (origins) and whether it's ours.\n\nUnlike ReferrerRanking this excludes nothing \u2014 own and competitor domains are included and\nflagged \u2014 so the citations view can surface every source the engines touched." }, "SourcePage": { "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "citation_count": { "type": "integer", "title": "Citation Count" }, "answer_count": { "type": "integer", "title": "Answer Count", "default": 0 }, "origins": { "items": { "type": "string" }, "type": "array", "title": "Origins", "default": [] } }, "type": "object", "required": [ "citation_count" ], "title": "SourcePage", "description": "A single URL under a source domain \u2014 e.g. one Reddit thread under reddit.com. Lets the\ncitations view drill from an aggregated domain row into the individual pages it cited." }, "RedditMetrics": { "properties": { "total_opportunities": { "type": "integer", "title": "Total Opportunities" }, "new_opportunities": { "type": "integer", "title": "New Opportunities" }, "opportunities_today": { "type": "integer", "title": "Opportunities Today" }, "average_score": { "type": "number", "title": "Average Score" }, "last_scanned_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Scanned At" } }, "type": "object", "required": [ "total_opportunities", "new_opportunities", "opportunities_today", "average_score" ], "title": "RedditMetrics" } } }, "paths": { "/engines": { "get": { "tags": [ "public-api" ], "summary": "List engines", "operationId": "public_engines_v1_public_engines_get", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EngineOut" }, "title": "Response Public Engines V1 Public Engines Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects": { "get": { "tags": [ "public-api" ], "summary": "List projects", "operationId": "public_list_projects_v1_public_projects_get", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectOut" }, "title": "Response Public List Projects V1 Public Projects Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}": { "get": { "tags": [ "public-api" ], "summary": "Get project", "operationId": "public_get_project_v1_public_projects__project_id__get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicProjectDetail" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/citations": { "get": { "tags": [ "public-api" ], "summary": "List citations", "operationId": "public_citations_v1_public_projects__project_id__citations_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "engine_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Engine Ids" } }, { "name": "region_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Region Ids" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CitationOut" }, "title": "Response Public Citations V1 Public Projects Project Id Citations Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/competitor-detail": { "get": { "tags": [ "public-api" ], "summary": "Get competitor detail", "operationId": "public_competitor_detail_v1_public_projects__project_id__competitor_detail_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "title": "Name" } }, { "name": "engine_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Engine Ids" } }, { "name": "region_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Region Ids" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompetitorDetail" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/competitors": { "get": { "tags": [ "public-api" ], "summary": "Get competitors", "operationId": "public_competitors_v1_public_projects__project_id__competitors_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "engine_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Engine Ids" } }, { "name": "region_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Region Ids" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCompetitors" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/engines": { "put": { "tags": [ "public-api" ], "summary": "Set tracked engines", "operationId": "public_set_project_engines_v1_public_projects__project_id__engines_put", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectEngineSetRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EngineOut" }, "title": "Response Public Set Project Engines V1 Public Projects Project Id Engines Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/mentions": { "get": { "tags": [ "public-api" ], "summary": "List mentions", "operationId": "public_mentions_v1_public_projects__project_id__mentions_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "entity_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entity Type" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "engine_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Engine Ids" } }, { "name": "region_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Region Ids" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MentionOut" }, "title": "Response Public Mentions V1 Public Projects Project Id Mentions Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/prompt-detail": { "get": { "tags": [ "public-api" ], "summary": "Get prompt detail", "operationId": "public_prompt_detail_v1_public_projects__project_id__prompt_detail_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "prompt_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Prompt Id" } }, { "name": "engine_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Engine Ids" } }, { "name": "region_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Region Ids" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromptDetail" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/prompt-suggestions": { "get": { "tags": [ "public-api" ], "summary": "List prompt suggestions", "operationId": "public_prompt_suggestions_v1_public_projects__project_id__prompt_suggestions_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PromptSuggestionOut" }, "title": "Response Public Prompt Suggestions V1 Public Projects Project Id Prompt Suggestions Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/prompt-timeseries": { "get": { "tags": [ "public-api" ], "summary": "Get prompt timeseries", "operationId": "public_prompt_timeseries_v1_public_projects__project_id__prompt_timeseries_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "prompt_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Prompt Id" } }, { "name": "engine_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Engine Ids" } }, { "name": "region_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Region Ids" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisibilityTimeseries" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/prompts": { "get": { "tags": [ "public-api" ], "summary": "List prompts", "operationId": "public_list_prompts_v1_public_projects__project_id__prompts_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PromptOut" }, "title": "Response Public List Prompts V1 Public Projects Project Id Prompts Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "tags": [ "public-api" ], "summary": "Create prompt", "operationId": "public_create_prompt_v1_public_projects__project_id__prompts_post", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromptCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromptOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/prompts/{prompt_id}": { "patch": { "tags": [ "public-api" ], "summary": "Update prompt", "operationId": "public_update_prompt_v1_public_projects__project_id__prompts__prompt_id__patch", "parameters": [ { "name": "prompt_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Prompt Id" } }, { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromptUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromptOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "delete": { "tags": [ "public-api" ], "summary": "Delete prompt", "operationId": "public_delete_prompt_v1_public_projects__project_id__prompts__prompt_id__delete", "parameters": [ { "name": "prompt_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Prompt Id" } }, { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/prompts/{prompt_id}/history": { "get": { "tags": [ "public-api" ], "summary": "Get prompt history", "operationId": "public_prompt_history_v1_public_projects__project_id__prompts__prompt_id__history_get", "parameters": [ { "name": "prompt_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Prompt Id" } }, { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromptHistory" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/query-fanout": { "get": { "tags": [ "public-api" ], "summary": "List query fanout", "operationId": "public_query_fanout_v1_public_projects__project_id__query_fanout_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 1000, "title": "Limit" } }, { "name": "engine_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Engine Ids" } }, { "name": "region_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Region Ids" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FanoutQuery" }, "title": "Response Public Query Fanout V1 Public Projects Project Id Query Fanout Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/reddit/leads": { "get": { "tags": [ "public-api" ], "summary": "List Reddit leads", "description": "Reddit threads (posts) where the brand could plausibly join the\nconversation, scored and qualified as leads, best first.", "operationId": "public_reddit_leads_v1_public_projects__project_id__reddit_leads_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 25, "title": "Limit" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublicRedditLead" }, "title": "Response Public Reddit Leads V1 Public Projects Project Id Reddit Leads Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/reddit/metrics": { "get": { "tags": [ "public-api" ], "summary": "Get Reddit metrics", "description": "Summary counts for Reddit leads: total, new, today, and average score.", "operationId": "public_reddit_metrics_v1_public_projects__project_id__reddit_metrics_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedditMetrics" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/reddit/opportunities": { "get": { "tags": [ "public-api" ], "summary": "List Reddit opportunities", "description": "All qualified Reddit opportunities (posts and comments), best first.", "operationId": "public_reddit_opportunities_v1_public_projects__project_id__reddit_opportunities_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublicRedditLead" }, "title": "Response Public Reddit Opportunities V1 Public Projects Project Id Reddit Opportunities Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/referrers": { "get": { "tags": [ "public-api" ], "summary": "List referrers", "operationId": "public_referrers_v1_public_projects__project_id__referrers_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "engine_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Engine Ids" } }, { "name": "region_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Region Ids" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReferrerRanking" }, "title": "Response Public Referrers V1 Public Projects Project Id Referrers Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/region-usage": { "get": { "tags": [ "public-api" ], "summary": "Get region usage", "operationId": "public_region_usage_v1_public_projects__project_id__region_usage_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegionUsageOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/regions": { "put": { "tags": [ "public-api" ], "summary": "Set tracked regions", "operationId": "public_set_project_regions_v1_public_projects__project_id__regions_put", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectRegionSetRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RegionOut" }, "title": "Response Public Set Project Regions V1 Public Projects Project Id Regions Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/runs": { "get": { "tags": [ "public-api" ], "summary": "List runs", "operationId": "public_runs_v1_public_projects__project_id__runs_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RunGroupOut" }, "title": "Response Public Runs V1 Public Projects Project Id Runs Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/scores/daily": { "get": { "tags": [ "public-api" ], "summary": "List daily scores", "operationId": "public_daily_scores_v1_public_projects__project_id__scores_daily_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 30, "title": "Limit" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DailyScoreOut" }, "title": "Response Public Daily Scores V1 Public Projects Project Id Scores Daily Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/segment-suggestions": { "get": { "tags": [ "public-api" ], "summary": "List segment suggestions", "operationId": "public_segment_suggestions_v1_public_projects__project_id__segment_suggestions_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentSuggestionOut" }, "title": "Response Public Segment Suggestions V1 Public Projects Project Id Segment Suggestions Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/segments": { "get": { "tags": [ "public-api" ], "summary": "Get segments", "operationId": "public_segments_v1_public_projects__project_id__segments_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "engine_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Engine Ids" } }, { "name": "region_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Region Ids" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicSegments" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/segments/{segment_id}/prompts": { "get": { "tags": [ "public-api" ], "summary": "List segment prompts", "operationId": "public_segment_prompts_v1_public_projects__project_id__segments__segment_id__prompts_get", "parameters": [ { "name": "segment_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Segment Id" } }, { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentPromptMapping" }, "title": "Response Public Segment Prompts V1 Public Projects Project Id Segments Segment Id Prompts Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/sources": { "get": { "tags": [ "public-api" ], "summary": "List sources", "operationId": "public_sources_v1_public_projects__project_id__sources_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "engine_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Engine Ids" } }, { "name": "region_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Region Ids" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SourceRanking" }, "title": "Response Public Sources V1 Public Projects Project Id Sources Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/suggestions": { "get": { "tags": [ "public-api" ], "summary": "List GEO suggestions", "operationId": "public_suggestions_v1_public_projects__project_id__suggestions_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "include_dismissed", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Dismissed" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SuggestionOut" }, "title": "Response Public Suggestions V1 Public Projects Project Id Suggestions Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/suggestions/status": { "get": { "tags": [ "public-api" ], "summary": "Get suggestions status", "operationId": "public_suggestions_status_v1_public_projects__project_id__suggestions_status_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuggestionsStatusOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/topic-answers": { "get": { "tags": [ "public-api" ], "summary": "Get the answers where a topic appeared", "operationId": "public_topic_answers_v1_public_projects__project_id__topic_answers_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "label", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "title": "Label" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "engine_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Engine Ids" } }, { "name": "region_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Region Ids" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopicAnswers" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/topic-detail": { "get": { "tags": [ "public-api" ], "summary": "Get topic detail", "operationId": "public_topic_detail_v1_public_projects__project_id__topic_detail_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "label", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "title": "Label" } }, { "name": "engine_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Engine Ids" } }, { "name": "region_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Region Ids" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopicDetail" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/topics": { "get": { "tags": [ "public-api" ], "summary": "Get topics", "operationId": "public_topics_v1_public_projects__project_id__topics_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "engine_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Engine Ids" } }, { "name": "region_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Region Ids" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicTopics" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/visibility": { "get": { "tags": [ "public-api" ], "summary": "Get visibility report", "operationId": "public_visibility_v1_public_projects__project_id__visibility_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "engine_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Engine Ids" } }, { "name": "region_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Region Ids" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisibilityReport" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/visibility/timeseries": { "get": { "tags": [ "public-api" ], "summary": "Get visibility timeseries", "operationId": "public_visibility_timeseries_v1_public_projects__project_id__visibility_timeseries_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "engine_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Engine Ids" } }, { "name": "region_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Region Ids" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisibilityTimeseries" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/projects/{project_id}/warm-leads": { "get": { "tags": [ "public-api" ], "summary": "List warm leads", "operationId": "public_warm_leads_v1_public_projects__project_id__warm_leads_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "engine_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Engine Ids" } }, { "name": "region_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Region Ids" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WarmLead" }, "title": "Response Public Warm Leads V1 Public Projects Project Id Warm Leads Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/prompt-runs/{prompt_run_id}": { "get": { "tags": [ "public-api" ], "summary": "Get prompt run", "operationId": "public_prompt_run_v1_public_prompt_runs__prompt_run_id__get", "parameters": [ { "name": "prompt_run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Prompt Run Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromptRunDetail" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/regions": { "get": { "tags": [ "public-api" ], "summary": "List regions", "operationId": "public_regions_v1_public_regions_get", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RegionOut" }, "title": "Response Public Regions V1 Public Regions Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/runs/{run_group_id}": { "get": { "tags": [ "public-api" ], "summary": "Get run group", "operationId": "public_run_group_v1_public_runs__run_group_id__get", "parameters": [ { "name": "run_group_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Group Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunGroupDetail" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/runs/{run_group_id}/results": { "get": { "tags": [ "public-api" ], "summary": "Get run results", "operationId": "public_run_group_results_v1_public_runs__run_group_id__results_get", "parameters": [ { "name": "run_group_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Group Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunGroupResults" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } } } }