BI Helper API Documentation
BI Helper APIs

Schemas

UserJobsDTO

  • 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

UserPBIReportGenerationTasksDTO

  • 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[]

UserEmailTasksDTO

  • idinteger · int64
  • fromEmailstring · email

    Sender email address

  • isActiveboolean

    Whether email task is active

  • emailBodystring

    Email body content

  • emailTitlestring

    Email subject

  • emailSignaturestring

    Email signature

  • userJobIdinteger · int64

    Associated job ID

UserPowerBIWorkspacesDTO

  • idstring

    Workspace ID

  • namestring

    Workspace name

  • isReadOnlyboolean

    Whether workspace is read-only

  • isOnDedicatedCapacityboolean

    Whether workspace is on dedicated capacity

  • capacityIdstring

    Capacity ID

UserPowerBIReportsDTO

  • idstring

    Report ID

  • namestring

    Report name

  • webUrlstring · uri

    Report web URL

  • embedUrlstring · uri

    Report embed URL

UserPowerBIDashboardsDTO

  • idstring

    Dashboard ID

  • displayNamestring

    Dashboard name

  • webUrlstring · uri

    Dashboard web URL

  • embedUrlstring · uri

    Dashboard embed URL

TableauProjectDTO

  • idstring

    Project ID

  • namestring

    Project name

  • descriptionstring

    Project description

  • contentPermissionsstring

    Content permissions setting

  • parentProjectIdstring

    Parent project ID

TableauWorkbookDTO

  • idstring

    Workbook ID

  • namestring

    Workbook name

  • descriptionstring

    Workbook description

  • contentUrlstring

    Content URL

  • showTabsboolean

    Whether tabs are shown

  • sizeinteger

    Workbook size in bytes

  • createdAtstring · date-time
  • updatedAtstring · date-time

TableauViewDTO

  • idstring

    View ID

  • namestring

    View name

  • contentUrlstring

    Content URL

  • viewUrlNamestring

    View URL name

  • workbookIdstring

    Parent workbook ID

UserTableauAuthTokenDTO

  • userJobIdinteger · int64 · required

    Associated job ID

  • tableauServerUrlstring · uri · required

    Tableau server URL

  • tableauUsernamestring · required

    Tableau username

  • tableauPasswordstring · required

    Tableau password

  • tableauSiteNamestring

    Tableau site name

UserAutomatedFiltersDTO

  • idinteger · int64
  • userJobIdinteger · int64

    Associated job ID

  • filterNamestring

    Filter name

  • filterValuestring

    Filter value

  • isActiveboolean

    Whether filter is active

UserReportGenerationFilterDataDTO

  • idinteger · int64
  • userReportGenerationTasksIdinteger · int64

    Associated report generation task ID

  • filterNamestring

    Filter name

  • filterValuestring

    Filter value

  • toEmailstring

    Semicolon separated list of contacts

  • ccEmailstring

    Semicolon separated list of contacts

  • bccEmailstring

    Semicolon separated list of contacts

UserJobPDFCount

  • userIdinteger · int64
  • userJobIdinteger · int64
  • jobNamestring
  • pdfCountinteger

    Number of PDFs generated

  • monthstring

    Month in YYYY-MM format

  • yearinteger

OrganizationTotalPDFCount

  • organizationNamestring
  • totalPdfCountinteger

    Total PDFs generated by organization

  • monthstring

    Month in YYYY-MM format

  • yearinteger

JobExecution

  • 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

JobSummary

  • jobIdinteger · int64
  • jobNamestring
  • executionsobject[]
  • totalExecutionsinteger

    Total number of executions

  • successfulExecutionsinteger

    Number of successful executions

  • failedExecutionsinteger

    Number of failed executions

UserJobStatus

string · enum
Enum values:
FAILED
RUNNING
SUCCESS
PROVISIONING
READY

Status of user job execution

UserJobRunFrequency

string · enum
Enum values:
HOURLY
DAILY
WEEKLY
MONTHLY

Frequency of job execution

BITools

string · enum
Enum values:
POWER_BI
TABLEAU_ONLINE
TABLEAU_SERVER

Supported Business Intelligence tools

ReportType

string · enum
Enum values:
DASHBOARDS
REPORTS

Type of report to generate

ReportRunPeriod

string · enum
Enum values:
DAILY
WEEKLY
MONTHLY
QUARTERLY

Period for report generation

DataIngestionMode

string · enum
Enum values:
BATCH
STREAMING

Data ingestion mode

ErrorResponse

  • errorstring

    Error code

  • messagestring

    Error message

  • detailsstring

    Detailed error information

  • timestampstring · date-time

    Error timestamp

  • pathstring

    Request path that caused the error