> ## 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 Shopping Overview > Aggregated shopping metrics for the selected date range and filters. Always returns one global summary row (group=null) plus one row per search engine (group={'engine': source_name}), matching samantha's dashboard logic for dimensions=engine combined with the global (no-dimension) aggregate. share_of_shelf = results_count / global_total × 100. All numeric metrics include a prev_value for period-over-period comparison. ## OpenAPI ````yaml https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/shopping/overview 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}/analyses/{project_id}/shopping/overview: get: tags: - Shopping summary: Get Shopping Overview description: >- Aggregated shopping metrics for the selected date range and filters. Always returns one global summary row (group=null) plus one row per search engine (group={'engine': source_name}), matching samantha's dashboard logic for dimensions=engine combined with the global (no-dimension) aggregate. share_of_shelf = results_count / global_total × 100. All numeric metrics include a prev_value for period-over-period comparison. operationId: get_shopping_overview 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: brands in: query required: false schema: type: array items: type: string nullable: true description: >- Restrict results to products whose catalogue brand matches one of these brand names. title: Brands description: >- Restrict results to products whose catalogue brand matches one of these brand names. - name: product_catalog_ids in: query required: false schema: type: array items: type: string nullable: true description: >- Restrict results to products linked to one of these product catalogue IDs. title: Product Catalog Ids description: >- Restrict results to products linked to one of these product catalogue 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: type: array items: $ref: '#/components/schemas/ShoppingOverviewItem' title: Response Get Shopping Overview '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 title: SourcesEnum KeywordOverviewMetricTypeEnum: type: string enum: - Generic - Brand title: KeywordOverviewMetricTypeEnum FunnelStage: type: string enum: - ToFu - MoFu - BoFu title: FunnelStage ShoppingOverviewItem: properties: group: additionalProperties: type: string type: object nullable: true title: Group description: >- Dimension grouping. Null for the global row; {'engine': source_name} for per-engine rows. engines: items: $ref: '#/components/schemas/SourcesEnum' type: array title: Engines description: >- Distinct search engines contributing to this row. A single engine for per-engine rows. products_count: allOf: - $ref: '#/components/schemas/Metric' nullable: true description: Number of distinct products in the selected period. results_count: allOf: - $ref: '#/components/schemas/Metric' nullable: true description: Total product rows across all tracked keywords and sources. product_offers_count: allOf: - $ref: '#/components/schemas/Metric' nullable: true description: Number of distinct merchant offers. products_share_of_shelf: allOf: - $ref: '#/components/schemas/Metric' nullable: true description: >- Share of total shopping result rows, expressed as a percentage. Computed as (results_count / total_results) × 100. products_average_position: allOf: - $ref: '#/components/schemas/Metric' nullable: true description: Average rank position across all appearances. Lower is better. products_min_rating: allOf: - $ref: '#/components/schemas/Metric' nullable: true description: Minimum star rating across all products. products_max_rating: allOf: - $ref: '#/components/schemas/Metric' nullable: true description: Maximum star rating across all products. products_min_price: allOf: - $ref: '#/components/schemas/Metric' nullable: true description: Minimum effective price across all products. products_max_price: allOf: - $ref: '#/components/schemas/Metric' nullable: true description: Maximum effective price across all products. products_currency: type: string nullable: true title: Products Currency description: Most frequently reported currency. products_max_reviews_count: allOf: - $ref: '#/components/schemas/Metric' nullable: true description: Maximum number of customer reviews across all distinct products. merchants_count: allOf: - $ref: '#/components/schemas/Metric' nullable: true description: Number of distinct merchants offering products. brands_count: allOf: - $ref: '#/components/schemas/Metric' nullable: true description: Number of distinct brands. type: object required: - engines title: ShoppingOverviewItem 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 ````