Edge Analytics API¶

The brand new API is designed to expose Edge Intelligence metrics leveraging on the new capabilities of Edge Analytics.

Features¶

Ability to fetch metrics in custom intervals of time.
Versioned API endpoints.
Endpoint for custom queries to allow for tailored SQL queries.

Swagger¶

The Swagger UI is available at https://api.system73.com/analytics/doc where you can get the API reference (OpenAPI spec) or interact with the API endpoints.

Legacy endpoints¶

The new API is bundled with a subset of the Legacy Stats API endpoints. These endpoints keep the same interface in order to facilitate the transition of the Legacy Stats API current users. The legacy endpoints are grouped under the base path legacy/stats/.

Important

The Edge Analytics API subset of legacy endpoints will also be subject to a deprecation schedule. We will communicate the deprecation schedule making sure we provide you with enough time to perform the migration to the new endpoints.

Migration¶

Current users of the Legacy Stats API can easily migrate to the Edge Analytics API subset of legacy endpoints with minimal effort:

Replace the legacy API base path https://<region>.s73cloud.com/public/api/v3/ with https://api.system73.com/analytics/legacy/.
Fetch the new credentials (API key) of the Edge Analytics API as described here.
Add the Bearer word into the Authorization header along with the new credential:

Replace:
```
Authorization: <old_api_key>
```
with:
```
Authorization: Bearer <new_api_key>
```

This section was last updated 2024-11-18