> ## 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 WhatsApp analytics

> Full WhatsApp analytics — funnel, engagement, per-template/origin/order-trigger, revenue/ROI

**Required scope:** `whatsapp.view`


## OpenAPI

````yaml /api-reference/openapi.json get /whatsapp/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:
  /whatsapp/analytics:
    get:
      summary: Get WhatsApp analytics
      description: >-
        Full WhatsApp analytics — funnel, engagement,
        per-template/origin/order-trigger, revenue/ROI
      parameters:
        - schema:
            type: string
          required: false
          name: campaignId
          in: query
        - schema:
            type: integer
            minimum: 0
            exclusiveMinimum: true
          required: false
          name: days
          in: query
        - schema:
            type: string
            enum:
              - CAMPAIGN
              - AGENT_CALL
              - ORDER_STATUS
              - WORKFLOW
              - MANUAL
              - TEST
              - INBOUND
          required: false
          name: origin
          in: query
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  sent:
                    type: number
                  delivered:
                    type: number
                  read:
                    type: number
                  failed:
                    type: number
                  queued:
                    type: number
                  attempted:
                    type: number
                  replies:
                    type: number
                  clicks:
                    type: number
                  linksClicked:
                    type: number
                  clicksByKind:
                    type: array
                    items:
                      type: object
                      properties:
                        kind:
                          type: string
                        clicks:
                          type: number
                      required:
                        - kind
                        - clicks
                  orders:
                    type: number
                  ordersTotal:
                    type: number
                  revenue:
                    type: number
                  revenueTotal:
                    type: number
                  spend:
                    type: number
                  roi:
                    type: number
                    nullable: true
                  failedReasons:
                    type: array
                    items:
                      type: object
                      properties:
                        reason:
                          type: string
                        count:
                          type: number
                      required:
                        - reason
                        - count
                  sentNoReceipt:
                    type: number
                  webhookRejects7d:
                    type: number
                  perTemplate:
                    type: array
                    items:
                      type: object
                      properties:
                        templateId:
                          type: string
                        purpose:
                          type: string
                        sent:
                          type: number
                        delivered:
                          type: number
                        read:
                          type: number
                        failed:
                          type: number
                        attempted:
                          type: number
                        clicks:
                          type: number
                        orders:
                          type: number
                        revenue:
                          type: number
                      required:
                        - templateId
                        - purpose
                        - sent
                        - delivered
                        - read
                        - failed
                        - attempted
                        - clicks
                        - orders
                        - revenue
                  perOrigin:
                    type: array
                    items:
                      type: object
                      properties:
                        origin:
                          type: string
                          enum:
                            - CAMPAIGN
                            - AGENT_CALL
                            - ORDER_STATUS
                            - WORKFLOW
                            - MANUAL
                            - TEST
                            - INBOUND
                        sent:
                          type: number
                        delivered:
                          type: number
                        read:
                          type: number
                        failed:
                          type: number
                        attempted:
                          type: number
                        spend:
                          type: number
                      required:
                        - origin
                        - sent
                        - delivered
                        - read
                        - failed
                        - attempted
                        - spend
                  perOrderTrigger:
                    type: array
                    items:
                      type: object
                      properties:
                        trigger:
                          type: string
                        sent:
                          type: number
                        delivered:
                          type: number
                        read:
                          type: number
                        failed:
                          type: number
                        attempted:
                          type: number
                        spend:
                          type: number
                      required:
                        - trigger
                        - sent
                        - delivered
                        - read
                        - failed
                        - attempted
                        - spend
                required:
                  - sent
                  - delivered
                  - read
                  - failed
                  - queued
                  - attempted
                  - replies
                  - clicks
                  - linksClicked
                  - clicksByKind
                  - orders
                  - ordersTotal
                  - revenue
                  - revenueTotal
                  - spend
                  - roi
                  - failedReasons
                  - sentNoReceipt
                  - webhookRejects7d
                  - perTemplate
                  - perOrigin
                  - perOrderTrigger
        '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.

            - `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: >-
            - `not_found`: The resource does not exist in your workspace, or the
            feature is not enabled for it.
        '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.
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.