BI Helper APIs

User report configuration

Endpoint:https://bihelper-main-a2097e9.zuplo.app

Manage user report configuration

Get user report configuration

GET

https://bihelper-main-a2097e9.zuplo.app

/api/report-job-conf

Get user report configuration

Get user report configuration › query Parameters

userJobIdinteger · int64 · required
User Job ID

Get user report configuration › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get user report configuration › Responses

User Report Conf

idinteger · int64
namestring
Task name
isActiveboolean
Whether task is active
lastRunstring · date-time
nextRunstring · date-time
timeZonestring
statusstring · enum
Status of user job execution
Enum values:
FAILED
RUNNING
SUCCESS
PROVISIONING
READY
jobDurationinteger · int64
userWorkspacestring
PowerBI/Tableau workspace name
userWorkspaceIdstring
PowerBI/Tableau workspace ID
userReportNamestring
Report name
reportTypestring · enum
Type of report to generate
Enum values:
DASHBOARDS
REPORTS
generateSamplesboolean
Whether to generate sample data
userJobIdinteger · int64
pbiUserNamestring
PowerBI username
pbiPasswordstring
PowerBI password (encrypted)
reportRunPeriodstring · enum
Period for report generation
Enum values:
DAILY
WEEKLY
MONTHLY
QUARTERLY
scriptNamestring
Script name for report generation
filePrefixstring
Prefix for generated files
reportUrlstring · uri
Report URL
dataIngestionModestring · enum
Data ingestion mode
Enum values:
BATCH
STREAMING
numberOfLoopsinteger
Number of processing loops
timeoutinteger
Timeout in milliseconds
transparentBackgroundboolean
Whether to use transparent background
pagesToPrintstring
Pages to print specification
pageSizestring
Page size specification
generateExcelboolean
Whether to generate Excel output
listOfExcelVisualsstring
List of Excel visuals to generate
shouldPDFBeGeneratedboolean
Whether to generate PDF output
reportDateFieldstring
Date field for report filtering
biToolstring · enum
Supported Business Intelligence tools
Enum values:
POWER_BI
TABLEAU_ONLINE
TABLEAU_SERVER
localestring
Report locale
userReportGenerationFilterDataobject[]

Save user report configuration

POST

https://bihelper-main-a2097e9.zuplo.app

/api/report-job-conf

Save user report configuration

Save user report configuration › query Parameters

userJobIdinteger · int64 · required
User Job ID

Save user report configuration › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Save user report configuration › Request Body

idinteger · int64
namestring
Task name
isActiveboolean
Whether task is active
lastRunstring · date-time
nextRunstring · date-time
timeZonestring
statusstring · enum
Status of user job execution
Enum values:
FAILED
RUNNING
SUCCESS
PROVISIONING
READY
jobDurationinteger · int64
userWorkspacestring
PowerBI/Tableau workspace name
userWorkspaceIdstring
PowerBI/Tableau workspace ID
userReportNamestring
Report name
reportTypestring · enum
Type of report to generate
Enum values:
DASHBOARDS
REPORTS
generateSamplesboolean
Whether to generate sample data
userJobIdinteger · int64
pbiUserNamestring
PowerBI username
pbiPasswordstring
PowerBI password (encrypted)
reportRunPeriodstring · enum
Period for report generation
Enum values:
DAILY
WEEKLY
MONTHLY
QUARTERLY
scriptNamestring
Script name for report generation
filePrefixstring
Prefix for generated files
reportUrlstring · uri
Report URL
dataIngestionModestring · enum
Data ingestion mode
Enum values:
BATCH
STREAMING
numberOfLoopsinteger
Number of processing loops
timeoutinteger
Timeout in milliseconds
transparentBackgroundboolean
Whether to use transparent background
pagesToPrintstring
Pages to print specification
pageSizestring
Page size specification
generateExcelboolean
Whether to generate Excel output
listOfExcelVisualsstring
List of Excel visuals to generate
shouldPDFBeGeneratedboolean
Whether to generate PDF output
reportDateFieldstring
Date field for report filtering
biToolstring · enum
Supported Business Intelligence tools
Enum values:
POWER_BI
TABLEAU_ONLINE
TABLEAU_SERVER
localestring
Report locale
userReportGenerationFilterDataobject[]

Save user report configuration › Responses

User Jobs Filter Management