BI Helper APIs enable programmatic control of report distribution from Power BI and Tableau, transforming manual processes into scalable automation. Available to BI Helper Premium and Enterprise subscribers, these REST APIs deliver enterprise‑grade features and security.
See BI Helper APIs for the complete API documentation.
Getting Started
The first step is to set up a BI Helper job through the user interface, after which you can start using the APIs to manage jobs.
The next step is user authentication, which is handled via API Keys. These can be generated by users from Settings > API Keys in their BI Helper account and passed in the authorization header with the value Bearer<YOUR_API_KEY>.
After authentication, users can make API calls support job creation, editing, execution, scheduling and monitoring through secure endpoints.
Core Capabilities
The User Jobs API is the foundation API, providing multiple endpoints to manage the lifecycle of a BI Helper job by performing:
- Job Management: List, retrieve, delete or clone jobs.
- Execution Control: Trigger instant runs, stop or pause active jobs or reactivate inactive jobs.
- Scheduling: Use cron expressions for hourly, daily, weekly or monthly frequencies.
- Monitoring: Review execution history with success/ failure counts, status and error details for the last 15 job runs.
- Notifications: Set email alerts with customizable recipients and triggers.
Other specialized API endpoints include:
GET/POST /api/user-report-configuration to manage active status, time zone, pages to print, canvas size, output format and other parameters for a given user job ID.
GET/POST /api/filter-management for dynamic filter input with names, values, recipients (To/ cc/ bcc as semicolon lists) linked to report tasks.
GET/POST /api/email-configuration to manage from email ID, body, title and signature for a given user job ID.
Key Use Cases
BI Helper APIs excel in enterprise scenarios with medium to large volumes of PDF/ PPTX reports where scalability and reliability of the automation are very important.
Without logging into the BI Helper application, users can obtain its full functionality using the APIs. They can:
- Automate event-driven report bursts integrated with business systems or schedulers.
- Edit recipient lists, filters or parameters programmatically instead of UI navigation.
- Monitor campaigns for compliance, accessing detailed logs without manual checks.
- Distribute thousands of personalized reports daily across Power BI/ Tableau environments.
Users benefit from token syncing across jobs, deprecated endpoint warnings for smooth migrations and error fields for rapid troubleshooting.
Write to support@bihelper.tech with your use case to understand how BI Helper APIs can support it.
Developer Features and Best Practices
All requests demand proper headers; missing them triggers access denials.
Example workflow: Set up a job from the BI Helper UI, authenticate the API token, then use the API endpoints to run/ update/ monitor the job.
Forward compatibility includes newer filter/ email APIs complementing core edit/ run operations, enabling pre-execution tweaks like slicer overrides.
Why BI Helper APIs
BI Helper REST APIs are designed and built to address a number of requirements and issues that routinely crop up when analyzing data and building Power BI reports.
The APIs reduce manual overhead, accelerate insights delivery and ensure secure and timely stakeholder communication at all times. Enterprises gain a robust backbone for reporting, focusing their efforts on analysis over data input modes and support.
