> ## 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 Store Analytics

> Seller Centre shop metrics: visitors, page views, followers, the placed, paid, and confirmed buyer funnel, a daily trend, and the app and web split. Matches the Analytics (Seller Centre) 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/stores
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: documents
    description: Knowledge base document uploads
    x-group: Knowledge Base
  - 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/stores:
    get:
      tags:
        - analytics
      summary: Get Store Analytics
      description: >-
        Seller Centre shop metrics: visitors, page views, followers, the placed,
        paid, and confirmed buyer funnel, a daily trend, and the app and web
        split. Matches the Analytics (Seller Centre) 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_stores
      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
      responses:
        '200':
          description: Get Store 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
                        required:
                          - from
                          - to
                          - marketplace
                          - country
                          - store
                          - currency
                          - timeZone
                      hasData:
                        type: boolean
                      totals:
                        type: object
                        properties:
                          visitors:
                            type: number
                          pageViews:
                            type: number
                          newVisitors:
                            type: number
                          returningVisitors:
                            type: number
                          newFollowers:
                            type: number
                          averagePageViews:
                            anyOf:
                              - type: number
                              - type: 'null'
                          averageStaySeconds:
                            anyOf:
                              - type: number
                              - type: 'null'
                          placedBuyers:
                            type: number
                          placedUnits:
                            type: number
                          placedOrders:
                            type: number
                          placedSales:
                            type: number
                          paidBuyers:
                            type: number
                          paidUnits:
                            type: number
                          paidOrders:
                            type: number
                          paidSales:
                            type: number
                          confirmedBuyers:
                            type: number
                          confirmedUnits:
                            type: number
                          confirmedOrders:
                            type: number
                          confirmedSales:
                            type: number
                          bounceRate:
                            anyOf:
                              - type: number
                              - type: 'null'
                          visitorToPlacedRate:
                            anyOf:
                              - type: number
                              - type: 'null'
                          visitorToPaidRate:
                            anyOf:
                              - type: number
                              - type: 'null'
                          visitorToConfirmedRate:
                            anyOf:
                              - type: number
                              - type: 'null'
                          placedToPaidRate:
                            anyOf:
                              - type: number
                              - type: 'null'
                          placedToConfirmedRate:
                            anyOf:
                              - type: number
                              - type: 'null'
                        required:
                          - visitors
                          - pageViews
                          - newVisitors
                          - returningVisitors
                          - newFollowers
                          - averagePageViews
                          - averageStaySeconds
                          - placedBuyers
                          - placedUnits
                          - placedOrders
                          - placedSales
                          - paidBuyers
                          - paidUnits
                          - paidOrders
                          - paidSales
                          - confirmedBuyers
                          - confirmedUnits
                          - confirmedOrders
                          - confirmedSales
                          - bounceRate
                          - visitorToPlacedRate
                          - visitorToPaidRate
                          - visitorToConfirmedRate
                          - placedToPaidRate
                          - placedToConfirmedRate
                      trend:
                        type: array
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                            visitors:
                              type: number
                            pageViews:
                              type: number
                            paidOrders:
                              type: number
                            paidSales:
                              type: number
                          required:
                            - date
                            - visitors
                            - pageViews
                            - paidOrders
                            - paidSales
                      deviceBreakdown:
                        type: array
                        items:
                          type: object
                          properties:
                            device:
                              type: string
                              enum:
                                - app
                                - pc
                            visitors:
                              type: number
                            pageViews:
                              type: number
                            newVisitors:
                              type: number
                            returningVisitors:
                              type: number
                            bounceRate:
                              anyOf:
                                - type: number
                                - type: 'null'
                          required:
                            - device
                            - visitors
                            - pageViews
                            - newVisitors
                            - returningVisitors
                            - bounceRate
                      coverage:
                        type: object
                        properties:
                          platforms:
                            type: array
                            items:
                              type: string
                          sources:
                            type: array
                            items:
                              type: string
                          firstDate:
                            anyOf:
                              - type: string
                              - type: 'null'
                          lastDate:
                            anyOf:
                              - type: string
                              - type: 'null'
                        required:
                          - platforms
                          - sources
                          - firstDate
                          - lastDate
                    required:
                      - filters
                      - hasData
                      - totals
                      - trend
                      - deviceBreakdown
                      - 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.