How to Retrieve the all available Dashboards in Bold BI by using the REST API?
When using the REST API to fetch dashboards, it’s important to note that the default behavior is to return only the first 25 dashboard records. To access more records, you need to utilize pagination parameters.
Using Pagination Parameters
To retrieve additional dashboards beyond the default set, you should include the page and page_size query parameters in your REST API request. To know more about pagination parameters, please refer to the help documentation. Here’s how you can use these parameters:
page: This parameter indicates the page number of the results you wish to retrieve.page_size: This parameter allows you to specify the number of records to return per page.
The response from the REST API will include a TotalResults property, which indicates the total number of available records. Additionally, the Links property in the response will provide URLs for the next and previous pages, which include the necessary pagination query parameters.
Sample Request with Pagination
https://{yourdomain}/bi/api/site/{site_identifier}/v4.0/dashboards?page=2&page_size=25
Replace {yourdomain} with your actual domain and {site_identifier} with the identifier for your site.
Additional Resources
For more detailed information on how to use the API to fetch dashboards with pagination, please refer to the following documentation:
By following the guidelines above, you can effectively manage the retrieval of dashboard records and ensure that you can access all the data you need through the API.
