BI Helper APIs

Welcome to the BI Helper developer portal. BI Helper provides the REST APIs for users to build on or to customize their workflows.

Developer contact - support@bihelper.tech

Prerequisites

BI Helper APIs - License requirements

The APIs are available under BI Helper's PREMIUM and ENTERPRISE license.

API Authentication

BI Helper uses API Keys for API authentication. API keys can be generated from your BI Helper account. Please navigate to the API Keys menu to manage your API Keys. The API Key should be passed in the authorization header with the value Bearer <YOUR_API_KEY>.

Code(python)
 

import requests

url = "https://bihelper-main-2003662.d2.zuplo.dev/user-jobs/:id"
headers = {"Authorization": "Bearer <YOUR_API_KEY>"}
response = requests.get(url, headers=headers)
print(response.text) 

Create Job

Create and setup your first job using BI Helper UI. Once the first job setup is complete, you can start using the APIs. Please Sign In into your Microsoft Account or add Tableau Personal Access Token and Secret while setting up the job.

Post the first job setup you can use Clone Job, Sync Token APIs to create and manage the rest of your jobs.

Rate Limits

BI Helper enforces rate limits for managing API usage and to ensure the security and security of the API services. APIs return 429 error code on hitting rate limits.

Pagination

A few endpoints are paginated and the documentation lists the pagination details wherever applicable.

API Reference

View the full interactive API reference →