# Share Of Model ## Docs - [Trigger workspace recommendations](https://docs.shareofmodel.ai/api-reference/admin/trigger-workspace-recommendations.md): Triggers recommendation pipelines for all projects created since the 1st of the current month. Existing recommendations are never overwritten. - [List all agents](https://docs.shareofmodel.ai/api-reference/agents/list-all-agents.md): Retrieve a list of all agents, optionally filtered by type or JavaScript capability. - [Archive analysis](https://docs.shareofmodel.ai/api-reference/analyses/archive-analysis.md): Archive an analysis by ID. Required permission: `write:analysis`. - [Compute Brand Analysis cost](https://docs.shareofmodel.ai/api-reference/analyses/compute-brand-analysis-cost.md): Returns the number of Generations required for one weekly run of a Brand Analysis. Required permission: `write:analysis`. - [Create a baseline report for analysis/search project](https://docs.shareofmodel.ai/api-reference/analyses/create-a-baseline-report-for-analysissearch-project.md): Creates a new baseline report entry and triggers background generation via Prefect. This endpoint returns immediately with the created record in `PENDING` status. The actual Google Slides report will be populated asynchronously. - [Create analysis](https://docs.shareofmodel.ai/api-reference/analyses/create-analysis.md): Create a new analysis in a workspace. Required permission: `write:analysis`. - [Create analysis baseline report](https://docs.shareofmodel.ai/api-reference/analyses/create-analysis-baseline-report.md): Creates a new baseline report entry and triggers background generation via Prefect. This endpoint returns immediately with the created record in `PENDING` status. The actual Google Slides report will be populated asynchronously. - [Create analysis clusters](https://docs.shareofmodel.ai/api-reference/analyses/create-analysis-clusters.md): Run clustering process for a given analysis. Required permission: `write:analysis`. - [Delete analysis](https://docs.shareofmodel.ai/api-reference/analyses/delete-analysis.md): Delete an analysis by ID. This is permanent and cannot be undone. Required permission: `write:analysis`. - [Delete baseline reports by module type](https://docs.shareofmodel.ai/api-reference/analyses/delete-baseline-reports-by-module-type.md): Delete all baseline reports for a workspace based on module type. If module=search, deletes reports related to a search project. If module=analysis, deletes reports related to an analysis. - [Get Analysis Configuration & Details](https://docs.shareofmodel.ai/api-reference/analyses/get-analysis-configuration-&-details.md): Retrieves complete configuration and details of a specific brand perception analysis, including all brands studied, competitors, countries, personas, attributes, and current status. - [Get analysis quota](https://docs.shareofmodel.ai/api-reference/analyses/get-analysis-quota.md): Retrieve analysis quota information for a given workspace. Required permission: `read:analysis`. - [Get distinct parameters](https://docs.shareofmodel.ai/api-reference/analyses/get-distinct-parameters.md): Returns distinct values for common analysis parameters such as brands, categories, personas - [List analysis baseline reports](https://docs.shareofmodel.ai/api-reference/analyses/list-analysis-baseline-reports.md): Retrieve all baseline reports associated with a specific analysis. - [List analysis LLM models with pricing](https://docs.shareofmodel.ai/api-reference/analyses/list-analysis-llm-models-with-pricing.md): List LLM providers and models available for brand analysis with their credit cost per persona/country combination. Required permission: `read:analysis`. - [List baseline reports of analysis/search_project](https://docs.shareofmodel.ai/api-reference/analyses/list-baseline-reports-of-analysissearch_project.md): Retrieve all baseline reports associated with a specific analysis/search_project. - [List Brand Analyses in Workspace](https://docs.shareofmodel.ai/api-reference/analyses/list-brand-analyses-in-workspace.md): Retrieves all brand perception analyses within a workspace, showing which AI recommendation studies have been conducted and their current status. - [List stored prompts](https://docs.shareofmodel.ai/api-reference/analyses/list-stored-prompts.md): Retrieve all stored prompts for a specific analysis. - [Restore analysis](https://docs.shareofmodel.ai/api-reference/analyses/restore-analysis.md): Restore an archived analysis by ID. Required permission: `write:analysis`. - [Retrieve a baseline report of analysis/search_project](https://docs.shareofmodel.ai/api-reference/analyses/retrieve-a-baseline-report-of-analysissearch_project.md): Retrieve details of a single baseline report by ID. - [Retrieve analysis baseline report](https://docs.shareofmodel.ai/api-reference/analyses/retrieve-analysis-baseline-report.md): Retrieve details of a single baseline report by ID. - [Retrieve stored prompt](https://docs.shareofmodel.ai/api-reference/analyses/retrieve-stored-prompt.md): Retrieve a specific stored prompt by ID. - [Suggest attributes for a brand and a category](https://docs.shareofmodel.ai/api-reference/analyses/suggest-attributes-for-a-brand-and-a-category.md): Get a list of suggested attributes to track on a given category. Required permission: `write:analysis`. - [Suggest brand categories](https://docs.shareofmodel.ai/api-reference/analyses/suggest-brand-categories.md): Get a list of suggested categories to track for a given brand. Required permission: `write:analysis`. - [Suggest brand competitors](https://docs.shareofmodel.ai/api-reference/analyses/suggest-brand-competitors.md): Get a list of suggested competitors to track for a given brand. Required permission: `write:analysis`. - [Suggest brand personas](https://docs.shareofmodel.ai/api-reference/analyses/suggest-brand-personas.md): Get a list of suggested personas to track for a given brand. Required permission: `write:analysis`. - [Suggest category attributes](https://docs.shareofmodel.ai/api-reference/analyses/suggest-category-attributes.md): Get a list of suggested attributes to track on a given category. Required permission: `write:analysis`. - [Suggest personas for a brand and a category](https://docs.shareofmodel.ai/api-reference/analyses/suggest-personas-for-a-brand-and-a-category.md): Get a list of suggested personas to track for a given brand and category. Required permission: `write:analysis`. - [Update analysis](https://docs.shareofmodel.ai/api-reference/analyses/update-analysis.md): Update some fields of an analysis. Required permission: `write:analysis`. - [Create organization API key](https://docs.shareofmodel.ai/api-reference/api-key/create-organization-api-key.md): Generate a new organization API key on the given organization. - [Create user API key](https://docs.shareofmodel.ai/api-reference/api-key/create-user-api-key.md): Generate a new API key for the authenticated user. There is a limit of 5 API keys per user. - [Create workspace API key](https://docs.shareofmodel.ai/api-reference/api-key/create-workspace-api-key.md): Generate a new workspace API key on the given workspace. - [Delete organization API key](https://docs.shareofmodel.ai/api-reference/api-key/delete-organization-api-key.md): Permanently delete an organization API key. This cannot be undone. - [Delete user API key](https://docs.shareofmodel.ai/api-reference/api-key/delete-user-api-key.md): Permanently delete an user API key. This cannot be undone. - [Delete workspace API key](https://docs.shareofmodel.ai/api-reference/api-key/delete-workspace-api-key.md): Permanently delete a workspace API token. This cannot be undone. - [List organization API keys](https://docs.shareofmodel.ai/api-reference/api-key/list-organization-api-keys.md): List all organization API keys associated to the given organization. - [List user API keys](https://docs.shareofmodel.ai/api-reference/api-key/list-user-api-keys.md): List all user API keys associated to the authenticated user. - [List workspace API keys](https://docs.shareofmodel.ai/api-reference/api-key/list-workspace-api-keys.md): List all workspace API keys associated to the given workspace. - [Rotate organization API key](https://docs.shareofmodel.ai/api-reference/api-key/rotate-organization-api-key.md): Rotate the value of an existing organization API key. - [Rotate user API key](https://docs.shareofmodel.ai/api-reference/api-key/rotate-user-api-key.md): Rotate the value of an existing user API key. - [Rotate workspace API key](https://docs.shareofmodel.ai/api-reference/api-key/rotate-workspace-api-key.md): Rotate the value of an existing workspace API key. - [Archive asset evaluation](https://docs.shareofmodel.ai/api-reference/asset-evaluations/archive-asset-evaluation.md): Archive an asset evaluation. Required permission: `write:asset_evaluation`. - [Compute Asset Evaluation cost](https://docs.shareofmodel.ai/api-reference/asset-evaluations/compute-asset-evaluation-cost.md): Returns the number of Generations required to run an Asset Evaluation for the given assets and models. Required permission: `write:asset_evaluation`. - [Create asset evaluation](https://docs.shareofmodel.ai/api-reference/asset-evaluations/create-asset-evaluation.md): Create a new asset evaluation. Required permission: `write:asset_evaluation`. - [Create asset evaluation (v2)](https://docs.shareofmodel.ai/api-reference/asset-evaluations/create-asset-evaluation-v2.md): Create a new asset evaluation (v2). Required permission: `write:asset_evaluation`. - [Destroy asset evaluation](https://docs.shareofmodel.ai/api-reference/asset-evaluations/destroy-asset-evaluation.md): Destroy an asset evaluation by ID. Required permission: `write:asset_evaluation`. - [Get Asset Evaluation Results & Scores](https://docs.shareofmodel.ai/api-reference/asset-evaluations/get-asset-evaluation-results-&-scores.md): Retrieves complete results of a specific marketing asset evaluation, including all tested assets with their AI-generated scores, recommendations, and performance analysis. - [Get asset evaluation status](https://docs.shareofmodel.ai/api-reference/asset-evaluations/get-asset-evaluation-status.md): Retrieve the status of an asset evaluation by ID. Required permission: `read:asset_evaluation`. - [Get asset evaluations llm models](https://docs.shareofmodel.ai/api-reference/asset-evaluations/get-asset-evaluations-llm-models.md): List llm models used in asset evaluations. Required permission: `read:asset_evaluation`. - [Get asset evaluations quota](https://docs.shareofmodel.ai/api-reference/asset-evaluations/get-asset-evaluations-quota.md): Retrieve quota information for current asset evaluations. Required permission: `read:asset_evaluation`. - [List asset evaluation LLM models with pricing](https://docs.shareofmodel.ai/api-reference/asset-evaluations/list-asset-evaluation-llm-models-with-pricing.md): List LLM providers and models available for asset evaluation with their credit cost per asset, broken down by content type. Required permission: `read:asset_evaluation`. - [List asset evaluations settings](https://docs.shareofmodel.ai/api-reference/asset-evaluations/list-asset-evaluations-settings.md): List settings used in asset evaluations. Required permission: `read:asset_evaluation`. - [List Marketing Asset Evaluations](https://docs.shareofmodel.ai/api-reference/asset-evaluations/list-marketing-asset-evaluations.md): Retrieves all marketing asset evaluations within a workspace, showing which creative materials (ads, copy, images, videos) have been tested and analyzed by AI. - [Restore asset evaluation](https://docs.shareofmodel.ai/api-reference/asset-evaluations/restore-asset-evaluation.md): Restore an asset evaluation. Required permission: `write:asset_evaluation`. - [Retry asset evaluation](https://docs.shareofmodel.ai/api-reference/asset-evaluations/retry-asset-evaluation.md): Retry an asset evaluation by ID. Required permission: `write:asset_evaluation`. - [Update asset evaluation](https://docs.shareofmodel.ai/api-reference/asset-evaluations/update-asset-evaluation.md): Update some fields of asset evaluation. Required permission: `write:asset_evaluation`. - [Update workspace image assets ](https://docs.shareofmodel.ai/api-reference/asset-evaluations/update-workspace-image-assets.md): Resize all workspace image assets. Required permission: `admin`. - [Archive asset(s)](https://docs.shareofmodel.ai/api-reference/assets/archive-assets.md): Archive asset(s). Required permission: `write:asset_evaluation`. - [Bulk edit asset(s)](https://docs.shareofmodel.ai/api-reference/assets/bulk-edit-assets.md): Bulk edit assets by updating name and/or tags. Required permission: `write:asset_evaluation`. - [Create asset(s)](https://docs.shareofmodel.ai/api-reference/assets/create-assets.md): Create new asset(s). This endpoint accepts only `multipart/form-data` content type, not JSON. Required permission: `write:asset_evaluation`. - [Delete asset(s)](https://docs.shareofmodel.ai/api-reference/assets/delete-assets.md): Delete asset(s). Required permission: `write:asset_evaluation`. - [List Marketing Creative Assets](https://docs.shareofmodel.ai/api-reference/assets/list-marketing-creative-assets.md): Retrieves all marketing creative assets within a workspace, showing the complete inventory of materials available for evaluation and analysis. - [Restore asset(s)](https://docs.shareofmodel.ai/api-reference/assets/restore-assets.md): Restore asset(s). Required permission: `write:asset_evaluation`. - [Retrieve asset](https://docs.shareofmodel.ai/api-reference/assets/retrieve-asset.md): Retrieve an asset by ID. Required permission: `read:asset_evaluation`. - [Get token](https://docs.shareofmodel.ai/api-reference/auth/get-token.md): Exchange API secret key for a JWT, to authenticate with the rest of the API. - [Refresh token](https://docs.shareofmodel.ai/api-reference/auth/refresh-token.md): Exchange existing JWT for a new JWT. - [Authentication](https://docs.shareofmodel.ai/api-reference/authentication.md): JWT, API keys, and OAuth — when to use what - [List brand catalogs](https://docs.shareofmodel.ai/api-reference/brand-catalog/list-brand-catalogs.md): List all brand catalogs, optionally filtering by brand names or domain. - [Create campaign optimization](https://docs.shareofmodel.ai/api-reference/campaign-optimizations/create-campaign-optimization.md): Create a new campaign optimization. Required permission: `write:analysis`. - [Create optimization results for a campaign optimization](https://docs.shareofmodel.ai/api-reference/campaign-optimizations/create-optimization-results-for-a-campaign-optimization.md): Create a new suggestion for a campaign optimization. Required permission: `write:analysis`. - [Delete campaign optimization](https://docs.shareofmodel.ai/api-reference/campaign-optimizations/delete-campaign-optimization.md): Delete a specific campaign optimization by its ID. Required permission: `write:analysis`. - [Extend suggestions for a campaign optimization](https://docs.shareofmodel.ai/api-reference/campaign-optimizations/extend-suggestions-for-a-campaign-optimization.md): Triggers a new pipeline run that generates additional keywords and merges them with the existing suggestions for a campaign optimization. Only supported for TikTok optimizations. Required permission: `write:analysis`. - [Get the latest suggestion for a campaign optimization](https://docs.shareofmodel.ai/api-reference/campaign-optimizations/get-the-latest-suggestion-for-a-campaign-optimization.md): Retrieve the latest suggestion for a specific campaign optimization. Required permission: `read:analysis`. - [Implement suggestions for a campaign optimization](https://docs.shareofmodel.ai/api-reference/campaign-optimizations/implement-suggestions-for-a-campaign-optimization.md): Implements the latest optimization suggestions for a campaign optimization. Required permission: `write:analysis`. - [List campaign optimizations](https://docs.shareofmodel.ai/api-reference/campaign-optimizations/list-campaign-optimizations.md): Retrieve a list of all campaign optimizations for the workspace. - [Refresh asset group info from Google Ads](https://docs.shareofmodel.ai/api-reference/campaign-optimizations/refresh-asset-group-info-from-google-ads.md): Re-fetches asset group metadata from Google Ads and updates the stored `campaign.asset_group_info`. Does **not** re-run the optimization pipeline or regenerate suggestions. Required permission: `write:analysis`. - [Restart campaign optimization pipeline](https://docs.shareofmodel.ai/api-reference/campaign-optimizations/restart-campaign-optimization-pipeline.md): Triggers a new pipeline run for an existing campaign optimization. Required permission: `write:analysis`. - [Retrieve campaign optimization](https://docs.shareofmodel.ai/api-reference/campaign-optimizations/retrieve-campaign-optimization.md): Retrieve a specific campaign optimization by its ID. - [Collected Brand Data](https://docs.shareofmodel.ai/api-reference/collects/collected-brand-data.md): Get all the raw brand data collected for a project. - [Collected Domain Data](https://docs.shareofmodel.ai/api-reference/collects/collected-domain-data.md): Get all the raw domain data collected for a project. - [Collected Responses](https://docs.shareofmodel.ai/api-reference/collects/collected-responses.md): Get the raw LLM response data collected for a project. - [Collected Search Queries Data](https://docs.shareofmodel.ai/api-reference/collects/collected-search-queries-data.md): Get all the raw search queries data collected for a project. - [List Collects For Project](https://docs.shareofmodel.ai/api-reference/collects/list-collects-for-project.md): List all collects for a specific project. - [Create content brief](https://docs.shareofmodel.ai/api-reference/content-briefs/create-content-brief.md): Create a new content brief and iteration from analysis. Required permission: `write:analysis`. - [Create content brief iteration](https://docs.shareofmodel.ai/api-reference/content-briefs/create-content-brief-iteration.md): Create a new iteration from existing content brief. Required permission: `write:analysis`. - [List content brief iterations](https://docs.shareofmodel.ai/api-reference/content-briefs/list-content-brief-iterations.md): List all iterations related to a content brief. Required permission: `read:analysis`. - [List content briefs](https://docs.shareofmodel.ai/api-reference/content-briefs/list-content-briefs.md): List all content briefs related to an analysis. Required permission: `read:analysis`. - [List workspace content briefs](https://docs.shareofmodel.ai/api-reference/content-briefs/list-workspace-content-briefs.md): List all content briefs related to a workspace. Required permission: `read:analysis`. - [AI-Generated Strategic Insights](https://docs.shareofmodel.ai/api-reference/insights/ai-generated-strategic-insights.md): Returns AI-generated strategic insights and recommendations based on analysis da ta, providing narrative summaries with supporting data. - [AI Insights: Brand Attribute Scores](https://docs.shareofmodel.ai/api-reference/insights/ai-insights:-brand-attribute-scores.md): Returns AI-generated insights interpreting brand ratings on specific attributes, highlighting competitive advantages and weaknesses. - [AI Insights: Brand Awareness Levels](https://docs.shareofmodel.ai/api-reference/insights/ai-insights:-brand-awareness-levels.md): Returns AI-generated insights about brand mention frequencies, explaining brand awareness levels and recall patterns. - [AI Insights: Brand Awareness Trends](https://docs.shareofmodel.ai/api-reference/insights/ai-insights:-brand-awareness-trends.md): Returns AI-generated insights about brand awareness trends over time, identifying growth, decline, and momentum patterns. - [AI Insights: Brand Ranking Patterns](https://docs.shareofmodel.ai/api-reference/insights/ai-insights:-brand-ranking-patterns.md): Returns AI-generated insights about brand ranking positions, explaining which brands consistently appear first vs last in AI recommendations. - [AI Insights: Brand Strengths/Weaknesses](https://docs.shareofmodel.ai/api-reference/insights/ai-insights:-brand-strengthsweaknesses.md): Returns AI-generated narrative insights about brand cluster distribution, explaining which brands excel in which themes (e.g., 'Nike dominates comfort perception'). - [AI Insights: Brand Themes Across AI Models](https://docs.shareofmodel.ai/api-reference/insights/ai-insights:-brand-themes-across-ai-models.md): Returns AI-generated insights about how brand perception varies across different AI platforms (ChatGPT vs Gemini vs Claude). - [AI Insights: Complete Brand Awareness Profile](https://docs.shareofmodel.ai/api-reference/insights/ai-insights:-complete-brand-awareness-profile.md): Returns AI-generated insights combining mention frequency and ranking data, providing holistic brand awareness analysis. - [AI Insights: Market Dominance Patterns](https://docs.shareofmodel.ai/api-reference/insights/ai-insights:-market-dominance-patterns.md): Returns AI-generated insights about weighted market presence, explaining which brands dominate AI recommendation space. - [AI Insights: Market Share Evolution](https://docs.shareofmodel.ai/api-reference/insights/ai-insights:-market-share-evolution.md): Returns AI-generated insights about market share trends over time, identifying shifts in competitive dominance. - [AI Insights: Platform-Specific Market Share](https://docs.shareofmodel.ai/api-reference/insights/ai-insights:-platform-specific-market-share.md): Returns AI-generated insights about market share variations across AI platforms, revealing platform-specific competitive dynamics. - [AI Insights: Theme Breakdown Structure](https://docs.shareofmodel.ai/api-reference/insights/ai-insights:-theme-breakdown-structure.md): Returns AI-generated insights about the hierarchical structure of attributes within clusters, explaining theme composition. - [Overview](https://docs.shareofmodel.ai/api-reference/introduction.md): Two API surfaces: Core and Search - [MCP Integration](https://docs.shareofmodel.ai/api-reference/mcp-integration.md): Expose Share Of Model data to LLM agents via Model Context Protocol - [All Asset Evaluations Summary](https://docs.shareofmodel.ai/api-reference/metrics/all-asset-evaluations-summary.md): Lists average performance scores for all asset evaluations in a workspace, provi ding a comparative overview of all evaluated assets. - [All Information Sources](https://docs.shareofmodel.ai/api-reference/metrics/all-information-sources.md): Lists all information sources (URLs, domains, content) that AI models cite when discussing brands in a category. - [Audience Age Demographics](https://docs.shareofmodel.ai/api-reference/metrics/audience-age-demographics.md): Shows the age distribution of a brand's target audience, revealing which age gro ups dominate the customer base. - [Audience Gender Demographics](https://docs.shareofmodel.ai/api-reference/metrics/audience-gender-demographics.md): Shows the gender composition of a brand's target audience, indicating male/femal e/all distribution patterns. - [Audience Geographic Type Demographics](https://docs.shareofmodel.ai/api-reference/metrics/audience-geographic-type-demographics.md): Shows the geographic location type distribution of a brand's audience (urban, su burban, rural), revealing where customers live. - [Audience Household Demographics](https://docs.shareofmodel.ai/api-reference/metrics/audience-household-demographics.md): Shows the household composition of a brand's audience (single, couple, family wi th children, etc.), revealing family structure patterns. - [Audience Price Sensitivity](https://docs.shareofmodel.ai/api-reference/metrics/audience-price-sensitivity.md): Shows the price sensitivity distribution of a brand's audience (low, medium, hig h cost tolerance), revealing budget flexibility patterns. - [Available AI Models List](https://docs.shareofmodel.ai/api-reference/metrics/available-ai-models-list.md): Lists all AI models (ChatGPT, Gemini, Claude, etc.) that were queried in this an alysis, showing which LLM sources have data. - [Available Audience Data Dates](https://docs.shareofmodel.ai/api-reference/metrics/available-audience-data-dates.md): Returns all dates for which audience data is available, showing the timeline of data collection periods. - [Brand Awareness Score Evolution](https://docs.shareofmodel.ai/api-reference/metrics/brand-awareness-score-evolution.md): Tracks changes in the composite brand awareness score over time, showing overall brand health trends in a single metric timeline. - [Brand Market Share by AI Model](https://docs.shareofmodel.ai/api-reference/metrics/brand-market-share-by-ai-model.md): Shows each brand's weighted market presence broken down by AI model (ChatGPT, Gemini, Claude, etc.), revealing which platforms favor which brands. - [Brand Market Share Metric](https://docs.shareofmodel.ai/api-reference/metrics/brand-market-share-metric.md): Calculates each brand's weighted market presence by combining mention frequency with ranking position, showing true market dominance. - [Brand Mention Frequency](https://docs.shareofmodel.ai/api-reference/metrics/brand-mention-frequency.md): Shows how frequently each brand is mentioned by AI models, expressed as the percentage of queries where the brand appears in responses. - [Brand Mention Trends Over Time](https://docs.shareofmodel.ai/api-reference/metrics/brand-mention-trends-over-time.md): Shows how brand mention frequencies change over time, revealing growth trends, seasonal patterns, and the impact of marketing activities. - [Brand Ownership of Each Theme](https://docs.shareofmodel.ai/api-reference/metrics/brand-ownership-of-each-theme.md): Shows which brands dominate each perception theme (cluster), revealing market le adership in specific attributes. - [Brand Perception by LLM Source](https://docs.shareofmodel.ai/api-reference/metrics/brand-perception-by-llm-source.md): Shows how a brand's perception themes vary across different AI models (ChatGPT, Gemini, Claude, etc.), revealing consistency or divergence in brand perception. - [Brand Perception Raw Pros And Cons](https://docs.shareofmodel.ai/api-reference/metrics/brand-perception-raw-pros-and-cons.md): Retrieves the list of all brand pros and cons. Required permission: `read:analysis`. - [Brand Performance by AI Model](https://docs.shareofmodel.ai/api-reference/metrics/brand-performance-by-ai-model.md): Shows composite performance scores broken down by AI model (ChatGPT, Gemini, Claude, etc.), revealing platform-specific brand strength variations. - [Brand Performance by Market/Country](https://docs.shareofmodel.ai/api-reference/metrics/brand-performance-by-marketcountry.md): Shows composite performance scores broken down by country or market, revealing geographic variations in brand strength. - [Brand Performance by Target Persona](https://docs.shareofmodel.ai/api-reference/metrics/brand-performance-by-target-persona.md): Shows composite performance scores broken down by customer persona, revealing which brands resonate with different audience segments. - [Brand Ranking Positions](https://docs.shareofmodel.ai/api-reference/metrics/brand-ranking-positions.md): Shows the average position or ranking where each brand appears in AI recommendations, revealing which brands are suggested first vs last. - [Brand Ratings on Specific Attributes](https://docs.shareofmodel.ai/api-reference/metrics/brand-ratings-on-specific-attributes.md): Shows how AI models rate each brand on specific attributes like price, quality, comfort, durability, etc., revealing brand strengths and weaknesses. - [Citation Rates by Platform Category](https://docs.shareofmodel.ai/api-reference/metrics/citation-rates-by-platform-category.md): Shows citation frequency grouped by platform type (social media, news, forums, e-commerce, reviews), revealing which content categories AI trusts most. - [Cluster Distribution Per Brand](https://docs.shareofmodel.ai/api-reference/metrics/cluster-distribution-per-brand.md): Shows how each brand's perception is distributed across different themes (cluste rs), revealing each brand's unique strength and weakness profile. - [Combined Brand Awareness Metrics](https://docs.shareofmodel.ai/api-reference/metrics/combined-brand-awareness-metrics.md): Shows both mention frequency and ranking position for each brand in one response, providing a complete picture of brand awareness and prominence. - [Competitor Sources](https://docs.shareofmodel.ai/api-reference/metrics/competitor-sources.md): Retrieves domains or URLs appearing in search and AI results, with aggregated metrics for a given date range. Can be grouped by domain or URL. Filter by ALL (default, shows all), SOURCE (citations only), or LINK (ranked only). Supports sorting by: competitor_type, domain/url, type (Link/Source/both)… - [Complete Audience Segment Profiles](https://docs.shareofmodel.ai/api-reference/metrics/complete-audience-segment-profiles.md): Returns detailed profiles for all audience segments, including demographics, beh aviors, challenges, and preferences in one comprehensive response. - [Complete Source Authority Metrics](https://docs.shareofmodel.ai/api-reference/metrics/complete-source-authority-metrics.md): Returns all domain authority metrics in one response (mention rate, average posi tion, occurrence), providing complete source influence profile. - [Complete Source Metrics by Topic](https://docs.shareofmodel.ai/api-reference/metrics/complete-source-metrics-by-topic.md): Returns all domain authority metrics (mention rate, position, occurrence) in one response, filtered by specific attributes for comprehensive topic-specific source analysis. - [Comprehensive Domain Influence Breakdown](https://docs.shareofmodel.ai/api-reference/metrics/comprehensive-domain-influence-breakdown.md): Provides complete influence analysis for each domain including platform type, top URLs, and influence scores broken down by AI model. - [Detailed Asset Performance Metrics](https://docs.shareofmodel.ai/api-reference/metrics/detailed-asset-performance-metrics.md): Returns comprehensive performance scores for a specific asset evaluation, showin g how the asset performed across multiple dimensions and criteria. - [Domain Influence Rankings](https://docs.shareofmodel.ai/api-reference/metrics/domain-influence-rankings.md): Calculates and ranks domains by their overall influence score, combining citation frequency, position, and content impact into one metric. - [Domain Influence Trends Over Time](https://docs.shareofmodel.ai/api-reference/metrics/domain-influence-trends-over-time.md): Compares domain influence scores between two time periods, showing which sources are gaining or losing impact with AI models. - [Google Ads Targeting Categories](https://docs.shareofmodel.ai/api-reference/metrics/google-ads-targeting-categories.md): Shows which Google Ads audience segments appear most frequently across the brand 's target audiences, enabling direct campaign targeting. - [Hierarchical Perception Tree View](https://docs.shareofmodel.ai/api-reference/metrics/hierarchical-perception-tree-view.md): Provides a complete hierarchical tree structure showing clusters → attributes → brands → sources, with mention counts at each level. - [Individual URL Performance Metrics](https://docs.shareofmodel.ai/api-reference/metrics/individual-url-performance-metrics.md): Shows citation frequency and ranking position for individual URLs within a specific domain, revealing which specific pages AI models reference most. - [List All Attributes with Cluster Mapping](https://docs.shareofmodel.ai/api-reference/metrics/list-all-attributes-with-cluster-mapping.md): Provides a complete mapping of every detailed attribute to its parent cluster th eme, showing the granular details that compose each high-level perception. - [List Pros and Cons Cluster Groups](https://docs.shareofmodel.ai/api-reference/metrics/list-pros-and-cons-cluster-groups.md): Lists all available cluster groups (themes) for a brand analysis, showing both p ositive (pros) and negative (cons) perception clusters. - [Market Share Trends Over Time](https://docs.shareofmodel.ai/api-reference/metrics/market-share-trends-over-time.md): Tracks how each brand's weighted market presence evolves over time, showing shifts in competitive dynamics and market leadership. - [Overall Brand Awareness Score](https://docs.shareofmodel.ai/api-reference/metrics/overall-brand-awareness-score.md): Provides a single composite score combining mention frequency and ranking position, offering an at-a-glance measure of overall brand awareness strength. - [Overall Brand Performance Score](https://docs.shareofmodel.ai/api-reference/metrics/overall-brand-performance-score.md): Calculates a single composite score for each brand combining multiple performance dimensions into one unified health metric. - [Overall Cluster Share Distribution](https://docs.shareofmodel.ai/api-reference/metrics/overall-cluster-share-distribution.md): Shows the percentage distribution of each cluster (theme) across all brands in t he market, indicating which perception themes dominate overall. - [Overall Source Authority Score](https://docs.shareofmodel.ai/api-reference/metrics/overall-source-authority-score.md): Provides a single composite authority score for each domain combining citation f requency and ranking position, offering at-a-glance source influence measurement. - [Query Fan-Out](https://docs.shareofmodel.ai/api-reference/metrics/query-fan-out.md): List all Query Fan-out metrics for a project, aggregated by query fan-out text, keyword, and source. Provides informations about ranked domains and presence of the main project domain - [Ranked Urls](https://docs.shareofmodel.ai/api-reference/metrics/ranked-urls.md): Get ranked URLs of the main domain with server-side pagination, search, and sorting capabilities. - [Reddit insights](https://docs.shareofmodel.ai/api-reference/metrics/reddit-insights.md): Retrieve Reddit posts and insights for a specific reddit listening ID. - [Social Media Sources with Context](https://docs.shareofmodel.ai/api-reference/metrics/social-media-sources-with-context.md): Returns Reddit and YouTube sources enriched with platform-specific metadata like creators, communities, subscribers, and engagement metrics. - [Source Authority by AI Model](https://docs.shareofmodel.ai/api-reference/metrics/source-authority-by-ai-model.md): Shows domain authority scores broken down by AI model (ChatGPT, Gemini, Claude, etc.), revealing which platforms each LLM trusts. - [Source Citation Counts](https://docs.shareofmodel.ai/api-reference/metrics/source-citation-counts.md): Returns the raw count of how many times each information source (domain) appears in AI responses, showing absolute citation volume. - [Source Citation Counts by Topic](https://docs.shareofmodel.ai/api-reference/metrics/source-citation-counts-by-topic.md): Returns raw citation counts for each source filtered by specific attributes, sho wing absolute volume of domain references for particular topics. - [Source Citation Frequency](https://docs.shareofmodel.ai/api-reference/metrics/source-citation-frequency.md): Shows how frequently each information source (domain) is cited by AI models, exp ressed as percentage of responses that reference the domain. - [Source Citation Frequency by Topic](https://docs.shareofmodel.ai/api-reference/metrics/source-citation-frequency-by-topic.md): Shows how frequently each source is cited for specific attributes or topics, rev ealing which domains AI references most for particular subjects. - [Source Domain Ranking Positions](https://docs.shareofmodel.ai/api-reference/metrics/source-domain-ranking-positions.md): Shows the average position where information sources (domains like reddit.com, y outube.com, nytimes.com) appear in AI citations and recommendations. - [Source Rankings for Specific Topics](https://docs.shareofmodel.ai/api-reference/metrics/source-rankings-for-specific-topics.md): Shows average citation positions for information sources filtered by specific at tributes or topics, revealing which domains AI trusts most for particular subjects. - [Top and Bottom Reddit Communities](https://docs.shareofmodel.ai/api-reference/metrics/top-and-bottom-reddit-communities.md): Identifies the most and least frequently cited Reddit communities (subreddits), showing which forums AI references most and least often. - [Topic-Specific Source Authority by AI Model](https://docs.shareofmodel.ai/api-reference/metrics/topic-specific-source-authority-by-ai-model.md): Shows domain authority scores for specific attributes broken down by AI model, r evealing which platforms each LLM trusts for particular topics. - [Topic-Specific Source Authority Scores](https://docs.shareofmodel.ai/api-reference/metrics/topic-specific-source-authority-scores.md): Provides composite authority scores for domains filtered by specific attributes, offering at-a-glance measurement of source influence for particular topics. - [Create organization](https://docs.shareofmodel.ai/api-reference/organizations/create-organization.md): Create a new organization with required plan and modules (CSM or staff only). If an organization with the same name already exists and is accessible to the caller, it is returned with a 200 status instead of creating a duplicate. The logo field is omitted from the response unless `include_logo=true`… - [Filter organizations](https://docs.shareofmodel.ai/api-reference/organizations/filter-organizations.md): Filter organizations by `workspace_id`, `pencil_customer_id` and/or `is_pencil`. At least one criterion is required. The logo field is omitted unless `include_logo=true`. - [List organizations](https://docs.shareofmodel.ai/api-reference/organizations/list-organizations.md): List accessible organizations. The logo field is omitted unless `include_logo=true`. - [Retrieve member activity](https://docs.shareofmodel.ai/api-reference/organizations/retrieve-member-activity.md): Retrieves a member's activity in the organization. - [Retrieve member details](https://docs.shareofmodel.ai/api-reference/organizations/retrieve-member-details.md): Retrieves a member's details and workspace roles. Required permission: `read:organization_settings`. - [Retrieve organization](https://docs.shareofmodel.ai/api-reference/organizations/retrieve-organization.md): Retrieve organization by id. The logo field is omitted unless `include_logo=true`. - [Update organization](https://docs.shareofmodel.ai/api-reference/organizations/update-organization.md): Update the organization attributes (name, plan, quotas, logo, etc). The logo field is omitted from the response unless `include_logo=true`. Required permission: Staff or CSM only. - [Brand Presence Rate](https://docs.shareofmodel.ai/api-reference/overview-metrics/brand-presence-rate.md): Get the presence rate for the main brand of a project grouped by engine and thematic. - [Brand Thematic Overview](https://docs.shareofmodel.ai/api-reference/overview-metrics/brand-thematic-overview.md): Get statistics for the main brand of a project for all its thematics and topics, including visibility score, presence rate, and average ranking. - [Domain Average Ranking](https://docs.shareofmodel.ai/api-reference/overview-metrics/domain-average-ranking.md): Get the average ranking for the domain of a project across all sources. - [Domain Presence Rate](https://docs.shareofmodel.ai/api-reference/overview-metrics/domain-presence-rate.md): Get the presence rate for the domain of a project grouped by engine and thematic. - [Domain Thematic Overview](https://docs.shareofmodel.ai/api-reference/overview-metrics/domain-thematic-overview.md): Get statistics for the main domain of a project for all its thematics and topics, including visibility score, presence rate, and average ranking. - [Global Visibility Score](https://docs.shareofmodel.ai/api-reference/overview-metrics/global-visibility-score.md): Retrieves visibility score metrics grouped by source, showing how visible the project is across different search engines. Supports filtering by thematics, keyword types, and other attributes. - [Archive persona](https://docs.shareofmodel.ai/api-reference/personas/archive-persona.md): Soft-delete a persona by setting `archived = True`. Required permission: `write:analysis`. - [Create persona](https://docs.shareofmodel.ai/api-reference/personas/create-persona.md): Create a new persona in a workspace. Required permission: `write:analysis`. - [List persona versions](https://docs.shareofmodel.ai/api-reference/personas/list-persona-versions.md): Return the full version history of a persona, ordered newest first. Works on archived personas. Required permission: `read:analysis`. - [List personas](https://docs.shareofmodel.ai/api-reference/personas/list-personas.md): List all personas in a workspace. Required permission: `read:analysis`. - [Retrieve persona](https://docs.shareofmodel.ai/api-reference/personas/retrieve-persona.md): Retrieve a single persona by ID. Required permission: `read:analysis`. - [Update persona](https://docs.shareofmodel.ai/api-reference/personas/update-persona.md): Update a persona, creating a new immutable version. Required permission: `write:analysis`. - [Activate platform account](https://docs.shareofmodel.ai/api-reference/platform-accounts/activate-platform-account.md): Activate a platform account by setting its status to ACTIVE. - [Create platform accounts](https://docs.shareofmodel.ai/api-reference/platform-accounts/create-platform-accounts.md): Create one or multiple platform accounts in a workspace. Always accepts a list of accounts. - [Deactivate platform account](https://docs.shareofmodel.ai/api-reference/platform-accounts/deactivate-platform-account.md): Deactivate a platform account by setting its status to EXPIRED. - [Delete platform account](https://docs.shareofmodel.ai/api-reference/platform-accounts/delete-platform-account.md): Delete a platform account by ID. - [List platform accounts](https://docs.shareofmodel.ai/api-reference/platform-accounts/list-platform-accounts.md): List all platform accounts in a workspace. Optionally filter by platform. - [Retrieve platform account](https://docs.shareofmodel.ai/api-reference/platform-accounts/retrieve-platform-account.md): Retrieve a platform account by ID. - [Create a platform integration](https://docs.shareofmodel.ai/api-reference/platform-integrations/create-a-platform-integration.md): Create a new platform integration in a workspace. The credentials will be encrypted before storing. - [Delete platform integration](https://docs.shareofmodel.ai/api-reference/platform-integrations/delete-platform-integration.md): Delete a platform integration by ID. - [Google Ads OAuth callback](https://docs.shareofmodel.ai/api-reference/platform-integrations/google-ads-oauth-callback.md): Callback endpoint for Google OAuth flow. Redirects to frontend with integration data. - [Google Ads OAuth callback](https://docs.shareofmodel.ai/api-reference/platform-integrations/google-ads-oauth-callback-1.md): Callback endpoint for Google OAuth flow. Redirects to frontend with integration data. - [Initiate Google Ads OAuth flow](https://docs.shareofmodel.ai/api-reference/platform-integrations/initiate-google-ads-oauth-flow.md): Returns Google OAuth consent screen URL for authorization. - [Initiate TikTok OAuth flow](https://docs.shareofmodel.ai/api-reference/platform-integrations/initiate-tiktok-oauth-flow.md): Returns TikTok OAuth consent screen URL for authorization. - [List all accounts accessible with the platform integration](https://docs.shareofmodel.ai/api-reference/platform-integrations/list-all-accounts-accessible-with-the-platform-integration.md): Use the token stored in the platform integration, make a call to external platform API (ex google_ads) to retrieve all accounts accessible with the platform integration. - [List platform integration campaigns for a given account](https://docs.shareofmodel.ai/api-reference/platform-integrations/list-platform-integration-campaigns-for-a-given-account.md): Make a call to external platform API to retrieve a list of campaigns available for the given account. - [List platform integrations](https://docs.shareofmodel.ai/api-reference/platform-integrations/list-platform-integrations.md): List all platform integrations in a workspace. - [Retrieve platform integration](https://docs.shareofmodel.ai/api-reference/platform-integrations/retrieve-platform-integration.md): Retrieve a platform integration by ID. - [TikTok OAuth callback](https://docs.shareofmodel.ai/api-reference/platform-integrations/tiktok-oauth-callback.md): Callback endpoint for TikTok OAuth flow. This endpoint is organization and workspace agnostic - the organization_id and workspace_id are extracted from the signed state parameter for security. After successful authentication, redirects to the frontend redirect_uri with platform_integration_id as a q… - [TikTok OAuth callback](https://docs.shareofmodel.ai/api-reference/platform-integrations/tiktok-oauth-callback-1.md): Callback endpoint for TikTok OAuth flow. This endpoint is organization and workspace agnostic - the organization_id and workspace_id are extracted from the signed state parameter for security. After successful authentication, redirects to the frontend redirect_uri with platform_integration_id as a q… - [Get Analysis By Id](https://docs.shareofmodel.ai/api-reference/projects/get-analysis-by-id.md): Get full analysis details including thematics, keywords, and tags by analysis ID. Requires read access to the workspace. - [List All Analyses](https://docs.shareofmodel.ai/api-reference/projects/list-all-analyses.md): Paginated list of all analyses (projects) for a workspace. Use this endpoint to discover available analysis IDs for use with other endpoints. pagination.total is the total number of analyses across all pages. - [Quickstart](https://docs.shareofmodel.ai/api-reference/quickstart.md): From zero to your first authenticated API call - [List recommendation channels](https://docs.shareofmodel.ai/api-reference/recommendation-channel/list-recommendation-channels.md): Returns all recommendation channels. Channels are global and not filtered by organization or workspace. - [Create or fully replace the brief for a task](https://docs.shareofmodel.ai/api-reference/recommended-action-brief/create-or-fully-replace-the-brief-for-a-task.md) - [Partially update the brief for a task](https://docs.shareofmodel.ai/api-reference/recommended-action-brief/partially-update-the-brief-for-a-task.md) - [Retrieve the brief for a task](https://docs.shareofmodel.ai/api-reference/recommended-action-brief/retrieve-the-brief-for-a-task.md) - [Create a task for a recommended action result](https://docs.shareofmodel.ai/api-reference/recommended-action-result-task/create-a-task-for-a-recommended-action-result.md) - [List tasks for a recommended action result](https://docs.shareofmodel.ai/api-reference/recommended-action-result-task/list-tasks-for-a-recommended-action-result.md) - [Partially update a task (name, description, brief_template_id)](https://docs.shareofmodel.ai/api-reference/recommended-action-result-task/partially-update-a-task-name-description-brief_template_id.md) - [Retrieve a single task](https://docs.shareofmodel.ai/api-reference/recommended-action-result-task/retrieve-a-single-task.md) - [Bulk dismiss recommended actions](https://docs.shareofmodel.ai/api-reference/recommended-action/bulk-dismiss-recommended-actions.md): Dismisses multiple recommended actions in a single request with one shared reason. Items that are currently new or confirmed are moved to dismissed; the same reason and comment are persisted for all items. Items already dismissed are reported in skipped — the rest of the batch proceeds normally (par… - [Bulk save recommended actions to My Plan](https://docs.shareofmodel.ai/api-reference/recommended-action/bulk-save-recommended-actions-to-my-plan.md): Saves multiple recommended actions to My Plan in a single request. Items that are currently new are moved to confirmed and brief generation is triggered for each. Items already confirmed or dismissed are reported in skipped with the appropriate reason — the rest of the batch proceeds normally (parti… - [Delete an archived recommended action](https://docs.shareofmodel.ai/api-reference/recommended-action/delete-an-archived-recommended-action.md): Permanently deletes the recommended action. Only allowed when workflow_status is dismissed (Archived); returns 422 otherwise. - [Dismiss recommended action](https://docs.shareofmodel.ai/api-reference/recommended-action/dismiss-recommended-action.md): Dismisses the recommended action by setting workflow_status to dismissed. Requires a reason from the fixed taxonomy; an optional free-text comment may also be supplied. Allowed from new or confirmed; returns 422 if already dismissed. - [Generate briefs for a recommended action](https://docs.shareofmodel.ai/api-reference/recommended-action/generate-briefs-for-a-recommended-action.md): Triggers a Prefect flow that generates briefs for every task of the given recommended action. The flow persists briefs by calling POST /v1/internal/recommendation/recommended-action-results/{result_id}/briefs. - [Get a single recommended action](https://docs.shareofmodel.ai/api-reference/recommended-action/get-a-single-recommended-action.md): Returns the recommended action from the database whose id matches the given id. - [Get recommended action counts by workflow status](https://docs.shareofmodel.ai/api-reference/recommended-action/get-recommended-action-counts-by-workflow-status.md): Returns per-status counts of recommended actions scoped to the given workspace. all_active_total equals new + confirmed (dismissed items are excluded). Accepts the same scope filters as the list endpoint (brand, category, channel, country, opportunity, team). - [List briefs for a recommended action](https://docs.shareofmodel.ai/api-reference/recommended-action/list-briefs-for-a-recommended-action.md): Returns all persisted briefs for the recommended action result. Tasks without a brief row are omitted from the list. - [List recommended actions](https://docs.shareofmodel.ai/api-reference/recommended-action/list-recommended-actions.md): Returns the list of recommended actions from the database. - [Reconsider recommended action](https://docs.shareofmodel.ai/api-reference/recommended-action/reconsider-recommended-action.md): Moves the recommended action back to New by setting workflow_status to new. Allowed from confirmed (My Plan) or dismissed (Archived); returns 422 otherwise. Dismiss fields (reason, comment, date) are cleared when reconsidering a dismissed action. - [Save recommended action to My Plan](https://docs.shareofmodel.ai/api-reference/recommended-action/save-recommended-action-to-my-plan.md): Saves the recommended action to My Plan by setting workflow_status to confirmed. Automatically triggers brief generation for all tasks. Only allowed from status new; returns 422 otherwise. - [Create reddit listening](https://docs.shareofmodel.ai/api-reference/reddit-listenings/create-reddit-listening.md): Create a new reddit listening. - [List reddit listenings](https://docs.shareofmodel.ai/api-reference/reddit-listenings/list-reddit-listenings.md): List all reddit listenings. - [Retrieve reddit listening](https://docs.shareofmodel.ai/api-reference/reddit-listenings/retrieve-reddit-listening.md): Retrieve an asset evaluation by ID. Required permission: `read:analysis`. - [List reddit summaries](https://docs.shareofmodel.ai/api-reference/reddit-summaries/list-reddit-summaries.md): List reddit summaries filtered by the `subreddit_name__in` query parameter. The parameter should be a comma-separated list of subreddit names. - [Retrieve reddit summary](https://docs.shareofmodel.ai/api-reference/reddit-summaries/retrieve-reddit-summary.md): Retrieve a reddit summary by id. - [Add prompts to shopping analysis](https://docs.shareofmodel.ai/api-reference/shopping-analysis/add-prompts-to-shopping-analysis.md): Add prompts to an existing shopping analysis. Supports batch or single prompt addition. - [Archive all shopping analyses in workspace](https://docs.shareofmodel.ai/api-reference/shopping-analysis/archive-all-shopping-analyses-in-workspace.md): Archives all non-archived shopping analyses attached to the specified workspace. - [Archive shopping analysis](https://docs.shareofmodel.ai/api-reference/shopping-analysis/archive-shopping-analysis.md): Archive a shopping analysis by ID. Required permission: `write:analysis`. - [Create shopping analysis](https://docs.shareofmodel.ai/api-reference/shopping-analysis/create-shopping-analysis.md): Create a new shopping analysis with themes and selling points. The created_by field is automatically populated from the authenticated user. - [Delete all shopping analyses in workspace](https://docs.shareofmodel.ai/api-reference/shopping-analysis/delete-all-shopping-analyses-in-workspace.md): Deletes all shopping analyses attached to the specified workspace. - [Delete shopping analysis](https://docs.shareofmodel.ai/api-reference/shopping-analysis/delete-shopping-analysis.md): Delete a shopping analysis by ID. Required permission: `write:analysis`. - [List prompts for shopping analysis](https://docs.shareofmodel.ai/api-reference/shopping-analysis/list-prompts-for-shopping-analysis.md): List all prompts for a specific shopping analysis. - [List selling points for shopping analysis](https://docs.shareofmodel.ai/api-reference/shopping-analysis/list-selling-points-for-shopping-analysis.md): List all selling points for a specific shopping analysis. - [List shopping analyses](https://docs.shareofmodel.ai/api-reference/shopping-analysis/list-shopping-analyses.md): List all shopping analyses for a given organization and workspace. - [List themes for shopping analysis](https://docs.shareofmodel.ai/api-reference/shopping-analysis/list-themes-for-shopping-analysis.md): List all themes for a specific shopping analysis. - [Restore shopping analysis](https://docs.shareofmodel.ai/api-reference/shopping-analysis/restore-shopping-analysis.md): Restore an archived shopping analysis by ID. Required permission: `write:analysis`. - [Retrieve shopping analysis](https://docs.shareofmodel.ai/api-reference/shopping-analysis/retrieve-shopping-analysis.md): Retrieve a shopping analysis by id. - [Bulk delete organization roles](https://docs.shareofmodel.ai/api-reference/user-organization-roles/bulk-delete-organization-roles.md): Bulk delete user organization roles. Required permission: `write:organization_role` - [Create organization role](https://docs.shareofmodel.ai/api-reference/user-organization-roles/create-organization-role.md): Create a user organization role. Required permission: `write:organization_role` - [Delete organization role](https://docs.shareofmodel.ai/api-reference/user-organization-roles/delete-organization-role.md): Delete a user organization role. Required permission: `write:organization_role` - [List organization roles](https://docs.shareofmodel.ai/api-reference/user-organization-roles/list-organization-roles.md): List user organization roles in a given organization. Required permission: `read:organization_role` - [Retrieve organization role](https://docs.shareofmodel.ai/api-reference/user-organization-roles/retrieve-organization-role.md): Retrieve a user organization role by id. Required permission: `read:organization_role` - [Update organization role](https://docs.shareofmodel.ai/api-reference/user-organization-roles/update-organization-role.md): Update a user organization role. Required permission: `write:organization_role` - [Bulk delete workspace roles](https://docs.shareofmodel.ai/api-reference/user-workspace-roles/bulk-delete-workspace-roles.md): Bulk delete user workspace roles. Required permission: `write:workspace_role` - [Create workspace role](https://docs.shareofmodel.ai/api-reference/user-workspace-roles/create-workspace-role.md): Create a new user workspace role. Required permission: `write:workspace_role` - [Delete workspace role](https://docs.shareofmodel.ai/api-reference/user-workspace-roles/delete-workspace-role.md): Delete a user workspace role. Required permission: `write:workspace_role` - [List workspace roles](https://docs.shareofmodel.ai/api-reference/user-workspace-roles/list-workspace-roles.md): List user workspace roles in a given workspace. Required permission: `read:workspace_role` - [Retrieve workspace role](https://docs.shareofmodel.ai/api-reference/user-workspace-roles/retrieve-workspace-role.md): Retrieve a user workspace role by id. Required permission: `read:workspace_role` - [Update workspace role](https://docs.shareofmodel.ai/api-reference/user-workspace-roles/update-workspace-role.md): Update a user workspace role. Required permission: `write:workspace_role` - [Compute GEO Audit cost](https://docs.shareofmodel.ai/api-reference/website-evaluation/compute-geo-audit-cost.md): Returns the number of Generations required to run a GEO Audit for the given list of URLs. Required permission: `write:analysis`. - [Create website evaluation](https://docs.shareofmodel.ai/api-reference/website-evaluation/create-website-evaluation.md): Create website evaluation. - [Destroy website evaluation](https://docs.shareofmodel.ai/api-reference/website-evaluation/destroy-website-evaluation.md): Destroy a website evaluation by ID. - [Get screenshots for website evaluation result](https://docs.shareofmodel.ai/api-reference/website-evaluation/get-screenshots-for-website-evaluation-result.md): Retrieve all screenshots (human view and AI view) for a website evaluation's results. - [Insert results for a website evaluation v2](https://docs.shareofmodel.ai/api-reference/website-evaluation/insert-results-for-a-website-evaluation-v2.md): Insert one or more results for a website evaluation. Each result must include a url, and evaluation metrics. Required permission: `authenticated`. - [List website evaluations](https://docs.shareofmodel.ai/api-reference/website-evaluation/list-website-evaluations.md): List website evaluation - [Retrieve website evaluation V2](https://docs.shareofmodel.ai/api-reference/website-evaluation/retrieve-website-evaluation-v2.md): Retrieve a website evaluation by id. - [Update website evaluation](https://docs.shareofmodel.ai/api-reference/website-evaluation/update-website-evaluation.md): Update a website evaluation using PATCH (partial update). - [Update website evaluation](https://docs.shareofmodel.ai/api-reference/website-evaluation/update-website-evaluation-1.md): Update a website evaluation using PATCH (partial update). - [Update website evaluation status](https://docs.shareofmodel.ai/api-reference/website-evaluation/update-website-evaluation-status.md): Update the status of a website evaluation. Required permission: `admin`. - [Archive all resources in a workspace](https://docs.shareofmodel.ai/api-reference/workspace/archive-all-resources-in-a-workspace.md): Archives all analyses and website evaluations in a workspace. Called by Hal when a workspace is archived. - [Delete all resources in a workspace](https://docs.shareofmodel.ai/api-reference/workspace/delete-all-resources-in-a-workspace.md): Deletes all analyses, shopping analyses, and website evaluations in a workspace. Called by Hal when a workspace is deleted. - [Create workspace](https://docs.shareofmodel.ai/api-reference/workspaces/create-workspace.md): Create a workspace in an organization. The logo field is omitted from the response unless `include_logo=true`. Required permission: `write:workspace`. - [Delete workspace](https://docs.shareofmodel.ai/api-reference/workspaces/delete-workspace.md): Delete workspace by id. Required permission: `write:workspace`. - [Filter workspaces](https://docs.shareofmodel.ai/api-reference/workspaces/filter-workspaces.md): Filter workspaces on given criteria. At least one of `name`, `module`, `pencil_client_id`, `pencil_client_uuid`, or `is_pencil` is required. The logo field is omitted unless `include_logo=true`. - [Get all workspaces usage info](https://docs.shareofmodel.ai/api-reference/workspaces/get-all-workspaces-usage-info.md): Get all workspaces information, which includes the analyses count and members count. The logo field is omitted unless `include_logo=true`. - [List workspaces](https://docs.shareofmodel.ai/api-reference/workspaces/list-workspaces.md): List accessible workspaces in a given organization. The logo field is omitted unless `include_logo=true`. - [Retrieve workspace](https://docs.shareofmodel.ai/api-reference/workspaces/retrieve-workspace.md): Retrieve workspace by id. The logo field is omitted unless `include_logo=true`. - [Update workspace](https://docs.shareofmodel.ai/api-reference/workspaces/update-workspace.md): Update the workspace attributes (name, analysis quota, asset evaluation quota, logo). The logo field is omitted from the response unless `include_logo=true`. Required permission: `write:workspace`. - [Analyses & Collects](https://docs.shareofmodel.ai/concepts/analyses-and-collects.md): The central data unit of Share Of Model — how analyses are scoped, run, and become available. - [Brand Catalog](https://docs.shareofmodel.ai/concepts/brand-catalog.md): How brands and competitors are modelled, deduplicated, and linked to analyses. - [Introduction](https://docs.shareofmodel.ai/concepts/introduction.md): What Share Of Model is and what it measures - [Organizations & Workspaces](https://docs.shareofmodel.ai/concepts/organizations-workspaces.md): Tenancy hierarchy and roles in Share Of Model - [Recommendations & Briefs](https://docs.shareofmodel.ai/concepts/recommendations-and-briefs.md): How Share Of Model turns measurement into marketing action — recommendations, briefs and execution. - [Visibility, Perception & Influence](https://docs.shareofmodel.ai/concepts/visibility-perception-influence.md): The mental model that ties Search Visibility, Brand Perception and Sources together. - [Statuses & actions](https://docs.shareofmodel.ai/dd.md) - [Generation method](https://docs.shareofmodel.ai/generation-method.md) - [Documentation](https://docs.shareofmodel.ai/home.md): Build and operate with Share Of Model — API, platform, and modules - [Understanding the 3 channel groups](https://docs.shareofmodel.ai/opportunities-details.md) - [Overview](https://docs.shareofmodel.ai/overview.md) - [Asset Evaluation Starter Kit](https://docs.shareofmodel.ai/platform/evaluations/asset-evaluation-starter-kit.md): Set up and launch your first asset evaluation, then read and compare the results. - [GEO Audit](https://docs.shareofmodel.ai/platform/evaluations/geo-audit.md): Assess your website's readiness for AI-generated answers through 4 complementary scores. - [Introduction to Asset Evaluation](https://docs.shareofmodel.ai/platform/evaluations/introduction-to-asset-evaluation-a-smarter-way-to-test-creative-assets.md): Score creative assets against brand attributes using multimodal LLMs to refine campaign messaging. - [Pencil Agent — User Guide](https://docs.shareofmodel.ai/platform/evaluations/share-of-model-agent-in-pencil-user-guide.md): Use the Share Of Model agent inside Pencil to analyse brand perception and guide content creation. - [Scoring in Pencil Pro](https://docs.shareofmodel.ai/platform/evaluations/share-of-model-scoring-in-pencil-pro.md): Evaluate creative assets directly from Pencil Pro using Share Of Model brand-attribute scoring. - [API Documentation Guide](https://docs.shareofmodel.ai/platform/getting-started/api-documentation-user-guide.md): Programmatically access Share Of Model visibility and perception data — auth, modules and core concepts. - [Registration Best Practices](https://docs.shareofmodel.ai/platform/getting-started/best-practices-to-complete-your-registration-and-get-started-on-share-of-model-platform.md): Sign in to Share Of Model with Google, Microsoft, or email — and pick the right method for your provider. - [Creating and Managing API Keys](https://docs.shareofmodel.ai/platform/getting-started/creating-and-managing-api-keys.md): Create user, workspace, and organisation API keys to securely connect external tools to Share Of Model. - [Executive Dashboard](https://docs.shareofmodel.ai/platform/getting-started/executive-dashboard-your-ai-performance-command-center.md): Consolidated executive view of AI performance from your Search Visibility analyses. - [MCP Server Setup](https://docs.shareofmodel.ai/platform/getting-started/get-started-with-share-of-model-mcp.md): Connect Claude Desktop, Claude Code, MCP Inspector or any MCP client to Share Of Model. - [Platform Overview & Metrics](https://docs.shareofmodel.ai/platform/getting-started/introducing-share-of-model-platform-the-new-metrics-and-their-significance.md): Why brand performance measurement needs new metrics in the age of LLM-driven search. - [Available LLM Models](https://docs.shareofmodel.ai/platform/getting-started/models-list-of-llms-models-apis.md): Up-to-date list of LLM APIs used by Share Of Model with status, release and sunset dates. - [Network & Email Configuration](https://docs.shareofmodel.ai/platform/getting-started/network-email-configuration-guide-for-it-administrators-share-of-model.md): Domains and email senders to whitelist on your corporate network and email filtering tools. - [Search Credit System Update](https://docs.shareofmodel.ai/platform/getting-started/search-new-credit-system-what-s-changing.md): The new Search credit pack — flexible, contract-long, and free of weekly resets. - [FAQs](https://docs.shareofmodel.ai/platform/getting-started/share-of-model-faqs.md): Frequently asked questions about the Brand Analysis module — metrics, methodology and credits. - [SLA & SLO Engagement](https://docs.shareofmodel.ai/platform/getting-started/sla-slo-engagement.md): Service Level Agreements and Objectives for the Share Of Model platform. - [Data Collection & Compliance](https://docs.shareofmodel.ai/platform/getting-started/understanding-data-collection-and-compliance-in-share-of-model-platform.md): What Share Of Model collects, how it stores it, and how compliance is enforced end to end. - [Security & Compliance](https://docs.shareofmodel.ai/platform/getting-started/understanding-security-and-compliance-in-share-of-model-platform.md): How Share Of Model is designed, operated and continuously improved against SOC 2 principles and best practices. - [Credit System](https://docs.shareofmodel.ai/platform/getting-started/understanding-the-credit-system-for-share-of-model.md): How Share Of Model meters usage across Brand Analysis, Asset Evaluation and Search. - [User Roles & Workspaces](https://docs.shareofmodel.ai/platform/getting-started/user-roles-and-workspaces-management.md): Manage members, roles and workspaces from the Share Of Model settings as an organisation owner. - [Attribute Influence Sources (Beta)](https://docs.shareofmodel.ai/platform/models/attributes-influence-sources-beta.md): Identify the websites and platforms that most influence LLM understanding of your category. - [Brand Analysis Starter Kit](https://docs.shareofmodel.ai/platform/models/brand-analysis-starter-kit.md): Create and manage Brand analyses inside your workspace, from setup to live insights. - [Prompt System & Methodology](https://docs.shareofmodel.ai/platform/models/brand-module-prompt-system-methodology.md): How the Brand module works, why it relies on open-ended prompts, and how it differs from Search Analysis. - [Category Landscape — Awareness](https://docs.shareofmodel.ai/platform/models/category-landscape-awareness-analysis.md): Measure brand awareness inside an LLM-driven category landscape with mention rate, position and share of voice. - [Google Ads PMax Integration (Beta)](https://docs.shareofmodel.ai/platform/models/introducing-jellyfish-s-share-of-model-integration-with-google-ads-performance-max-pmax-beta.md): Activate Share Of Model brand-perception insights inside Google Ads Performance Max campaigns. - [TikTok Search Ads Integration (Beta)](https://docs.shareofmodel.ai/platform/models/introducing-share-of-model-integration-with-tiktok-search-ads-beta.md): Turn Share Of Model insights into high-intent keyword recommendations for TikTok Search Ads. - [Key Attributes — Brand Perception](https://docs.shareofmodel.ai/platform/models/key-attributes-brand-competitor-perception-analysis.md): Quantify how LLMs perceive specific brand attributes vs. competitors on a -5 to +5 scale. - [Pros & Cons — Category Perception](https://docs.shareofmodel.ai/platform/models/pros-cons-category-perception-analysis.md): Map brand strengths and weaknesses as perceived by LLMs, by cluster, by depth and by model. - [Reddit Feed](https://docs.shareofmodel.ai/platform/models/reddit-feed-overview.md): Explore Reddit posts gathered through Sources and identify the subreddits driving LLM responses. - [Smart Audience (Beta)](https://docs.shareofmodel.ai/platform/models/smart-audience-use-llm-powered-segments-to-supercharge-your-paid-strategy-beta.md): Identify the most relevant customer personas per category using LLM-powered segments, refreshed monthly. - [Multi-Channel Opportunities & Brief](https://docs.shareofmodel.ai/platform/roadmap/coming-soon-multi-channel-opportunities-brief.md): Turn GEO insights into channel-ready marketing action — directly from the platform. - [Brand Mentions](https://docs.shareofmodel.ai/platform/search/brand-mentions-what-how-purpose.md): Rank competing brands by visibility across generative engines and compare them side by side. - [Mentions](https://docs.shareofmodel.ai/platform/search/brand-vs-product-mentions.md): Understand how brands and products are mentioned across generative answers. - [Fan-out Queries](https://docs.shareofmodel.ai/platform/search/fan-out-queries-what-how-purpose.md): Inspect the internal queries LLMs use to build their answers and where your domain fits in. - [Overview](https://docs.shareofmodel.ai/platform/search/overview-what-how-purpose.md): Track domain and brand visibility across traditional and AI-powered engines from a single dashboard. - [Presence Rate](https://docs.shareofmodel.ai/platform/search/presence-rate.md): Measure how consistently a brand or domain appears in generative answers. - [Prompts](https://docs.shareofmodel.ai/platform/search/prompts-what-how-purpose.md): Visualize the presence and positioning of your domain and brand for each tracked prompt across search engines. - [Ranked URLs](https://docs.shareofmodel.ai/platform/search/ranked-urls-what-how-purpose.md): See which of your pages appear as links in LLM answers and how they perform against competing URLs. - [Sentiment Score](https://docs.shareofmodel.ai/platform/search/sentiment-score.md): Measure how positively or negatively a brand is framed in generative answers. - [Sources & Links](https://docs.shareofmodel.ai/platform/search/sources-links-what-how-purpose.md): Understand how domains and URLs influence LLM answers and how they appear in the final output. - [Visibility Gap](https://docs.shareofmodel.ai/platform/search/visibility-gap-what-how-purpose.md): Compare your domain and brand visibility against up to four competitors at prompt level. - [Visibility Score](https://docs.shareofmodel.ai/platform/search/visibility-score.md): Understand how the Visibility Score combines presence and positioning into a single 0–100 metric. - [What is query fan-out and why it matters in LLM search?](https://docs.shareofmodel.ai/platform/search/what-is-query-fan-out-and-why-it-matters-in-llm-search.md): Learn how LLMs expand a single prompt into multiple internal queries and how that shapes visibility. - [What's the difference between sources and links?](https://docs.shareofmodel.ai/platform/search/what-s-the-difference-between-sources-and-links.md): Cited URLs feed the LLM's answer; ranked URLs appear in it. Learn why the distinction matters for activation. - [The brief](https://docs.shareofmodel.ai/the-brief.md) ## OpenAPI Specs - [swagger](https://openapi.shareofmodel.ai/swagger.json) - [swagger-sos](https://openapi.shareofmodel.ai/swagger-sos.json) - [openapi](https://docs.shareofmodel.ai/api-reference/openapi.json)