Casa Intelligence Landing Pages API

openapi: 3.2.0
info:
  title: Casa Intelligence Engine Landing Pages API
  description: Proprietary data ingestion, analysis, and prediction engine for Queensland property development intelligence.
  version: 2.0.0
tags:
- name: Landing Pages
paths:
  /api/v1/landing-pages:
    post:
      tags:
      - Landing Pages
      summary: Create Landing Page Endpoint
      description: Create a new landing page for a property.
      operationId: create_landing_page_endpoint_api_v1_landing_pages_post
      security:
      - HTTPBearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LandingPageCreate'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/app__schemas__landing__LandingPageResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Landing Pages
      summary: List Landing Pages
      description: List landing pages for the user's organization with scan counts.
      operationId: list_landing_pages_api_v1_landing_pages_get
      security:
      - HTTPBearer: []
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          default: 1
          title: Page
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          default: 20
          title: Page Size
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/app__schemas__landing__LandingPageResponse'
                title: Response List Landing Pages Api V1 Landing Pages Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/landing-pages/{page_id}/analytics:
    get:
      tags:
      - Landing Pages
      summary: Landing Page Analytics
      description: Get full scan analytics for a landing page.
      operationId: landing_page_analytics_api_v1_landing_pages__page_id__analytics_get
      security:
      - HTTPBearer: []
      parameters:
      - name: page_id
        in: path
        required: true
        schema:
          type: string
          title: Page Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScanAnalytics'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/landing-pages/p/{slug}:
    get:
      tags:
      - Landing Pages
      summary: Render Landing Page
      description: 'Public landing page render. Records a scan and returns branded Jinja2 HTML.


        Self-healing: if no landing page exists for this slug but a matching

        report does (slug = first 8 chars of report ID), the landing page is

        auto-created from the report data.'
      operationId: render_landing_page_api_v1_landing_pages_p__slug__get
      parameters:
      - name: slug
        in: path
        required: true
        schema:
          type: string
          title: Slug
      responses:
        '200':
          description: Successful Response
          content:
            text/html:
              schema:
                type: string
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/landing-pages/p/{slug}/capture:
    post:
      tags:
      - Landing Pages
      summary: Capture Lead Endpoint
      description: 'Public endpoint: capture a lead from the landing page form.


        After capturing the lead, sends a property brief email to the lead

        with the key property details from the landing page data.'
      operationId: capture_lead_endpoint_api_v1_landing_pages_p__slug__capture_post
      parameters:
      - name: slug
        in: path
        required: true
        schema:
          type: string
          title: Slug
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LeadCapture'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    LandingPageCreate:
      properties:
        property_id:
          type: string
          title: Property Id
        page_type:
          type: string
          title: Page Type
          default: property
        property_data:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Property Data
      type: object
      required:
      - property_id
      title: LandingPageCreate
      description: Request body for creating a new landing page.
    LeadCapture:
      properties:
        email:
          type: string
          format: email
          title: Email
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        phone:
          anyOf:
          - type: string
          - type: 'null'
          title: Phone
      type: object
      required:
      - email
      title: LeadCapture
      description: Public form submission for email capture on landing pages.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ScanAnalytics:
      properties:
        total_scans:
          type: integer
          title: Total Scans
        unique_visitors:
          type: integer
          title: Unique Visitors
        scans_by_day:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Scans By Day
        scans_by_device:
          additionalProperties:
            type: integer
          type: object
          title: Scans By Device
        scans_by_hour:
          additionalProperties:
            type: integer
          type: object
          title: Scans By Hour
      type: object
      required:
      - total_scans
      - unique_visitors
      - scans_by_day
      - scans_by_device
      - scans_by_hour
      title: ScanAnalytics
      description: Full scan analytics breakdown for a landing page.
    app__schemas__landing__LandingPageResponse:
      properties:
        id:
          type: string
          title: Id
        slug:
          type: string
          title: Slug
        property_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Property Id
        property_address:
          anyOf:
          - type: string
          - type: 'null'
          title: Property Address
        page_type:
          type: string
          title: Page Type
        is_white_label:
          type: boolean
          title: Is White Label
        is_active:
          type: boolean
          title: Is Active
        created_at:
          type: string
          title: Created At
        total_scans:
          type: integer
          title: Total Scans
          default: 0
        total_leads:
          type: integer
          title: Total Leads
          default: 0
        unique_visitors:
          type: integer
          title: Unique Visitors
          default: 0
      type: object
      required:
      - id
      - slug
      - page_type
      - is_white_label
      - is_active
      - created_at
      title: LandingPageResponse
      description: Response for a single landing page with scan summary.
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key