Overview

You can access and export your Cumulative Benefits data by using the BulkIData Cumulative Benefits API endpoint. To have the ability to export this data, ensure your Role has the permission to Export Cumulative Benefits to be able to use the API. You can navigate to Administration > Roles > select your role > under Permissions, select Export Cumulative Benefits

BulkData Cumulative Benefit Endpoint

You can obtain your BulkIdeas API Endpoint by using Swagger (for more information on how to access Swagger, kindly see the following article: How to find the available API Endpoints). Once you have entered the URL, select the BulkData Cumulative Benefits endpoint to view the available parameters.


The following is required for the BulkData Cumulative Benefits API Endpoint (see below as example): 

  1. Your site URL
  2. The version definition
  3. The data to include on the API Endpoint  
  4. Your API key (for more information on how to obtain your API key, kindly see the following article: How to access you API Key) 


Note: the BulkData Cumulative Benefits API can be accessed on V2, V3 and V4 version definition


BulkData Cumulative Benefits Parameters

These are the currently available parameters on the BulkData Cumulative Benefits API:

  • SiteIds
  • BusinessUnitIds
  • DepartmentIds
  • TeamIds
  • KpiTypeIds
  • IdeaIds
Note: these primary IDs are system generated. You can define specific primary IDs on V4 by selecting 'Add string item' on Swagger


  • FromDate - returns data from the date specified onwards

  • Periods - returns data from the period specified. The number of items returned 
Note: if the number of period is not specified, the API will by default, return data for 12 periods


  • IsAnnualizedBenefit - returns data based on selection (true/false)
  • Tags - return data with the specified tag 
  • CustomFields - returns data based on the specified custom field
  • IdeaTypeId - returns data based on the specified IdeaTypeId 
  • NonFinancialCategoryId - returns data based on the Non-Financial Category Id specified
  • IncludeCompleteIdeas - returns data based on selection (true/false)