Get scheduler analytics

GET

api

scheduler-analytics

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

{
  "data": {
    "funnel": {
      "sessions": 123,
      "bookingStarted": 123,
      "customerInfoCompleted": 123,
      "bookingCompleted": 123,
      "conversionRate": 123
    },
    "bookings": {
      "total": 123,
      "avgBookingTimeSeconds": 123
    },
    "chartData": [
      {
        "date": "2023-12-25",
        "sessions": 123,
        "conversions": 123
      }
    ],
    "utmData": [
      {
        "source": "<string>",
        "medium": "<string>",
        "campaign": "<string>",
        "term": "<string>",
        "content": "<string>",
        "sessions": 123,
        "conversions": 123
      }
    ],
    "googleAdsData": [
      {
        "gclid": "<string>",
        "wbraid": "<string>",
        "gbraid": "<string>",
        "sessions": 123,
        "conversions": 123
      }
    ],
    "serviceAreaData": [
      {
        "serviceArea": "<string>",
        "count": 123
      }
    ],
    "issueTypeData": [
      {
        "issueType": "<string>",
        "count": 123
      }
    ],
    "customerEvents": [
      {
        "sessionId": "<string>",
        "status": "<string>",
        "customerInfo": {
          "name": "<string>",
          "email": "<string>",
          "phone": "<string>",
          "address": "<string>"
        },
        "issueType": "<string>",
        "jobType": "<string>",
        "selectedDate": "<string>",
        "selectedTime": "<string>",
        "utmSource": "<string>",
        "gclid": "<string>",
        "conversionValue": 123,
        "lastActivity": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "pagination": {
    "limit": 123,
    "offset": 123,
    "has_more": true
  },
  "metadata": {
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "timezone": "<string>",
    "schedulerId": 123,
    "metricsRequested": [
      "<string>"
    ]
  }
}

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

start_date

string<date-time>

Start of date range (ISO 8601; default 7 days ago)

end_date

string<date-time>

End of date range (ISO 8601; default now)

timezone

string

default:America/New_York

IANA timezone for date calculations (default America/New_York)

scheduler_id

integer

Filter to a specific scheduler

metrics

string

Comma-separated metric blocks to include (default: all)

limit

integer

default:100

Results per page (default 100, max 1000)

Required range: x <= 1000

offset

integer

default:0

Pagination offset (default 0)

Response

Requested analytics blocks

data

object

Metric blocks are present only when requested via the metrics parameter (default: all).

Show child attributes

pagination

object

Show child attributes

metadata

object

Show child attributes

Get scheduler analytics summarySummary Simple Scheduler stats for today, this week, and this month. Requires the `read:scheduler_analytics` permission.

⌘I

Get scheduler analytics

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

{
  "data": {
    "funnel": {
      "sessions": 123,
      "bookingStarted": 123,
      "customerInfoCompleted": 123,
      "bookingCompleted": 123,
      "conversionRate": 123
    },
    "bookings": {
      "total": 123,
      "avgBookingTimeSeconds": 123
    },
    "chartData": [
      {
        "date": "2023-12-25",
        "sessions": 123,
        "conversions": 123
      }
    ],
    "utmData": [
      {
        "source": "<string>",
        "medium": "<string>",
        "campaign": "<string>",
        "term": "<string>",
        "content": "<string>",
        "sessions": 123,
        "conversions": 123
      }
    ],
    "googleAdsData": [
      {
        "gclid": "<string>",
        "wbraid": "<string>",
        "gbraid": "<string>",
        "sessions": 123,
        "conversions": 123
      }
    ],
    "serviceAreaData": [
      {
        "serviceArea": "<string>",
        "count": 123
      }
    ],
    "issueTypeData": [
      {
        "issueType": "<string>",
        "count": 123
      }
    ],
    "customerEvents": [
      {
        "sessionId": "<string>",
        "status": "<string>",
        "customerInfo": {
          "name": "<string>",
          "email": "<string>",
          "phone": "<string>",
          "address": "<string>"
        },
        "issueType": "<string>",
        "jobType": "<string>",
        "selectedDate": "<string>",
        "selectedTime": "<string>",
        "utmSource": "<string>",
        "gclid": "<string>",
        "conversionValue": 123,
        "lastActivity": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "pagination": {
    "limit": 123,
    "offset": 123,
    "has_more": true
  },
  "metadata": {
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "timezone": "<string>",
    "schedulerId": 123,
    "metricsRequested": [
      "<string>"
    ]
  }
}