Search results

Interact with our REST API

This section explains you how to play with our interactive API documentation.

You need to get the access token to authenticate with the API endpoints to get the responses.

Get Access Token

Each user has their own unique token to authenticate the requests which should be added in header of the request.

To get the User Token follow the below steps:

  1. Navigate to the respective interactive Rest API documentation link.

  2. Expand the Authentication and click Try it out. Authentication

  3. We already have hosted the Bold BI Server for public demo with this domain. Using the public demo, you have to get the access token with the below sample credential.

    Username - guest@boldbi.com

    grant_type - password

    password - Demo759!

Demo credential

  1. Click Execute and you will get the response as like below. Get the access_token from the Response body. Response
  2. Now you have to add the access_token for further API calls as Authorization header.
  3. Click the Authorize button which is placed in top right corner of the page. Authorize button
  4. A dialog will open and enter the access token in the Value box with this format, ‘Bearer’ + access_token and click Authorize button. Authorize dialog
  5. Now, you can interact with the other REST APIs with the needed respective parameters which mentioned in each API.

NOTE: In this interactive document, API Responses and its Code descriptions are also mentioned.