Agent activity
Checking for WebMCP support
Requests are only sent after you confirm them. How this works
Ayonix · Interface
REST API: retrieving analytics data into your systems
In short
A REST interface suits retrieving aggregated series and historical event records into BI, reporting and operational tools. This page describes the integration principles that apply; the concrete endpoints, schemas and authentication details are supplied by Ayonix under evaluation access rather than published here.
Where webhooks suit live delivery, a REST interface suits retrieval — pulling counting series into a BI tool, reconciling event records, or backfilling after an outage. The design principles are standard, and they are what this page covers. Ayonix does not publish a public API specification, so no endpoint paths, parameter names or response shapes are stated on this site. Inventing them would produce documentation that cannot be built against.
Compatibility
What is supported, stated explicitly
Every mechanism carries an explicit state. No ambiguous checkmarks are used, and no certification or marketplace status is claimed without evidence.
| Mechanism | State | Notes |
|---|---|---|
| Retrieval of aggregated counting and occupancy series | Available through integration project | Series retrieval for BI and reporting, scoped during integration. |
| Retrieval of historical event records | Available through integration project | Event retrieval for reconciliation and reporting. |
| Token-based authentication | Available through integration project | Credentials are issued per integration and stored server-side, never in a browser. |
| Pagination for large result sets | Available through integration project | Cursor or offset pagination, confirmed with the interface documentation. |
| Explicit interface versioning | Available through integration project | Versioning so a client is not broken by an unrelated change. |
| Public, self-service API documentation | Not supported | Ayonix does not publish a public API specification. Access is provided under evaluation agreement. |
What each state means
- Available through integration project
- The integration is delivered as a scoped engineering project against the vendor SDK. Plugin availability, supported versions and licensing are confirmed with Ayonix before design.
- Not supported
- Not available, and not on the current roadmap.
Operators
What this changes for the operator
- Analytics series appear in the BI tools the business already uses.
- Historical records can be reconciled after an outage rather than lost.
- Reporting does not depend on anyone exporting a file by hand.
Constraints
Limitations and the integration checklist
Limitations
- No public specification is published, so integration begins with an access request.
- Retrieval is unsuitable for latency-sensitive alerting; use webhook or VMS delivery for that.
- Large historical queries should be paginated and rate-limited rather than requested in one call.
- Available data depends on what the deployment is configured to retain.
Questions to settle before design
- Has evaluation access and interface documentation been requested from Ayonix?
- Where will API credentials be stored, and how are they rotated?
- Does the client handle pagination and partial results correctly?
- Is retry bounded, with no retry on client errors?
- Is the use case retrieval, or does it actually need live delivery?
- What retention is configured, and does it cover the reporting window needed?
Frequently asked questions
Where is the API reference?
It is not published publicly. Ayonix provides interface documentation under evaluation access. This site deliberately publishes no endpoint paths or response shapes, because documenting an interface that has not been verified would be worse than documenting none.
Should we poll the API for alerts?
No. Polling adds latency and load for a job that push delivery does better. Use webhook or VMS delivery for alerting, and use retrieval for reporting, reconciliation and backfill.
Can we call the API from a browser?
No. API credentials belong server-side. A browser client would expose them to anyone who opens developer tools, which is among the most common causes of credential leakage in integrations of this kind.
Other integrations
- Author
- Gabriel Bamola, Chief Marketing Officer, Ayonix
- Technical review
- Dr Sadi Vural, Founder and Chief Executive Officer, Ayonix
- Published
- Last reviewed
Scope a REST API integration
Integration scoping starts with confirming your product version, the mechanisms it exposes, and what your operators actually need to see. Send those details and an engineer will tell you what is achievable in your environment.