> ## 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 Aggregated Insights Metrics > Aggregated metrics across all active projects for a workspace, grouped by optional dimensions (brand, country, category, source, keyword_type). Returns visibility score, share of mentions, share of citations, sentiment score, and average position for the requested date range. ## OpenAPI ````yaml https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/insights/metrics 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 level. These endpoints consolidate metrics from all active projects within a workspace 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. paths: /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/insights/metrics: get: tags: - Insights summary: Get Aggregated Insights Metrics description: >- Aggregated metrics across all active projects for a workspace, grouped by optional dimensions (brand, country, category, source, keyword_type). Returns visibility score, share of mentions, share of citations, sentiment score, and average position for the requested date range. operationId: get_insights_metrics 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: 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: true schema: type: string format: date description: End of the date range (YYYY-MM-DD) title: Date End description: End of the date range (YYYY-MM-DD) - name: period in: query required: false schema: enum: - week - month type: string description: Comparison period granularity default: week title: Period description: Comparison period granularity - name: dimensions in: query required: false schema: type: array items: $ref: '#/components/schemas/DimensionEnum' nullable: true description: Dimensions to group by title: Dimensions description: Dimensions to group by - name: sources in: query required: false schema: type: array items: $ref: '#/components/schemas/SourcesEnum' nullable: true description: Filter by sources title: Sources description: Filter by sources - name: countries in: query required: false schema: type: array items: $ref: '#/components/schemas/CountryCodeEnum' nullable: true description: Filter by countries title: Countries description: Filter by countries - name: brands in: query required: false schema: type: array items: type: string nullable: true description: Filter by brands title: Brands description: Filter by brands - name: categories in: query required: false schema: type: array items: type: string nullable: true description: Filter by categories title: Categories description: Filter by categories - name: keyword_types in: query required: false schema: type: array items: type: string nullable: true description: Filter by keyword types (Brand or Generic) title: Keyword Types description: Filter by keyword types (Brand or Generic) responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/InsightsMetricGroupResponse' title: Response Get Insights Metrics '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] components: schemas: DimensionEnum: type: string enum: - brand - country - category - source - keyword_type title: DimensionEnum SourcesEnum: type: string enum: - Bing - BingAIO - ChatGPT - Perplexity - Google - GoogleAIO - GoogleAIMode - Claude - Gemini - AmazonRufus title: SourcesEnum CountryCodeEnum: type: string enum: - AR - AT - AU - AE - BH - BE - BO - BR - CA - CN - CO - DK - EC - ES - FI - FR - DE - GB - HU - ID - IE - IL - IN - IT - JP - KR - KW - LU - MA - MX - MY - NG - NL - 'NO' - PH - PK - PL - PT - QA - RO - SA - SE - SG - CH - TH - TR - TW - US - VN - ZA title: CountryCodeEnum InsightsMetricGroupResponse: properties: group: additionalProperties: type: string type: object nullable: true title: Group description: >- Dimension group this row belongs to (e.g. {'brand': 'Acme'}). Null when no dimensions requested. visibility_score: allOf: - $ref: '#/components/schemas/Metric' description: Visibility score for this group. share_of_mentions: allOf: - $ref: '#/components/schemas/Metric' description: Share of mentions as a percentage. share_of_citations: allOf: - $ref: '#/components/schemas/Metric' description: Share of citations as a percentage. sentiment_score: allOf: - $ref: '#/components/schemas/Metric' description: Net sentiment score (positive rate minus negative rate). average_position: allOf: - $ref: '#/components/schemas/Metric' description: Average ranking position. Lower is better. sentiment_positive: allOf: - $ref: '#/components/schemas/Metric' description: Share of positive citations as a percentage. sentiment_negative: allOf: - $ref: '#/components/schemas/Metric' description: Share of negative citations as a percentage. sentiment_neutral: allOf: - $ref: '#/components/schemas/Metric' description: Share of neutral citations as a percentage. type: object required: - visibility_score - share_of_mentions - share_of_citations - sentiment_score - average_position - sentiment_positive - sentiment_negative - sentiment_neutral title: InsightsMetricGroupResponse 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 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 ````