Skip to main content

Extract All Portfolio Data

Objective​

To extract/pull (on a semi-regular basis) all data from your Incentify credits and incentives portfolio to ingest it into your own database to support your internal applications, such as an analytics/BI dashboard.

The basic idea is to configure your script/system to loop over each data resource and then each paginated set of data within each resource until you have ingested all of the data.

Key Portfolio Resources:

  • Projects
  • Credits
  • Utilizations

Steps to Implement​

Phase 1 - Development and Testing on Incentify Sandbox Environment​

1) Make sure you are setup with everything you need to make API calls to the Sandbox environment.

2) Ensure that your API Key is working by making a successful API call.

3) Build or configure a scheduled script on your internal platform that loops over the following Incentify resources in this order/fashion:

  • Projects Resource - List (link)
    • Get list of Projects
    • Check for pagination in the API response and loop
      • links > next - this returns the endpoint for the next page - or empty if no further pages
    • Insert desired Project data into your internal database
  • Credits Resource - List (link)
    • Get list of Credits
    • Check for pagination in the API response and loop
      • links > next - this returns the endpoint for the next page - or empty if no further pages
    • Insert desired Credit data into your internal database
    • Credits are connected to Projects by the "Project ID"
  • Utilizations Resource - List (link)
    • Get list of Utilizations (loop for all pages, if more than one)
    • Check for pagination in the API response and loop
      • links > next - this returns the endpoint for the next page - or empty if no further pages
    • Insert desired Utilization data into your internal database
    • Utilizations are connected to Credits by the "Credit ID"
    • Utilizations are also connected to Projects by the "Project ID"

4) Make some changes to your portfolio, re-run your script and ensure the data integration is functioning

Phase 2 - Deployment to Production Environment​

Request your Production API Key and adjust your script to the production subdomain to perform the integration against your Production account.