How to retrieve the list of categories in the dashboard listing page via REST API ?

This article provides guidance on how to retrieve lists of categories for users who have created them. The process involves making a request to the appropriate endpoint with the necessary authorizations.

Authorization

To execute this action, please ensure that a access token is included in your request header. For details on obtaining the access token, please refer to the relevant documentation here.

Authorization: bearer <token>

To retrieve the list of categories, you will need to send a GET request to the appropriate endpoint based on your server type as shown below:

Self-Hosted Server

For self-hosted instances, use the following endpoint:

https://{yourdomain}/bi/api/site/<site_identifier>/v4.0/categories

Bold BI Cloud Server

For Bold BI Cloud instances, the endpoint is:

https://{yourdomain}/bi/api/v4.0/categories

Request Type

• GET: This request type is used to retrieve the list of categories in the dashboard listing page.

Example Request

Here is an example of how to structure your GET request:

Responses

When making a request to retrieve category lists, you may receive the following responses:

• 200: The list of categories was retrieved successfully.

You can also get category ID from the response as shown below:

• 204: Items not found.
• 400: The specified page does not exist.
• 401: Access denied due to invalid authorization.
• 403: Access denied for the requested item.
• 405: Request type was not GET.

Additional References

To know more about Bold BI APIs