> ## Documentation Index > Fetch the complete documentation index at: https://docs.shareofmodel.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get Ai Visibility Cards > The metrics of the AI Visibility scorecard (ai_visibility_score, visibility_score, mention_presence_rate, average_position, share_of_mentions, sentiment_score) over every selected engine, with the same filters for the current and comparison periods. Explicit prev_collect_ids override the previous period; overlapping collects count only toward current. prev_value is null without comparison collects, and 0 when they hold no eligible row, except sentiment_score, whose value and prev_value are null without a scored citation. Every value has one decimal, except sentiment_score (two decimals, -1 to +1). ## OpenAPI ````yaml https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/ai-visibility-cards openapi: 3.0.3 info: title: Share Of Model API version: v1 description: >- ## Search The Share of Search API provides visibility, presence, and ranking metrics for tracked search and AI engine sources. Use it to analyse how a project performs across keywords, thematics, competitors, and ranked URLs over time. For the previous version of the API, see the [v1 documentation](https://api.shareofsearch.jplus.io/docs/v1). servers: - description: Search - Production API url: https://api.shareofsearch.jplus.io/ security: [] tags: - name: Projects description: >- Manage analyses (projects) within a workspace. Create new analyses and list existing ones. - name: Collects description: >- Access data collection runs and their raw results. List collect runs for an analysis, or retrieve the raw data captured during each run: domain rankings, brand mentions, keyword insights, and LLM/SERP responses. - name: Overview Metrics description: >- High-level, aggregated metrics that summarise the overall performance of an analysis. Use these endpoints to get a quick picture of visibility, presence, andranking across all keywords and sources. - name: Metrics description: >- Detailed, per-entity metrics for deep-diving into specific aspects of an analysis. Break down performance by domain, brand, keyword, URL, or competitor. - name: Insights description: >- Cross-project KPIs aggregated at the workspace or organization level. These endpoints consolidate metrics from all active projects within a workspace, or across every workspace of an organization, to provide a unified view of visibility, mentions, citations, sentiment, and ranking. - name: Shopping description: >- Shopping-specific metrics for analyses that track product listings in shopping engines. Measure product visibility, pricing, merchant coverage, and share of shelf across all tracked keywords and sources. - name: Ads description: >- Sponsored-ad performance across tracked prompts and engines, including coverage, advertiser diversity, brand presence, and share of ad voice. - name: Creators description: >- YouTube creators cited as sources in AI-engine search results, enriched with channel metrics and an Influence Score. Browse creators across every project in a workspace, narrowed by country, engine, brand, category, analysis, and persona filters. - name: Video Analyses description: >- On-demand LLM analysis of an already-cited YouTube video: why it works as a citation source, the brands it treats, and an internal creator pre-brief. Price a selection before committing to it, trigger the analyses, and read the results. - name: Creator Briefs description: >- Partnership briefs written for shortlisted YouTube creators: a markdown document with its brand context, saved and edited by the user, with one version recorded per save and the diff into each version stored at write time. - name: CSV Export description: >- Generic CSV export gateway shared across features. `export_type` selects which dataset to export; each feature registers its own export types and usecases on the same CsvExportUsecase base rather than duplicating the CSV-writing/validation mechanics. paths: /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/ai-visibility-cards: get: tags: - Overview Metrics summary: Get Ai Visibility Cards description: >- The metrics of the AI Visibility scorecard (ai_visibility_score, visibility_score, mention_presence_rate, average_position, share_of_mentions, sentiment_score) over every selected engine, with the same filters for the current and comparison periods. Explicit prev_collect_ids override the previous period; overlapping collects count only toward current. prev_value is null without comparison collects, and 0 when they hold no eligible row, except sentiment_score, whose value and prev_value are null without a scored citation. Every value has one decimal, except sentiment_score (two decimals, -1 to +1). operationId: get_ai_visibility_cards parameters: - name: organization_id in: path required: true schema: type: string title: Organization Id - name: workspace_id in: path required: true schema: type: string title: Workspace Id - name: project_id in: path required: true schema: type: string title: Project Id - name: prev_collect_ids in: query required: false schema: type: array items: type: string nullable: true description: Optional comparison collection IDs. title: Prev Collect Ids description: Optional comparison collection IDs. - name: date_start in: query required: true schema: type: string format: date description: Start of the date range (YYYY-MM-DD) title: Date Start description: Start of the date range (YYYY-MM-DD) - name: date_end in: query required: false schema: type: string format: date nullable: true description: >- End of the date range (YYYY-MM-DD). Defaults to end of period containing date_start. title: Date End description: >- End of the date range (YYYY-MM-DD). Defaults to end of period containing date_start. - name: period in: query required: false schema: enum: - day - week - month - year type: string description: 'Aggregation period: day, week, month, or year' default: week title: Period description: 'Aggregation period: day, week, month, or year' - name: sources in: query required: false schema: type: array items: $ref: '#/components/schemas/SourcesEnum' nullable: true title: Sources - name: thematics in: query required: false schema: type: array items: type: string format: uuid nullable: true description: Filter by a list of thematic IDs title: Thematics description: Filter by a list of thematic IDs - name: keyword_type in: query required: false schema: type: array items: $ref: '#/components/schemas/KeywordOverviewMetricTypeEnum' nullable: true description: Filter by a list of keyword types title: Keyword Type description: Filter by a list of keyword types - name: funnel_stages in: query required: false schema: type: array items: $ref: '#/components/schemas/FunnelStage' nullable: true description: Filter by a list of Funnel Stages title: Funnel Stages description: Filter by a list of Funnel Stages - name: persona_ids in: query required: false schema: type: array items: type: string nullable: true description: Filter by a list of persona IDs title: Persona Ids description: Filter by a list of persona IDs - name: topic_ids in: query required: false schema: type: array items: type: string nullable: true description: Filter by a list of topic IDs title: Topic Ids description: Filter by a list of topic IDs - name: get_neutrals in: query required: false schema: type: boolean nullable: true description: >- Filter by to get results related to neutral prompts, without weakness or strength title: Get Neutrals description: >- Filter by to get results related to neutral prompts, without weakness or strength - name: strength_ids in: query required: false schema: type: array items: type: string nullable: true description: Filter by a list of strength IDs title: Strength Ids description: Filter by a list of strength IDs - name: weakness_ids in: query required: false schema: type: array items: type: string nullable: true description: Filter by a list of weakness IDs title: Weakness Ids description: Filter by a list of weakness IDs responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AiVisibilityCardsResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] components: schemas: SourcesEnum: type: string enum: - Bing - BingAIO - ChatGPT - Perplexity - Google - GoogleAIO - GoogleAIMode - Claude - Gemini - AmazonRufus - Grok - Copilot - Mistral - MuseSpark title: SourcesEnum KeywordOverviewMetricTypeEnum: type: string enum: - Generic - Brand title: KeywordOverviewMetricTypeEnum FunnelStage: type: string enum: - ToFu - MoFu - BoFu title: FunnelStage AiVisibilityCardsResponse: properties: ai_visibility_score: allOf: - $ref: '#/components/schemas/Metric' description: >- Mention-based score of the project's brand amongst the 10 first ranked mentions of each answer, 0-100 with one decimal. visibility_score: allOf: - $ref: '#/components/schemas/Metric' description: >- Legacy visibility score over domain and brand slots, 0-100 with one decimal. mention_presence_rate: allOf: - $ref: '#/components/schemas/Metric' description: >- Answers mentioning the project's brand over answers with a mention, in percent with one decimal. average_position: allOf: - $ref: '#/components/schemas/Metric' description: >- Mean best rank of the project's brand mentions per answer, with one decimal. 0 means no eligible mention; lower is better. share_of_mentions: allOf: - $ref: '#/components/schemas/Metric' description: >- The project's brand mention rows over every mention row, in percent with one decimal. sentiment_score: allOf: - $ref: '#/components/schemas/SentimentScoreMetric' description: >- Mean sentiment of the project's scored citations, -1 to +1 with two decimals. type: object required: - ai_visibility_score - visibility_score - mention_presence_rate - average_position - share_of_mentions - sentiment_score title: AiVisibilityCardsResponse description: >- The six metrics of the AI Visibility scorecard, over every selected engine. HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError Metric: properties: value: type: number title: Value description: Current value for the selected period. prev_value: type: number nullable: true title: Prev Value description: >- Value for the previous comparable period. Null when no comparison period is available. unit: type: string nullable: true title: Unit description: >- Unit of the metric (e.g. '%', 'ms'). Null when the value is dimensionless. type: object required: - value title: Metric SentimentScoreMetric: properties: value: type: number nullable: true title: Value description: Mean scored sentiment; null without scored current data. prev_value: type: number nullable: true title: Prev Value description: Mean comparison sentiment; null without scored previous data. type: object required: - value title: SentimentScoreMetric 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 securitySchemes: HTTPBearer: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.