The Analytics API, available for Analytics+ customers, lets you pull call and user metrics directly into your own reporting tools, without manually exporting data from the Aircall dashboard. You can automate recurring extracts on a daily, weekly, or monthly cadence and use the data to build custom reports tailored to your business.

This article covers what the Analytics API offers, how it works, and what to keep in mind when setting up automated exports.

Important: The Analytics API is available exclusively to customers on the A+ add-on. If you are unsure whether your plan includes A+, contact the customer success team.

What you can export

The API gives you access to three categories of data:

  • Call History: Detailed records of inbound and outbound calls.
  • User Status History+: A log of agent availability status over time.
  • User Activity+: A set of per-user performance metrics, including call volumes, in-call time, after-call work time, ringing attempts, and time spent in each status.

Each category maps to the reports available in your Aircall dashboard. For the full list of exportable reports and their corresponding API parameter values, see the Analytics API documentation.

Filters and parameters

Every API request requires the following parameters:

  • Report type: The specific report you want to export. See the full list in the Analytics API documentation.
  • Date range: The time period the export should cover.
  • Timezone: The timezone applied to the data. Defaults to UTC if not specified.

You can also pass optional filters to narrow the results, matching the filters available for each report in the Aircall dashboard. The available optional filters vary by report type. Refer to the Analytics API documentation for the full list per report.

Important: Requests missing a mandatory parameter will fail. Test each report type with all required parameters before scheduling automated exports.

How the API works

The API follows a straightforward request-and-download flow:

Steps:

  1. Authenticate your request using your API credentials. You can find these in your Aircall Dashboard under Integrations & API.
  2. Call the single endpoint, passing your chosen report type, a mandatory date range, and a timezone as parameters.
  3. Receive a response containing a pre-signed link to a CSV file.
  4. Download the CSV from that link. The link expires 1 hour after it is generated, so build your workflow to download immediately after each successful response.

Scheduling is not built into the API. If you want daily, weekly, or monthly exports, you need to set up that automation on your side using your own infrastructure or a third-party scheduling tool.

For authentication, endpoint details, and the full parameter reference, see the Analytics API documentation.

Data retention

The data available via the API follows the same retention limits as the Aircall Dashboard:

Data categoryRetention period
Call History6 months
User Status History+7 days
User Activity+Unlimited

Best practices

The following recommendations apply whether you are running one-off exports or building a fully automated pipeline.

Schedule exports during off-peak hours 

Where possible, trigger automated exports outside of business hours. This reduces the risk of delays during periods of high API load and helps ensure consistent data availability.

Download immediately after each request

The download link expires after 1 hour. Build your automation to download the file as soon as the API response is received, rather than storing the link for later retrieval.

Check your destination system's row limits

The API does not impose a row limit on exports. However, some import tools and spreadsheet applications cap the number of rows they can process. Verify your destination system's limits before running large exports in production.

Test before you automate

Run each report type manually before scheduling recurring exports. This helps you catch missing or incorrect parameters early, before they cause silent failures in an automated workflow.

FAQs

Does the API include a built-in scheduler?

No. The API returns data on request. You are responsible for setting up any recurring automation (daily, weekly, monthly) on your side.

Why does the download link expire after 1 hour?

The short expiry is a security measure to protect your data. Make sure your workflow downloads the file immediately after a successful API response.

Can I use the Analytics API without the A+ add-on?

No. A+ is required. Reach out to our customer success team to discuss your options. You can also request a trial to explore the add-on.

The data I need isn't showing up in my export. What should I check?

First, confirm that the relevant add-on (User Status History+ or User Activity+) is active on your account. Then verify your date range, timezone, and any optional filters against the Analytics API documentation.