The Akixi report API allows you to automatically download Akixi report data directly into third-party applications. This is available with Akixi Lite, 1000, 2000 and 3000.
The Akixi API development code can be accessed by visiting akixi.dev.
API restriction limit per report
There is a rate restriction limit of 10 minutes per report. This means an API download request on a single report can only occur after a 10-minute interval. Looking at the API example diagram below, the data is pulled from Report 1 at 12:00 PM. The next available download request is available at 12:10 PM – 10 minutes after the original download has been completed.
API overall restriction limit
An API download request can be completed on three different reports within the same 10-minute window. As shown in API example diagram, an API download request is completed on Reports 1, 2 and 3 between 12:00–12:10 PM.
Once a download request has been completed for the second time on Report 1 at 12:15 PM, a download request can then be requested and successfully downloaded on Report 4 at 12:10:01. This is because the 10-minute window is adjusted following the latest API download on Report 1. The new 10-minute window runs across Reports 2, 3 and 4 at 12:15, 12:20 and 12:25:01.
To allow application users to perform API downloads, the feature must be enabled against the user. This consists of a ‘Report Data API’ checkbox that can be toggled on and off against the application user account settings.
The exportable Akixi billing CDR and summary reports can be used to track and monitor API download usage. These reports can be accessed from the Status & Tools section of the portal with an Akixi administrator account.
The report API is available with Akixi Lite, 1000, 2000 and 3000. For an easy to digest overview of all the Akixi solutions that are available, access the Akixi Solution Guide by clicking here.