> ## 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 Ads Analytics > Ad spend, attributed sales, ROAS, and ACOS over the last 28 days, and per-product sales and ad metrics for today, yesterday, 7-day and 28-day averages, and the same day one and four weeks ago. Matches the Ads page. Requires `analytics:read`. Amounts are in `data.filters.currency`. The periods count back from the end of the range. ## OpenAPI ````yaml /openapi.json get /api/v1/analytics/ads 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/ads: get: tags: - analytics summary: Get Ads Analytics description: >- Ad spend, attributed sales, ROAS, and ACOS over the last 28 days, and per-product sales and ad metrics for today, yesterday, 7-day and 28-day averages, and the same day one and four weeks ago. Matches the Ads page. Requires `analytics:read`. Amounts are in `data.filters.currency`. The periods count back from the end of the range. operationId: get_v1_analytics_ads 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 Ads 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 anchorDate: type: string description: The last day the periods count back from. kpiDateRange: type: object properties: from: type: string to: type: string required: - from - to description: The 28 days the KPI totals cover. kpis: type: object properties: spend: type: number attributedGmv: type: number attributedOrders: type: number impressions: type: number clicks: type: number roas: anyOf: - type: number - type: 'null' acos: anyOf: - type: number - type: 'null' productCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 productsWithAds: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - spend - attributedGmv - attributedOrders - impressions - clicks - roas - acos - productCount - productsWithAds coverage: type: object properties: ads: type: boolean productLevelAds: type: boolean feeLineOnly: type: boolean description: >- Only ad fee lines are known, not per-product ad data. required: - ads - productLevelAds - feeLineOnly message: anyOf: - type: string - type: 'null' products: type: array items: type: object properties: productId: 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' sku: anyOf: - type: string - type: 'null' externalProductId: anyOf: - type: string - type: 'null' last28Totals: type: object properties: revenue: anyOf: - type: number - type: 'null' orders: anyOf: - type: number - type: 'null' qtySold: anyOf: - type: number - type: 'null' avgUnitPrice: anyOf: - type: number - type: 'null' adSpend: anyOf: - type: number - type: 'null' adRevenue: anyOf: - type: number - type: 'null' adOrders: anyOf: - type: number - type: 'null' adQtySold: anyOf: - type: number - type: 'null' adRoas: anyOf: - type: number - type: 'null' hasSales: type: boolean hasAds: type: boolean required: - revenue - orders - qtySold - avgUnitPrice - adSpend - adRevenue - adOrders - adQtySold - adRoas - hasSales - hasAds periods: type: array items: type: object properties: period: type: string enum: - today - yesterday - avg_7 - d7 - avg_28 - d28 label: type: string isAverage: type: boolean revenue: anyOf: - type: number - type: 'null' orders: anyOf: - type: number - type: 'null' qtySold: anyOf: - type: number - type: 'null' avgUnitPrice: anyOf: - type: number - type: 'null' adSpend: anyOf: - type: number - type: 'null' adRevenue: anyOf: - type: number - type: 'null' adOrders: anyOf: - type: number - type: 'null' adQtySold: anyOf: - type: number - type: 'null' adRoas: anyOf: - type: number - type: 'null' hasSales: type: boolean hasAds: type: boolean required: - period - label - isAverage - revenue - orders - qtySold - avgUnitPrice - adSpend - adRevenue - adOrders - adQtySold - adRoas - hasSales - hasAds required: - productId - productName - thumbnailUrl - platform - accountId - sku - externalProductId - last28Totals - periods required: - filters - anchorDate - kpiDateRange - kpis - coverage - message - products 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.