ZenotiHelp

Call Log Export API (Beta)

ZTZenoti Docs Team Updated July 15, 2026 4 min readGuide

Audience: Organization administrators and technical staff who need to export HyperConnect call log data into external tools, reporting systems, or data warehouses.

Availability: Requires Beta access. Contact your Zenoti Customer Success Manager to enable the Call Log Export API for your organization.

The HyperConnect Call Log Export API lets you programmatically retrieve call log data from your organization and load it into your own tools and systems. Because call log exports can involve large volumes of data, the API uses an asynchronous job model: you submit an export request, then poll for a download link when the job completes.

Each exported row includes AI-analysis fields β€” sentiment, call category, and AI voice agent call status and notes β€” giving you the full picture of each interaction alongside the core call metadata.

Before you begin

  • Your organization must have HyperConnect provisioned and the Call Log Export API enabled.

  • You need a valid Zenoti API key to authenticate requests.

  • Each export request covers a date range of up to 31 days. To export data for a longer period, submit multiple requests with non-overlapping date ranges.

  • You need the following permission:

    Permission: Connect Access Enable β€” Required to access HyperConnect features, including the Call Log Export API. Admin path: Configuration > Security > Security Roles > select a role > scroll to Zenoti HyperConnect > Connect Access Enable

Steps

Submit an export request

  1. Construct an API request using your Zenoti API key in the x-api-key header.
  2. Specify the date range for the export. The range must not exceed 31 days.
  3. Submit the request to the Call Log Export endpoint.

The API returns a job ID that you use to check the status of the export.

Note: If you need data for more than 31 days, submit separate requests for each 31-day period and combine the resulting files in your own tooling.

  1. Using the job ID returned in the previous step, send a status-check request to the export job endpoint.
  2. Include your Zenoti API key in the x-api-key header.
  3. Repeat the status check at a reasonable interval (for example, every 30 seconds) until the job status indicates completion.
  4. When the job is complete, the response includes a download link for the exported file.

Note: The time required to generate the export depends on the volume of data in the requested date range. You will receive an email notification once the data is ready for download.

Download the exported file

  1. Use the download link from the completed job response to retrieve the exported file.
  2. The file contains one row per call log entry for the requested date range.

Important: Download links expire after a limited time. Download the file promptly after the job completes.

Exported fields

Each row in the export includes the following AI-analysis fields in addition to standard call log data:

Field Description
Sentiment The overall sentiment detected in the call β€” positive, neutral, or negative.
Call category The category assigned to the call by the AI analysis (for example, booking, cancellation, general enquiry).
AI voice agent call status The outcome status recorded by the AI voice agent for the call.
AI voice agent notes Notes captured by the AI voice agent during or after the call.

Note: AI-analysis fields are populated only for calls that were analyzed. Calls that are too short or that occurred before AI analysis was enabled for your organization may have empty values in these fields.

Tips

  • Plan your date ranges before submitting. Because each request is limited to 31 days, map out your full export window in advance and submit requests in sequence to avoid gaps or overlaps.
  • Store job IDs. Save the job ID returned by each export request so you can resume polling if your polling process is interrupted.
  • Automate polling with a backoff strategy. Rather than polling at a fixed interval, consider increasing the interval between polls for large date ranges to reduce unnecessary API calls.
  • Combine files downstream. When exporting multiple 31-day periods, concatenate the resulting files in your data pipeline before loading them into your destination system.
  • Check AI-analysis field availability. If your organization recently enabled the AI voice agent, calls from before the enablement date will not have AI-analysis fields populated. Filter or handle null values accordingly in your downstream processing.

Troubleshooting

Symptom Likely cause Resolution
API returns an authentication error The x-api-key header is missing or contains an incorrect key. Verify that you are passing the correct Zenoti API key in the x-api-key header.
Export request is rejected with a date range error The requested date range exceeds 31 days. Split the request into multiple requests, each covering no more than 31 days.
Job status remains pending for an extended period The export volume is large, or there is a temporary processing delay. Continue polling. If the job does not complete after a prolonged period, contact Zenoti Support with the job ID.
Download link returns a 404 or access-denied error The download link has expired. Re-submit the export request to generate a new job and a new download link.
AI-analysis fields are empty for some rows The calls were too short for analysis, or they predate AI analysis enablement for your organization. This is expected behavior. Handle null values in your downstream processing.
Was this article helpful?
Your feedback helps us improve our documentation.