BI Helper API Documentation
BI Helper APIs

Filter Management

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

Report filter and automated filter configuration

Get filter values

GET
https://bihelper-main-a2097e9.zuplo.app
/api/filter-values

Get saved filter values

Get filter values › query Parameters

  • userJobIdinteger · int64 · required

    User Job ID

Get filter values › 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 filter values › Responses

  • 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

Save filter values

POST
https://bihelper-main-a2097e9.zuplo.app
/api/filter-values

Save filter data for report generation

Save filter values › query Parameters

  • userJobIdinteger · int64 · required

    User Job ID

  • userReportGenerationTasksIdinteger · int64 · required

    Report Generation Task ID

Save filter values › 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 filter values › Request Body

  • 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

Save filter values › Responses

Filter values saved successfully

No data returned
User report configurationEmail Configuration