Getting Started - Implan-Group/api GitHub Wiki

Getting Started

To help you get started with using the Impact API, this section will provide a quick overview of a workflow with links to relevant topics.

Process

  1. Get Authenticated to the API.
  2. Identify the Data Year and Datasets you will be using.
  3. Find the that you will be using.
  4. Choose the Industry that you will be using for Events.
  5. Create a Project.
  6. Add Events to it.
  7. Add Groups that associate the Events with particular Regions.
  8. Run the Impact. Depending on the number of Events and Groups, this can take a few minutes.
  9. Poll for the Impact Status until the analysis is Complete.
  10. Export the Impact Results.
⚠️ **GitHub.com Fallback** ⚠️