Overview of Using REST APIs for Data Extraction

After configuring and validating data extracts in the application, you can use REST APIs to automate data extraction and integrate with external systems.

The REST APIs enable you to programmatically schedule extract jobs, monitor execution status, and retrieve output data. These APIs use the extract definitions and configurations created in the application.

This approach is used when integrating with existing data pipelines or building automated workflows, where data extraction is performed without manual interaction.

Relationship Between Application Setup and REST APIs

Data extraction using REST APIs depends on the configurations created in the application.
  • Extract definitions and groups are created and configured in the application
  • Scheduling, execution, and data retrieval are performed using REST APIs
  • The APIs use the existing configurations created in the application

Typical Workflow

  1. Use the application to construct the extract definitions and export group
  2. Use the application to define attributes, filtering, and column headings
  3. Use the application to schedule, test, and verify the output
  4. Use REST APIs to automate data extraction and integration