Owner operations

get_business_overview

OWNER ONLY. Read booking totals, conversion, no-show rates and estimated commission savings for the last days (default 30). Money values use minor currency units; commission savings are estimates. Requires business ownership.

View as Markdown

Scope & access

Directory + businessRead onlyOwner session required

Requires a valid owner session and ownership of businessId. Customer booking tokens do not authorize this operation.

This tool advertises idempotent behavior. If an idempotencyKey is specified, reuse it with identical arguments only when retrying that same intended action.

Parameters

These are the directory endpoint parameters. Business endpoints scope public discovery to the published business; owner calls still require businessId. Inspect tools/list on your endpoint for the exact schema.

businessIdRequired

string

Published business ID from search_businesses, or the business's booking-page slug (e.g. "studio-nine"); owner calls may also use the business ID shown in the dashboard.

daysOptional

integer

Number of trailing days used for dashboard metrics, 1–366.

Example call

Pass this object to the MCP client's callTool method. Replace placeholders with returned IDs, saved credentials and the customer's details; use future dates appropriate to their request.

get_business_overview · MCP client arguments

json

{
  "name": "get_business_overview",
  "arguments": {
    "businessId": "<businessId>"
  }
}

JSON schemas

Nested fields, formats, enums and constraints are included in the complete schemas. Successful data is returned in structuredContent. SDK input validation and domain errors use different error shapes.

Input schemaJSON Schema

Input JSON Schema

json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "businessId": {
      "type": "string",
      "minLength": 1,
      "description": "Published business ID from search_businesses, or the business's booking-page slug (e.g. \"studio-nine\"); owner calls may also use the business ID shown in the dashboard."
    },
    "days": {
      "default": 30,
      "description": "Number of trailing days used for dashboard metrics, 1–366.",
      "type": "integer",
      "minimum": 1,
      "maximum": 366
    }
  },
  "required": [
    "businessId"
  ]
}

Output schemaJSON Schema

Output JSON Schema

json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "businessId": {
      "type": "string"
    },
    "currency": {
      "type": "string"
    },
    "timezone": {
      "type": "string"
    },
    "period": {
      "type": "object",
      "properties": {
        "days": {
          "type": "number"
        },
        "since": {
          "type": "string"
        },
        "until": {
          "type": "string"
        }
      },
      "required": [
        "days",
        "since",
        "until"
      ],
      "additionalProperties": false
    },
    "totals": {
      "type": "object",
      "properties": {
        "bookings": {
          "type": "number"
        },
        "confirmed": {
          "type": "number"
        }
      },
      "required": [
        "bookings",
        "confirmed"
      ],
      "additionalProperties": false
    },
    "conversion": {
      "type": "object",
      "properties": {
        "attempts": {
          "type": "number"
        },
        "converted": {
          "type": "number"
        },
        "rate": {
          "type": [
            "number",
            "null"
          ]
        }
      },
      "required": [
        "attempts",
        "converted",
        "rate"
      ],
      "additionalProperties": false
    },
    "noShow": {
      "type": "object",
      "properties": {
        "noShows": {
          "type": "number"
        },
        "finished": {
          "type": "number"
        },
        "rate": {
          "type": [
            "number",
            "null"
          ]
        }
      },
      "required": [
        "noShows",
        "finished",
        "rate"
      ],
      "additionalProperties": false
    },
    "commission": {
      "type": "object",
      "properties": {
        "bps": {
          "type": "number"
        },
        "directRevenueMinor": {
          "type": "number"
        },
        "estimatedSavedMinor": {
          "type": "number"
        },
        "currency": {
          "type": "string"
        }
      },
      "required": [
        "bps",
        "directRevenueMinor",
        "estimatedSavedMinor",
        "currency"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "businessId",
    "currency",
    "timezone",
    "period",
    "totals",
    "conversion",
    "noShow",
    "commission"
  ],
  "additionalProperties": false
}

Behavior annotationsMCP

Tool annotations

json

{
  "readOnlyHint": true,
  "destructiveHint": false,
  "idempotentHint": true,
  "openWorldHint": false
}

Errors & next steps

Check isError before reading a success response. Follow nextStep where supplied, and never treat a pending booking as confirmed. See Errors and retries and the booking lifecycle for recovery paths.

Back to all tools