Zoca Reports API

The Reports API from Zoca — 11 operation(s) for reports.

Operations 11

GET /reports/multilocation/{businessEntityId}/frontdesk-overview Front Desk overview — impact, recoveries and locations to watch #
GET /reports/location/{locationEntityId}/frontdesk-overview Front Desk overview for a single location #
GET /reports/location/{locationEntityId}/call-analytics Call analytics for a single location #
GET /reports/location/{locationEntityId}/website-funnel Website funnel for a single location #
GET /reports/multilocation/{businessEntityId}/website-funnel Website funnel — visitors, Book Now clicks, leads and bookings #
GET /reports/multilocation/{businessEntityId}/call-analytics Call analytics — volume, dispositions, heatmap and spam savings #
GET /reports/multilocation/{businessEntityId}/outcomes Outcomes rollup — leads, calls, bookings and revenue over time #
GET /reports/multilocation/{businessEntityId}/overview Reports rollup — network overview #
GET /reports List report templates #
GET /reports/{key} Run a report #
GET /reports/{key}/export.csv Export a report as CSV #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/zoca-reports-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

zoca-reports-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Zoca Platform Reports 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: Reports
paths:
  /reports/multilocation/{businessEntityId}/frontdesk-overview:
    get:
      operationId: t_value
      parameters:
      - name: businessEntityId
        required: true
        in: path
        description: Business entity UUID
        schema: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e'
      security:
      - bearer: []
      summary: Front Desk overview — impact, recoveries and locations to watch
      tags:
      - Reports
  /reports/location/{locationEntityId}/frontdesk-overview:
    get:
      operationId: t_value
      parameters:
      - name: locationEntityId
        required: true
        in: path
        description: Location entity UUID
        schema: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e'
      security:
      - bearer: []
      summary: Front Desk overview for a single location
      tags:
      - Reports
  /reports/location/{locationEntityId}/call-analytics:
    get:
      operationId: t_value
      parameters:
      - name: locationEntityId
        required: true
        in: path
        description: Location entity UUID
        schema: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e'
      security:
      - bearer: []
      summary: Call analytics for a single location
      tags:
      - Reports
  /reports/location/{locationEntityId}/website-funnel:
    get:
      operationId: t_value
      parameters:
      - name: locationEntityId
        required: true
        in: path
        description: Location entity UUID
        schema: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e'
      security:
      - bearer: []
      summary: Website funnel for a single location
      tags:
      - Reports
  /reports/multilocation/{businessEntityId}/website-funnel:
    get:
      operationId: t_value
      parameters:
      - name: businessEntityId
        required: true
        in: path
        description: Business entity UUID
        schema: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e'
      security:
      - bearer: []
      summary: Website funnel — visitors, Book Now clicks, leads and bookings
      tags:
      - Reports
  /reports/multilocation/{businessEntityId}/call-analytics:
    get:
      operationId: t_value
      parameters:
      - name: businessEntityId
        required: true
        in: path
        description: Business entity UUID
        schema: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e'
      security:
      - bearer: []
      summary: Call analytics — volume, dispositions, heatmap and spam savings
      tags:
      - Reports
  /reports/multilocation/{businessEntityId}/outcomes:
    get:
      operationId: t_value
      parameters:
      - name: businessEntityId
        required: true
        in: path
        description: Business entity UUID
        schema: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e'
      security:
      - bearer: []
      summary: Outcomes rollup — leads, calls, bookings and revenue over time
      tags:
      - Reports
  /reports/multilocation/{businessEntityId}/overview:
    get:
      operationId: t_value
      parameters:
      - name: businessEntityId
        required: true
        in: path
        description: Business entity UUID
        schema: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e'
      security:
      - bearer: []
      summary: Reports rollup — network overview
      tags:
      - Reports
  /reports:
    get:
      description: Returns all registered report templates grouped by category.
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e'
      security:
      - bearer: []
      summary: List report templates
      tags:
      - Reports
  /reports/{key}:
    get:
      description: Runs the named report template for one location and date range. Cursor-paginated.
      operationId: t_value
      parameters:
      - name: key
        required: true
        in: path
        description: Template key, e.g. 'sales-summary'
        schema: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e'
        '403':
          description: No access to the requested location
        '404':
          description: Unknown report template
      security:
      - bearer: []
      summary: Run a report
      tags:
      - Reports
  /reports/{key}/export.csv:
    get:
      description: Runs the report to completion and downloads it as a CSV attachment.
      operationId: t_value
      parameters:
      - name: key
        required: true
        in: path
        description: Template key, e.g. 'sales-summary'
        schema: {}
      responses:
        '200':
          description: CSV attachment
      security:
      - bearer: []
      summary: Export a report as CSV
      tags:
      - Reports
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