Dashboard APIs

Owned by Al Lusher (Unlicensed)
Last updated: Aug 16, 2023 by Jessica Tomkins
1 min read



The Profound API uses swagger-stats to monitor your APIs and provide the data to the Dashboard.

If needed you can call the swagger-stats API directly to include monitoring data in other processes or custom dashboards.

There are 2 API endpoints available:

https://[HOST]:[PORT]/wsapi/api-stats/stats 

provides the statistics for the API processes.

A fields parameter can be added to specify 1 or more fields that you wish returned.

More information about the supported values for the fields parameter are available from the swagger-stats documentation:  https://swaggerstats.io/guide/api.html#fields-parameter



In addition there is a metrics endpoint

https://[HOST]:[PORT]/wsapi/api-stats/metrics 

Details about which metrics are provided can be found here: https://swaggerstats.io/guide/prometheus.html#metrics