> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pineyard.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a campaign's commerce results

> One campaign's commerce results — revenue, ROAS, cart funnel, COD→prepaid conversion

**Required scope:** `sales.view`

<Note>Requires commerce analytics enabled for your workspace. Otherwise the request is refused; see [Errors](/concepts/errors).</Note>


## OpenAPI

````yaml /api-reference/openapi.json get /commerce/campaigns/{id}/analytics
openapi: 3.0.3
info:
  title: Pineyard API
  version: 1.0.0
  description: >-
    Programmatic access to agents, campaigns, calls, phone numbers, WhatsApp and
    results in your Pineyard workspace.
servers:
  - url: https://api.pineyard.ai
    description: Production
security:
  - bearerAuth: []
paths:
  /commerce/campaigns/{id}/analytics:
    get:
      summary: Get a campaign's commerce results
      description: >-
        One campaign's commerce results — revenue, ROAS, cart funnel,
        COD→prepaid conversion
      parameters:
        - schema:
            type: string
          required: true
          name: id
          in: path
        - schema:
            type: string
            enum:
              - today
              - 7d
              - 30d
              - 90d
            default: 30d
          required: false
          name: range
          in: query
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  range:
                    type: string
                    enum:
                      - today
                      - 7d
                      - 30d
                      - 90d
                  window:
                    type: object
                    properties:
                      from:
                        type: string
                      to:
                        type: string
                      previousFrom:
                        type: string
                      previousTo:
                        type: string
                      timezone:
                        type: string
                        enum:
                          - Asia/Kolkata
                    required:
                      - from
                      - to
                      - previousFrom
                      - previousTo
                      - timezone
                  orders:
                    type: number
                  revenue:
                    type: array
                    items:
                      type: object
                      properties:
                        currency:
                          type: string
                        amount:
                          type: string
                      required:
                        - currency
                        - amount
                  spendInr:
                    type: number
                  roas:
                    type: number
                    nullable: true
                  funnel:
                    type: object
                    properties:
                      abandoned:
                        type: number
                      outreachAttempted:
                        type: number
                      reached:
                        type: number
                      clicked:
                        type: number
                      recovered:
                        type: number
                      revenueAtRisk:
                        type: array
                        items:
                          type: object
                          properties:
                            currency:
                              type: string
                            amount:
                              type: string
                          required:
                            - currency
                            - amount
                      rates:
                        type: object
                        properties:
                          outreach:
                            type: number
                            nullable: true
                          reached:
                            type: number
                            nullable: true
                          clicked:
                            type: number
                            nullable: true
                          recovered:
                            type: number
                            nullable: true
                        required:
                          - outreach
                          - reached
                          - clicked
                          - recovered
                    required:
                      - abandoned
                      - outreachAttempted
                      - reached
                      - clicked
                      - recovered
                      - revenueAtRisk
                      - rates
                  codToPrepaid:
                    type: object
                    properties:
                      codOrders:
                        type: number
                      codOrdersContacted:
                        type: number
                      prepaidConfirmed:
                        type: number
                      conversionRate:
                        type: number
                        nullable: true
                      currency:
                        type: string
                        enum:
                          - INR
                      revenueShifted:
                        type: number
                      paymentLinkClicks:
                        type: number
                      rtoSavings:
                        type: number
                      assumedRtoRatePct:
                        type: number
                    required:
                      - codOrders
                      - codOrdersContacted
                      - prepaidConfirmed
                      - conversionRate
                      - currency
                      - revenueShifted
                      - paymentLinkClicks
                      - rtoSavings
                      - assumedRtoRatePct
                required:
                  - range
                  - window
                  - orders
                  - revenue
                  - spendInr
                  - roas
                  - funnel
                  - codToPrepaid
        '400':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.

            - `invalid_body`: The request body (or query) failed validation.
            Details are in `issues` (or `detail`). `422` on `POST
            /v1/campaigns/{campaignId}/leads`.

            - `invalid_params`: Commerce query parameters invalid.
        '401':
          description: >-
            - `invalid_api_key`: The API key is unknown, revoked or expired, or
            its workspace was deleted.

            - `unauthorized`: No `Authorization: Bearer` header, or an empty
            token.
        '403':
          description: >-
            - `api_key_not_scoped`: A key issued without scopes was used outside
            `/v1`.

            - `api_key_owner_inactive`: The member the key acts for was removed
            or suspended.

            - `feature_not_available`: This feature is not enabled for your
            workspace or plan.

            - `forbidden`: The key lacks the permission named in
            `requiredPermission`, or the resource belongs to another workspace.

            - `workspace_pending_approval`: The workspace has not been approved
            yet.

            - `workspace_suspended`: The workspace is suspended.
        '404':
          description: '- `campaign_not_found`: No campaign with that id in this workspace.'
        '413':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '429':
          description: '- `rate_limited`: Too many requests.'
        '500':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '502':
          description: >-
            - `provider_error`: The calling service rejected the request
            (`upstreamStatus` 4xx) or was unavailable (5xx).
        '503':
          description: '- `database_unavailable`: The service is temporarily unavailable.'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, e.g. `pk_live_xxxxxxxxxxxxxxxxxxxxxxxx`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.