Get scheduler analytics summary

GET

api

scheduler-analytics

summary

curl --request GET \
  --url https://enterprise-api.avoca.ai/api/scheduler-analytics/summary \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "today": {
      "sessions": 123,
      "bookings": 123,
      "conversionRate": 123
    },
    "thisWeek": {
      "sessions": 123,
      "bookings": 123,
      "conversionRate": 123
    },
    "thisMonth": {
      "sessions": 123,
      "bookings": 123,
      "conversionRate": 123
    }
  },
  "metadata": {
    "timezone": "<string>",
    "generatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

API key in the format avoca_<64 hex characters>

Headers

x-team-id

integer

Target team ID. Required for multi-team (enterprise_all_teams / portfolio_all_teams) keys on v0 endpoints; single-team keys are locked to their team and omit it.

Query Parameters

timezone

string

default:America/New_York

IANA timezone for date calculations (default America/New_York)

Response

Summary stats

data

object

Show child attributes

metadata

object

Show child attributes

List Simple Scheduler booking requestsBooking requests submitted through Simple Scheduler. Supports offset pagination (`offset` + `limit`, returns `meta.total`) or cursor pagination (`cursor` = `created_at` from a previous page; response includes `next_cursor` and `has_more`). Requires the `read:scheduler_analytics` permission.

⌘I

Get scheduler analytics summary

curl --request GET \
  --url https://enterprise-api.avoca.ai/api/scheduler-analytics/summary \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "today": {
      "sessions": 123,
      "bookings": 123,
      "conversionRate": 123
    },
    "thisWeek": {
      "sessions": 123,
      "bookings": 123,
      "conversionRate": 123
    },
    "thisMonth": {
      "sessions": 123,
      "bookings": 123,
      "conversionRate": 123
    }
  },
  "metadata": {
    "timezone": "<string>",
    "generatedAt": "2023-11-07T05:31:56Z"
  }
}