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

# Get campaign analytics

> 
> **Alpha API** - This endpoint is in active development. Schema may change without notice.

Retrieve lead and call performance aggregated by UTM source, medium, and campaign.

**Includes:**
- Total leads, booked calls, shows, and closes per campaign
- Show rate and close rate per campaign
- Revenue per campaign

**Use Cases:**
- Campaign-level ROAS calculations
- Channel + medium attribution reporting
- Marketing spend optimization across campaigns
  

> **Alpha API** - This endpoint is in active development. Schema may change without notice.

Retrieve lead and call performance aggregated by UTM source, medium, and campaign.

**Includes:**

* Total leads, booked calls, shows, and closes per campaign
* Show rate and close rate per campaign
* Revenue per campaign

**Use Cases:**

* Campaign-level ROAS calculations
* Channel + medium attribution reporting
* Marketing spend optimization across campaigns


## OpenAPI

````yaml openapi.json GET /v1/analytics/campaigns
openapi: 3.1.0
info:
  contact:
    email: support@aura-app.ai
    name: Aura Support
  description: >-
    # Aura Partner Integrations API


    > **Alpha Release** - This API is under active development. Endpoints,
    request/response schemas, and behaviors may change without prior notice. We
    recommend pinning to specific response fields you need and handling unknown
    fields gracefully.


    Enterprise REST API for external partner integrations including

    commission platforms, external mobile apps, and client booking widgets.


    ## MCP Connector


    Aura also exposes a **Model Context Protocol** server at `/mcp` so AI

    assistants (Claude, ChatGPT) can answer questions about a user's own sales
    data.

    If you are building an assistant integration rather than a server-to-server
    one,

    that is almost certainly the surface you want — it is task-shaped ("prep me
    for

    my next call") rather than resource-shaped, and it handles auth per-user.


    Read-only. OAuth 2.1 + PKCE, with Clerk as the authorization server;
    discover it

    from `/.well-known/oauth-protected-resource`. Setup guide:

    https://docs.api.aura-app.ai/mcp-connector


    ## Authentication


    Authenticated endpoints support two authentication methods:


    **1. API Key (for partners and integrations):**

    ```

    Authorization: Bearer aura_pk_live_xxxxxxxxxxxxxxxx

    ```

    Get your API key from the Aura dashboard at Settings > API Keys.


    **2. Clerk JWT (for mobile and web apps):**

    ```

    Authorization: Bearer <clerk_jwt_token>

    ```

    Use Clerk's authentication SDK to obtain a JWT token with org claims.


    ## Rate Limiting


    - **Per API Key:** 100 requests/minute

    - **Per Organization:** 1000 requests/minute


    Rate limit headers are included in all responses:

    - `X-RateLimit-Limit`: Maximum requests allowed

    - `X-RateLimit-Remaining`: Remaining requests in current window

    - `X-RateLimit-Reset`: Unix timestamp when limit resets


    These counters are held per serving instance, so under concurrency the

    effective ceiling is higher than the number above and the headers describe
    one

    instance's view rather than a global total. Treat a 429 as backpressure to
    obey

    and pace your client to the documented rate — but do not rely on us to
    reject

    your 101st request, and do not derive a global remaining-quota figure from
    the

    headers. The limit may become globally enforced without notice, so a client

    that stays within it will not be affected when that happens.


    ## Pagination


    List endpoints support cursor-based pagination:

    - `limit`: Number of results per page (default: 50, max: 100)

    - `cursor`: Opaque cursor for next page


    ## Error Handling


    All errors follow a standard format:


    ```json

    {
      "success": false,
      "error": "Error message",
      "code": "ERROR_CODE"
    }

    ```


    Common HTTP status codes:

    - **400** Bad Request - Invalid input (`VALIDATION_ERROR`)

    - **401** Unauthorized - Missing or invalid API key (`AUTHENTICATION_ERROR`)

    - **402** Payment Required - The key is valid, but the organization's
    subscription is not active (`PAYMENT_REQUIRED`). Every authenticated
    endpoint can return this. Retrying will not help until the account's payment
    method is updated in Aura; surface it to the account owner rather than
    treating it as an auth failure.

    - **403** Forbidden - Insufficient permissions (`AUTHORIZATION_ERROR`)

    - **404** Not Found - Resource not found (`NOT_FOUND`)

    - **409** Conflict - Resource state prevents the operation (`CONFLICT`)

    - **413** Payload Too Large - Request body exceeds 256KB
    (`PAYLOAD_TOO_LARGE`)

    - **429** Too Many Requests - Rate limit exceeded (`RATE_LIMIT_EXCEEDED`)

    - **500** Internal Server Error - Server error (`INTERNAL_ERROR`)


    ## Webhooks


    Subscribe to real-time events using the Webhooks API. All webhook payloads

    are signed with HMAC-SHA256 for security verification.


    Delivery is at-least-once. Every payload carries an `idempotency_key` that

    is stable across retries of the same event, so you can enforce exactly-once

    with a `(subscription_id, idempotency_key)` unique constraint on your side.


    For full documentation, visit
    [docs.aura-app.ai/api](https://docs.aura-app.ai/api)
  license:
    name: Proprietary
  title: Aura Partner Integrations API
  version: 1.0.0-alpha
servers:
  - description: Production
    url: https://api.aura-app.ai
  - description: Staging
    url: https://staging-api.aura-app.ai
  - description: Local Development
    url: http://localhost:3001
security:
  - bearerAuth: []
tags:
  - description: Lead management operations
    name: Leads
  - description: Call booking and management
    name: Calls
  - description: Booking link configuration (read-only)
    name: Booking Links
  - description: Product catalog (read-only)
    name: Products
  - description: Payment tracking (read-only)
    name: Payments
  - description: Public booking creation
    name: Bookings
  - description: Real-time event subscriptions and webhook management
    name: Webhooks
  - description: >-
      Team member information for commission attribution. **Alpha** - schema may
      change without notice.
    name: Team (Alpha)
  - description: >-
      Dashboard analytics, lead source attribution, and objection analysis.
      **Alpha** - schema may change without notice.
    name: Analytics (Alpha)
  - description: System endpoints (health checks)
    name: System
paths:
  /v1/analytics/campaigns:
    get:
      tags:
        - Analytics (Alpha)
      summary: Get campaign analytics
      description: >-

        > **Alpha API** - This endpoint is in active development. Schema may
        change without notice.


        Retrieve lead and call performance aggregated by UTM source, medium, and
        campaign.


        **Includes:**

        - Total leads, booked calls, shows, and closes per campaign

        - Show rate and close rate per campaign

        - Revenue per campaign


        **Use Cases:**

        - Campaign-level ROAS calculations

        - Channel + medium attribution reporting

        - Marketing spend optimization across campaigns
          
      parameters:
        - description: ISO 8601 start date (defaults to all time)
          in: query
          name: start_date
          required: false
          schema:
            description: ISO 8601 start date (defaults to all time)
            example: '2026-01-01T00:00:00Z'
            type: string
        - description: ISO 8601 end date (defaults to now)
          in: query
          name: end_date
          required: false
          schema:
            description: ISO 8601 end date (defaults to now)
            example: '2026-03-19T23:59:59Z'
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignAnalyticsSuccessResponse'
          description: Successfully retrieved campaign analytics
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MiddlewareErrorResponse'
          description: Request validation failed
          headers:
            X-Request-Id:
              description: Request identifier for support
              schema:
                type: string
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsErrorResponse'
          description: Invalid or missing API key
        '402':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MiddlewareErrorResponse'
          description: The organization's subscription is not active
          headers:
            X-Request-Id:
              description: Request identifier for support
              schema:
                type: string
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MiddlewareErrorResponse'
          description: The API key does not have the required scope
          headers:
            X-Request-Id:
              description: Request identifier for support
              schema:
                type: string
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MiddlewareErrorResponse'
          description: >-
            The request exceeded its processing time limit. Check the outcome
            before retrying a write
          headers:
            X-Request-Id:
              description: Request identifier for support
              schema:
                type: string
        '413':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MiddlewareErrorResponse'
          description: The request body exceeds 256KB
          headers:
            X-Request-Id:
              description: Request identifier for support
              schema:
                type: string
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsErrorResponse'
          description: >-
            Currency is missing or more than one currency is present. Use
            /v1/analytics/revenue for grouped amounts.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsErrorResponse'
          description: Rate limit exceeded
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MiddlewareErrorResponse'
          description: >-
            Unexpected server failure. Include the request identifier when
            contacting support
          headers:
            X-Request-Id:
              description: Request identifier for support
              schema:
                type: string
      security:
        - bearerAuth: []
components:
  schemas:
    CampaignAnalyticsSuccessResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/CampaignAnalytics'
          type: array
        success:
          enum:
            - true
          type: boolean
      required:
        - success
        - data
      type: object
    MiddlewareErrorResponse:
      properties:
        code:
          type: string
        error:
          type: string
        requestId:
          type: string
        success:
          enum:
            - false
          type: boolean
      required:
        - success
        - error
        - code
      type: object
    AnalyticsErrorResponse:
      properties:
        code:
          description: Error code for programmatic handling
          example: DATABASE_ERROR
          type: string
        error:
          description: Human-readable error message
          example: Failed to fetch analytics
          type: string
        requestId:
          description: Request ID for support debugging
          example: req_abc123
          type: string
        success:
          enum:
            - false
          type: boolean
      required:
        - success
        - error
        - code
      type: object
    CampaignAnalytics:
      properties:
        booked_calls:
          description: Number of booked calls
          example: 45
          type: number
        close_rate:
          description: >-
            Close rate as percentage (0-100). Null when no shows for this
            campaign.
          example: 33.3
          nullable: true
          type: number
        closes:
          description: Number of closes
          example: 12
          type: number
        currency:
          description: Recorded currency for the legacy scalar totals.
          type: string
        revenue_summary:
          $ref: '#/components/schemas/RevenueSummary'
        show_rate:
          description: >-
            Show rate as percentage (0-100). Null when no booked calls for this
            campaign.
          example: 80
          nullable: true
          type: number
        shows:
          description: Number of shows
          example: 36
          type: number
        total_leads:
          description: Number of leads from this campaign
          example: 120
          type: number
        total_revenue:
          description: >-
            Total revenue in dollars (numeric, two-decimal precision). NOT
            cents.
          example: 48000
          type: number
        utm_campaign:
          description: UTM campaign value
          example: spring-2026
          type: string
        utm_medium:
          description: UTM medium value
          example: cpc
          type: string
        utm_source:
          description: UTM source value
          example: google
          type: string
      required:
        - revenue_summary
        - currency
        - utm_source
        - utm_medium
        - utm_campaign
        - total_leads
        - booked_calls
        - shows
        - closes
        - total_revenue
        - show_rate
        - close_rate
      type: object
    RevenueSummary:
      description: >-
        Unique sales grouped by recorded currency. Missing or conflicting
        currency amounts are separate. No exchange rate is applied.
      properties:
        by_currency:
          items:
            properties:
              booked_amount:
                type: number
              collected_amount:
                type: number
              currency:
                type: string
              sale_count:
                minimum: 0
                type: integer
            required:
              - booked_amount
              - collected_amount
              - sale_count
              - currency
            type: object
          type: array
        missing_currency:
          properties:
            booked_amount:
              type: number
            collected_amount:
              type: number
            sale_count:
              minimum: 0
              type: integer
          required:
            - booked_amount
            - collected_amount
            - sale_count
          type: object
      required:
        - by_currency
        - missing_currency
      type: object

````

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