BI Helper APIs

User Jobs

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

Job creation, management, and execution

Get All User Jobs

GET

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

/api/user-jobs

Get All User Jobs › 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.

Update existing user job - DEPRECATED

PUT

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

/api/user-jobs

DEPRECATED -- Please use Filter Management and Email Configuration APIs to manage the filter and email values.

Update existing user job - DEPRECATED › 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.

Update existing user job - DEPRECATED › Request Body

namestring · required
Job name
isActiveboolean · required
Whether job is active
timeZonestring · required
Job timezone
jobCronExpressionstring · required
Cron expression for job scheduling

idinteger · int64
lastRunstring · date-time
Last execution time
nextRunstring · date-time
Next scheduled execution time
statusstring · enum
Status of user job execution
Enum values:
FAILED
RUNNING
SUCCESS
PROVISIONING
READY
jobDurationinteger · int64
Job duration in milliseconds
jobRunFrequencystring · enum
Frequency of job execution
Enum values:
HOURLY
DAILY
WEEKLY
MONTHLY
userJobStartTimestring · date-time
Job start time
userIdinteger · int64
userReportGenerationTasksobject[]
userEmailTasksobject[]
jobStatusDetailsstring
Detailed job status information
jobErrorDetailsstring
Error details if job failed

Update existing user job - DEPRECATED › Responses

Job updated successfully

namestring · required
Job name
isActiveboolean · required
Whether job is active
timeZonestring · required
Job timezone
jobCronExpressionstring · required
Cron expression for job scheduling

idinteger · int64
lastRunstring · date-time
Last execution time
nextRunstring · date-time
Next scheduled execution time
statusstring · enum
Status of user job execution
Enum values:
FAILED
RUNNING
SUCCESS
PROVISIONING
READY
jobDurationinteger · int64
Job duration in milliseconds
jobRunFrequencystring · enum
Frequency of job execution
Enum values:
HOURLY
DAILY
WEEKLY
MONTHLY
userJobStartTimestring · date-time
Job start time
userIdinteger · int64
userReportGenerationTasksobject[]
userEmailTasksobject[]
jobStatusDetailsstring
Detailed job status information
jobErrorDetailsstring
Error details if job failed

Get user job by ID

GET

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

/api/user-jobs/{id}

Retrieve a specific user job by its ID

Get user job by ID › path Parameters

idinteger · int64 · required
Job ID

Get user job by ID › 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 job by ID › Responses

User job details

namestring · required
Job name
isActiveboolean · required
Whether job is active
timeZonestring · required
Job timezone
jobCronExpressionstring · required
Cron expression for job scheduling

idinteger · int64
lastRunstring · date-time
Last execution time
nextRunstring · date-time
Next scheduled execution time
statusstring · enum
Status of user job execution
Enum values:
FAILED
RUNNING
SUCCESS
PROVISIONING
READY
jobDurationinteger · int64
Job duration in milliseconds
jobRunFrequencystring · enum
Frequency of job execution
Enum values:
HOURLY
DAILY
WEEKLY
MONTHLY
userJobStartTimestring · date-time
Job start time
userIdinteger · int64
userReportGenerationTasksobject[]
userEmailTasksobject[]
jobStatusDetailsstring
Detailed job status information
jobErrorDetailsstring
Error details if job failed

Delete user job

DELETE

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

/api/user-jobs/{id}

Delete a user job and all associated configurations

Delete user job › path Parameters

idinteger · int64 · required
Job ID

Delete user job › 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.

Delete user job › Responses

Job deleted successfully

No data returned

Run a job

GET

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

/api/user-jobs/run/{jobId}

Trigger immediate execution of a user job. Each execution has its own metadata. You can trigger multiple executions in parallel and each execution runs independently.

Run a job › path Parameters

jobIdinteger · int64 · required
Job ID to execute

Run a job › 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.

Run a job › Responses

Job execution started

idinteger · int64
jobIdinteger · int64
statusstring · enum
Status of user job execution
Enum values:
FAILED
RUNNING
SUCCESS
PROVISIONING
READY
startTimestring · date-time
endTimestring · date-time
durationinteger · int64
Execution duration in milliseconds
errorMessagestring
Error message if execution failed

Stop running job

GET

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

/api/user-jobs/stop/{jobId}

Stop all running executions of a given job

Stop running job › path Parameters

jobIdinteger · int64 · required
Job ID to stop

Stop running job › 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.

Stop running job › Responses

Job stopped successfully

No data returned

Pause job execution

GET

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

/api/user-jobs/pause/{jobId}

Pause a job from running on schedule

Pause job execution › path Parameters

jobIdinteger · int64 · required
Job ID to pause

Pause job execution › 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.

Pause job execution › Responses

Job paused successfully

No data returned

Activate paused job

GET

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

/api/user-jobs/activate/{jobId}

Reactivate a paused job to resume scheduled execution

Activate paused job › path Parameters

jobIdinteger · int64 · required
Job ID to activate

Activate paused job › 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.

Activate paused job › Responses

Job activated successfully

No data returned

Sync tokens

GET

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

/api/user-jobs/sync-token/{jobId}

Sync tokens across all your jobs.

Sync tokens › path Parameters

jobIdinteger · int64 · required
Job ID - The token for this job will be copied to all other jobs

Sync tokens › 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.

Sync tokens › Responses

Tokens sync successfull

newJobIdinteger · int64
ID of the job

Clone existing job

GET

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

/api/user-jobs/clone/{jobId}

Create a copy of an existing job with new ID

Clone existing job › path Parameters

jobIdinteger · int64 · required
Job ID to clone

Clone existing job › 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.

Clone existing job › Responses

Job cloned successfully

newJobIdinteger · int64
ID of the cloned job

Get job execution history

GET

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

/api/user-jobs/user-job-executions/{jobId}

Retrieve execution history for a specific job (last 15 executions)

Get job execution history › path Parameters

jobIdinteger · int64 · required
Job ID

Get job execution history › 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 job execution history › Responses

Job execution summary

jobIdinteger · int64
jobNamestring
executionsobject[]
totalExecutionsinteger
Total number of executions
successfulExecutionsinteger
Number of successful executions
failedExecutionsinteger
Number of failed executions

Get email notifications

GET

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

/api/notifications

Retrieve list of email addresses for notifications

Get email notifications › 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 email notifications › Responses

string · email

Add email notifications

POST

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

/api/notifications

Add email addresses to notification list

Add email notifications › 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.

Add email notifications › Request Body

string · email

Add email notifications › Responses

string · email

Send email for job execution

GET

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

/api/email/jobExecution/{id}

Trigger email sending for a specific job execution

Send email for job execution › path Parameters

idinteger · int64 · required
Job Execution ID

Send email for job execution › 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.

Send email for job execution › Responses

Email sent successfully

No data returned

User report configuration