API Recipes

Choose the result you need. Each Recipe includes prepared requests, illustrative responses and the steps to turn the data into a report or complete the workflow. Run requests as an Administrator using Authentication and the API Playground. Replace example IDs, emails, codes and dates with your own values. Responses use illustrative data. Before running a processing example, resolve any GraphQL errors and check that the requested records were returned.

​

Traffic and conversion

• Get traffic sources
• Get the most visited pages
• Compare traffic between periods
• Compare traffic, registrations and paid customers
• Measure registration-to-paid conversion

​

Sales and commercial reporting

• Get sales for a period
• Compare sales of a Course’s Offers
• Get revenue by Course
• Measure sales using a coupon
• Get a Student’s purchase history
• Compare revenue by Student origin
• Find open and failed Orders
• Review refunds and disputes

​

Students and learning

• Get Student progress for a Course
• Get a Student’s progress by lesson
• Compare video lesson engagement
• Explain Students’ Course access sources
• Compare quiz results for a Course

​

Course setup and access

• Recreate a Course from an outline
• Grant and check Course access

Explore more workflows with the complete API schema and Build with AI.