How to Retrieve Published Resources Lists through Bold BI REST API

Published:

This article explains how to get dashboards and data sources details which are published to other sites using the Bold BI API.

Authorizations

When you sign into Bold BI, an authentication token is provided that should be attached in the request header (Authorization) for all subsequent API calls to authenticate the requests.

Refer to the following help documents to get the authorized token:

Header name	Header value
Authorizations	bearer< token >

Get Published Dashboard Details using API

Use the following API endpoint to get published resource details with the site details to which they are published:

GET /v5.0/publish/items

For more details about this API refer this link

Sample URL:

Embedded Analytics Server : {domain_name}/bi/api/site/<site_identifier>/v5.0/publish/items
Cloud Analytics Server : {domain_name}/bi/api/v5.0/publish/items

Query Parameters

Name	Type	Required	Description
itemType	String	Yes	Item type Values allowed are Dashboard, Datasource
page	Integer	No	It indicates the current page number Example: page=1
page_size	Integer	No	It denotes the number of item lists per page Example: page_size=10

Response Schema

Parameter name	Type	Description
Data	List<TargetSiteDetails>	Returns data from the API.
TotalResults	Integer	Returns items count of the API request.
Links	List<LinksDetails>	Returns pagination links.

TargetSiteDetails Object

Name	Type	Description
PublishId	Guid	Return publish Id.
ItemId	Guid	Returns Id of the dashboard or data source based on the ItemType.
ItemName	string	Returns name of the dashboard or data source based on the ItemType.
ItemType	string	Returns item type.
CategoryId	Guid	Category Id. Note: If item type is dashboard returns the category Id of the source site published dashboard.
CategoryName	string	Category name. Note: If item type is dashboard returns the category name of the source site published dashboard.
IsSiteExist	boolean	Returns if site already exists.
ExternalSiteId	integer	Returns external site Id.
PublishedItemName	String	Returns destination site dashboard or data source name.
PublishedItemDescription	String	Returns destination site dashboard or data source description.
PublishedItemCategoryName	String	Returns destination site dashboard’s category name.
PublishedItemId	Guid	Returns destination site dashboard or data source Id.
TenantId	Guid	Returns destination site Id.
TenantName	String	Returns destination site name.
TenantURL	String	Returns destination site URL.
PublishType	String	Returns publish type. Values allowed are Internal, External.
IsLocked	boolean	Returns true if the dashboard or data source is locked to edit in destination site.
PublishedById	string	Returns Id of the publisher.
PublishedOn	DateTime	Date published of the dashboard or data source in date format.
LastSynchronizedOn	DateTime	Date of the last synchronization in date format.
LastSynchronizedById	DateTime	Returns last synchronized user Id.
LastSynchronizedStatus	String	Returns success if the last synchronization is successful.

LinkDetails Object

Name	Type	Description
Link	string	Returns the page link.
Rel	string	Returns link type. Valid values: First, Next, Prev, Last.
Type	string	Returns method type. Valid value: GET.

Sample response

{
 "Data": [
   {
     "PublishId": "string",
     "CategoryId": "string",
     "ItemId": "string",
     "ItemName": "string",
     "CategoryName": "string",
     "ItemType": "string",
     "IsSiteExist": true,
     "ExternalSiteId": 0,
     "PublishedItemName": "string",
     "PublishedItemDescription": "string",
     "PublishedItemCategoryName": "string",
     "PublishedItemId": "string",
     "TenantId": "string",
     "TenantName": "string",
     "TenantURL": "string",
     "PublishType": "string",
     "IsLocked": true,
     "PublishedById": "string",
     "PublishedOn": "2019-08-24T14:15:22Z",
     "LastSynchronizedOn": "2019-08-24T14:15:22Z",
     "LastSynchronizedById": "2019-08-24T14:15:22Z",
     "LastSynchronizedStatus": null
   }
 ],
 "TotalResults": 0,
 "Links": [
   {
     "Link": "string",
     "Rel": "string",
     "Type": "string"
   }
 ]
}

Note

The resource published site details will only be shown to the user who published it and to the admin users of the tenant site.
Refer to the following help document link to know more about site details like TenantId, TenantName, and TenantURL: Manage Sites - General

Additional References

Was this article useful?

Dislike

Written by Reethika Moovendhan

Updated:

Comments (0)