How to Check the Status of Bold BI Tenant Sites
In order to monitor the running status of Bold BI tenant sites, you can use the provided APIs for both Embedded Analytics Server and Cloud Analytics Server. This article will guide you through the process of checking the status using these APIs.
Bold BI Embedded Analytics Server
To check the status of a Bold BI Embedded Analytics Server tenant site, use the following API endpoint:
{domain_name}/bi/api/site/{site_identifier}/status
Replace {domain_name} with your server’s domain name and {site_identifier} with the unique identifier of the site you want to check. In the below example site1 is the site identifier of that site
Bold BI Cloud Analytics Server
To check the status of a Bold BI Cloud Analytics Server tenant site, use the following API endpoint:
{domain_name}/bi/api/status
Replace {domain_name} with your server’s domain name.
API Response
The API response will provide you with the current status of the tenant site. The response will be in JSON format and will include the following information:
status: The current status of the site (e.g., “Running”, “Stopped”, “Error”).message: A detailed message describing the current status.
Here’s an example of a successful API response:
{
"status": "Running",
"message": "The site is running."
}
In case of an error, the API response will include an error message:
{
"status": "Error",
"message": "An error occurred while checking the site status."
}
By using these APIs, you can easily monitor the running status of your Bold BI tenant sites and take appropriate action if needed.
Additional References
