openapi: 3.2.0
info:
  title: Zoca Platform Homepage API
  description: 'The Zoca platform API behind the Zoca web app and mobile apps: scheduling, website generation, Google Business Profile, discovery/local SEO, social media, booking enquiries, offers, clients, staff, billing and the Zoca "brain" agent layer.'
  version: 3.20.10
  contact: {}
  x-apievangelist-note: Harvested verbatim from https://api.zoca.ai/swagger.json. The provider ships the default NestJS Swagger metadata (title "API Documentation", empty servers[]); title/description/servers were set by API Evangelist for identification and the unmodified original is preserved at openapi/_original/zoca-platform-swagger.json. Every path, operation, summary, parameter and response is exactly as published.
servers:
- url: https://api.zoca.ai
  description: Production
tags:
- name: homepage
paths:
  /homepage/activation-steps:
    get:
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: ''
      summary: Get activation steps status
      tags:
      - homepage
  /homepage:
    get:
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: ''
      summary: Get homepage data
      tags:
      - homepage
  /homepage/homepage-components:
    get:
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: ''
      summary: Get homepage components
      tags:
      - homepage
  /homepage/user-data:
    get:
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: ''
      summary: Get user data
      tags:
      - homepage
  /homepage/leads-data:
    get:
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: ''
      summary: Get leads data
      tags:
      - homepage
  /homepage/activation-steps-data:
    get:
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: ''
      summary: Get activation steps data
      tags:
      - homepage
  /homepage/performance-data:
    get:
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: ''
      summary: Get performance data
      tags:
      - homepage
  /homepage/oauth-status:
    get:
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: ''
      summary: Get OAuth status
      tags:
      - homepage
  /homepage/footer:
    get:
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: ''
      summary: Get footer data
      tags:
      - homepage
  /homepage/check-website-status:
    get:
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: ''
      summary: Check website status
      tags:
      - homepage
  /homepage/fetch-page-views:
    get:
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: ''
      summary: Fetch page views
      tags:
      - homepage
  /homepage/extend-trial:
    put:
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: ''
      summary: Extend trial period
      tags:
      - homepage
  /homepage/monthly-report:
    get:
      description: When listAll=true returns all active reports; otherwise returns the single report (by reportType or default PERFORMANCE_REPORT).
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: Monthly report(s) retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e'
        '404':
          description: No report found
      summary: Get monthly report(s) for an entity
      tags:
      - homepage
    post:
      operationId: t_value
      parameters: []
      responses:
        '201':
          description: Monthly report created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e'
      summary: Create a new monthly report
      tags:
      - homepage
    put:
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: Monthly report updated successfully
      summary: Update monthly report status
      tags:
      - homepage
  /homepage/referrals/link/{businessEntityId}:
    get:
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: ''
      summary: Get referral link for business
      tags:
      - homepage
  /homepage/referrals:
    post:
      operationId: t_value
      parameters: []
      responses:
        '201':
          description: ''
      summary: Create a referral
      tags:
      - homepage
  /homepage/review-tracker:
    get:
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: ''
      summary: Get review tracker metrics
      tags:
      - homepage
  /homepage/opening-date:
    put:
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: Opening date updated successfully
        '400':
          description: Invalid request parameters
      summary: Update opening date for a GBP location
      tags:
      - homepage
  /homepage/carousel-cards:
    get:
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: Carousel cards data retrieved successfully
      summary: Get carousel cards for Win Agent onboarding
      tags:
      - homepage
  /homepage/website-card-state:
    get:
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: Card state retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e'
        '400':
          description: Invalid entity ID
        '404':
          description: Entity not found
      summary: Get website card state for entity
      tags:
      - homepage
  /homepage/discovery-metrics:
    get:
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: ''
      summary: Get cumulative discovery metrics since onboarding
      tags:
      - homepage
components:
  schemas:
    e:
      type: object
      properties:
        id:
          type: number
        entityId:
          type: string
        attribute:
          type: string
        value:
          type:
          - object
          - 'null'
        metadata:
          type:
          - object
          - 'null'
        createdAt:
          type:
          - object
          - 'null'
      required:
      - id
      - entityId
      - attribute
  securitySchemes:
    access-token:
      scheme: bearer
      bearerFormat: JWT
      type: http
      name: Authorization
      description: Enter JWT token in the format Bearer <token>
      in: header