Note: The Data Fabric Compass API is an asynchronous API endpoint. It allows authenticated users to make requests and receive responses through two distinct calls, without having to wait for the server to finish processing all of the data.
This tutorial covers the necessary steps in setting up and testing the Data Fabric Compass APIs within Postman.
- Download and install Postman.
- Create an authorized app in ION API gateway and download the credentials (detailed instructions).
- The following video provides an overview of the Data Fabric Compass APIs, and walks though the process of creating an authorized app in ION API, exporting the generated credentials for use with Postman, and finally how you can create and manage Compass queries directly within Postman.
You should select an optimal size for downloading query results based on hardware constraints and network timeouts. This will also allow you to re-retrieve a portion of the result in the event of a connection failure. Keep in mind that the result of a query is static, and does not change when data is added or updated in the Data Lake. The page size is based on rows, with a maximum limit of 100,000 rows with a 10 MB size limit. The version 2 Compass APIs functionality uses OFFSET and LIMIT parameters for the result set retrieved. Query results are usually available for roughly 20 hours after receiving the FINISHED status.
You can learn more about the Compass API paging feature in this walkthrough:
Note: The API section includes a documented listing of the Data Fabric Compass API that you can interact with and test on this platform.