> ## Documentation Index > Fetch the complete documentation index at: https://docs.omnicommerce.sg/llms.txt > Use this file to discover all available pages before exploring further. # Get Product Analytics > Per-product sales, traffic, price, stock, profit, and ad performance, ranked by net sales, with ranked insights. Pass `productId` for specific products, for example on a product page. Matches the Products page. Requires `analytics:read`. Amounts are in `data.filters.currency`. Only orders in that currency are counted; nothing is converted. A range covers at most 366 days. ## OpenAPI ````yaml /openapi.json get /api/v1/analytics/products openapi: 3.1.0 info: title: OmniCommerce API version: 1.0.0 license: name: Proprietary url: https://omnicommerce.sg/terms description: >- OmniCommerce API surface for agents and developer integrations. Includes public endpoints (merchant discovery, product search, compare, catalog, ACO retrieval) and authenticated endpoints (product management via API key Bearer tokens). servers: - url: https://omnicommerce.sg description: Production - url: http://localhost:3000 description: Local development security: [] tags: - name: agentic-checkout description: Merchant-fulfilled agentic checkout x-group: Agentic Checkout - name: agents description: agents x-group: Agents - name: analytics description: Sales performance across marketplaces x-group: Analytics - name: aops description: Agent operating procedures x-group: AOPs - name: campaigns description: Campaign briefs, offer windows, and marketplace runs x-group: Campaigns - name: developer-platform description: Authenticated developer platform APIs x-group: Developer Platform - name: looks description: AI-styled product looks x-group: Looks - name: oauth description: OAuth token endpoints x-group: OAuth - name: orders description: Workspace and agentic orders x-group: Orders - name: organizations description: Organization management x-group: Organizations - name: price-books description: Marketplace list-price markup rules x-group: Price Books - name: products description: Product CRUD, bulk import, enrichment, publish, and delist x-group: Products - name: promotions description: Central promotions and marketplace sync x-group: Promotions - name: public-agent description: Public agent discovery and catalog APIs x-group: Public Agent - name: returns description: returns x-group: Returns - name: reviews description: Marketplace product reviews and seller replies x-group: Reviews - name: settlements description: settlements x-group: Settlements - name: ucp description: Universal Commerce Protocol x-group: UCP paths: /api/v1/analytics/products: get: tags: - analytics summary: Get Product Analytics description: >- Per-product sales, traffic, price, stock, profit, and ad performance, ranked by net sales, with ranked insights. Pass `productId` for specific products, for example on a product page. Matches the Products page. Requires `analytics:read`. Amounts are in `data.filters.currency`. Only orders in that currency are counted; nothing is converted. A range covers at most 366 days. operationId: get_v1_analytics_products parameters: - name: organizationId in: query required: false description: >- Required for session auth. API keys already belong to one organization. schema: type: string maxLength: 160 - name: from in: query required: false description: >- First day of the range (YYYY-MM-DD). Defaults to 29 days before `to`. schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ - name: to in: query required: false description: Last day of the range, inclusive (YYYY-MM-DD). Defaults to today. schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ - name: timeZone in: query required: false description: >- IANA time zone that defines each day, for example `Asia/Kuala_Lumpur`. Defaults to Asia/Singapore. schema: type: string maxLength: 80 - name: marketplace in: query required: false description: Comma-separated marketplaces, for example `shopee,lazada`. schema: type: string maxLength: 200 - name: country in: query required: false description: Comma-separated countries. One country selects its currency. schema: type: string maxLength: 200 - name: store in: query required: false description: >- Comma-separated store (account) ids from `GET /api/v1/marketplaces/connected`. schema: type: string maxLength: 1000 - name: currency in: query required: false description: >- ISO currency. Only orders in this currency are counted; amounts are not converted. Defaults to the single country's currency, otherwise SGD. schema: type: string maxLength: 3 - name: q in: query required: false description: Search product name or SKU. schema: type: string maxLength: 200 - name: productId in: query required: false description: >- Comma-separated product or variant UUIDs, up to 50, to report only those products. schema: type: string maxLength: 2000 - name: limit in: query required: false description: Products to return, ranked by net sales. schema: default: 50 type: integer minimum: 1 maximum: 100 responses: '200': description: Get Product Analytics content: application/json: schema: type: object properties: ok: type: boolean apiVersion: type: string const: developer_v1 operationId: type: string status: type: string enum: - accepted - completed - failed jobId: type: string productId: type: string warnings: type: array items: type: string recommendations: type: array items: type: string links: type: object propertyNames: type: string additionalProperties: type: string data: type: object properties: filters: type: object properties: from: type: string to: type: string marketplace: type: string country: type: string store: type: string currency: type: string description: Currency of every amount in the response. timeZone: type: string q: type: string required: - from - to - marketplace - country - store - currency - timeZone - q products: type: array items: type: object properties: productId: anyOf: - type: string - type: 'null' variantId: anyOf: - type: string - type: 'null' sku: anyOf: - type: string - type: 'null' productName: type: string thumbnailUrl: anyOf: - type: string - type: 'null' platform: anyOf: - type: string - type: 'null' accountId: anyOf: - type: string - type: 'null' externalProductId: anyOf: - type: string - type: 'null' gmv: type: number netSales: type: number orders: type: integer minimum: -9007199254740991 maximum: 9007199254740991 unitsSold: type: number revenueShare: type: number velocity: type: number description: Units sold per day. gmvChangePercent: anyOf: - type: number - type: 'null' description: >- Change against the previous period of equal length. Null without a baseline. impressions: anyOf: - type: number - type: 'null' pageviews: anyOf: - type: number - type: 'null' visitors: anyOf: - type: number - type: 'null' clicks: anyOf: - type: number - type: 'null' atcUsers: anyOf: - type: number - type: 'null' atcUnits: anyOf: - type: number - type: 'null' viewToOrderCvr: anyOf: - type: number - type: 'null' visitorValue: anyOf: - type: number - type: 'null' listingStatus: anyOf: - type: string - type: 'null' channelsLive: type: integer minimum: -9007199254740991 maximum: 9007199254740991 catalogCurrency: anyOf: - type: string - type: 'null' description: >- Currency of listPrice and salePrice, which can differ from the report currency. marketPrices: type: array items: type: object properties: marketplace: type: string minLength: 1 storeId: anyOf: - type: string - type: 'null' storeName: anyOf: - type: string - type: 'null' productId: anyOf: - type: string - type: 'null' sellerSku: anyOf: - type: string - type: 'null' variation: anyOf: - type: string - type: 'null' country: anyOf: - type: string - type: 'null' currency: type: string pattern: ^[A-Z]{3}$ price: anyOf: - type: number minimum: 0 - type: 'null' salePrice: anyOf: - type: number minimum: 0 - type: 'null' saleStartDate: anyOf: - type: string - type: 'null' saleEndDate: anyOf: - type: string - type: 'null' status: anyOf: - type: string - type: 'null' required: - marketplace - storeId - storeName - productId - sellerSku - variation - country - currency - price - salePrice - saleStartDate - saleEndDate - status listPrice: anyOf: - type: number - type: 'null' salePrice: anyOf: - type: number - type: 'null' discountPct: anyOf: - type: number - type: 'null' promoLift: anyOf: - type: number - type: 'null' description: >- Units per day during promotions against outside them, as a ratio change. completenessScore: anyOf: - type: number - type: 'null' lastPublishedAt: anyOf: - type: string - type: 'null' available: anyOf: - type: number - type: 'null' daysOfCover: anyOf: - type: number - type: 'null' stockoutRisk: anyOf: - type: string - type: 'null' cogs: anyOf: - type: number - type: 'null' cogsCoverage: anyOf: - type: number - type: 'null' description: Share of sold units with a cost price, 0 to 1. platformFees: anyOf: - type: number - type: 'null' adsFees: anyOf: - type: number - type: 'null' contributionProfit: anyOf: - type: number - type: 'null' contributionMargin: anyOf: - type: number - type: 'null' returnRate: anyOf: - type: number - type: 'null' refundAmount: anyOf: - type: number - type: 'null' adsSpend: anyOf: - type: number - type: 'null' adsRoas: anyOf: - type: number - type: 'null' adsAcos: anyOf: - type: number - type: 'null' contentGmv: anyOf: - type: number - type: 'null' peerPriceP50: anyOf: - type: number - type: 'null' description: Median competitor price. searchRank: anyOf: - type: number - type: 'null' alerts: type: array items: type: object properties: code: type: string severity: type: string enum: - info - warn - critical message: type: string required: - code - severity - message required: - productId - variantId - sku - productName - thumbnailUrl - platform - accountId - externalProductId - gmv - netSales - orders - unitsSold - revenueShare - velocity - gmvChangePercent - impressions - pageviews - visitors - clicks - atcUsers - atcUnits - viewToOrderCvr - visitorValue - listingStatus - channelsLive - catalogCurrency - marketPrices - listPrice - salePrice - discountPct - promoLift - completenessScore - lastPublishedAt - available - daysOfCover - stockoutRisk - cogs - cogsCoverage - platformFees - adsFees - contributionProfit - contributionMargin - returnRate - refundAmount - adsSpend - adsRoas - adsAcos - contentGmv - peerPriceP50 - searchRank - alerts insights: type: array items: type: object properties: id: type: string code: type: string severity: type: string enum: - info - warn - critical - opportunity category: type: string enum: - conversion - profit - inventory - ads - growth - data - market - pricing title: type: string summary: type: string impactLabel: type: string impactScore: type: number description: 0 to 100, higher first. productId: anyOf: - type: string - type: 'null' productName: anyOf: - type: string - type: 'null' required: - id - code - severity - category - title - summary - impactLabel - impactScore - productId - productName coverage: type: object properties: sales: type: boolean traffic: type: boolean ads: type: boolean content: type: boolean inventory: type: boolean profit: type: boolean market: type: boolean required: - sales - traffic - ads - content - inventory - profit - market description: Which data sources have data for this range. required: - filters - products - insights - coverage required: - ok - apiVersion - operationId - status - warnings - recommendations - links - data '400': description: Invalid request '401': description: Unauthorized '403': description: Missing the `analytics:read` scope '429': description: Rate limit exceeded '500': description: Internal Server Error security: - bearerAuth: [] components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key description: >- Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.