Using the FeedbackFruits Data API

The FeedbackFruits Data API

• The FeedbackFruits Data API enables programmatic institutional data extraction. It provides a structured, relational way to sync FeedbackFruits data with your internal data warehouses.

• Available data consists of data on courses, learning activities, group structures, student progress, grades, submissions, feedback, etc.

• Depending on the region in which your data is hosted, you need to use the right URL. Navigate to this URL in your browser to view the rich documentation on authentication, available end points and data definitions.

  • EU: https://eu-data-api.feedbackfruits.com 

  • US: https://us-data-api.feedbackfruits.com 

  • CA: https://ca-data-api.feedbackfruits.com 

  • AU: https://au-data-api.feedbackfruits.com 

Getting Access

Using this API requires an API key. Get in touch with your FeedbackFruits contact person to request an API key.

Getting Started

For in-depth technical specs, please refer to the documentation hosted on the landing page (the url of the api). To summarise the workflow:

1. Authentication: Send a POST request with your API key to the regional login endpoint to receive an access_token.

2. Authorization: Use that token in the Authorization header of all data requests as a Bearer token (e.g., Authorization: Bearer <your_token>).

3. Regional Endpoints: Ensure your requests match your data residency (e.g., eu-data-api, us-data-api, etc.).

4. Filtering with Query Parameters: To keep payloads manageable and syncs efficient, use query parameters:

   • Time-based: created_after, updated_after, created_before, or updated_before (use UTC format).

   • Pagination: query_limit (to set page size) and offset (to move through pages).

5. Data Schema: Every response includes a columns array. This serves as your "dictionary" to understand the data types and descriptions for the objects returned in the data array.