Student Referral and Credits
Returns referral and wallet-credit data for learners in your institute. Type `1` lists learners who created a referral code in a date range; type `2` lists every learner's wallet credit balance.
GET
/report/referralreportStudent Referral and Credits
curl --request GET \
--url 'https://<your-api-host>/nuSource/api/v1/report/referralreport?Type=1&startDate=10-10-2023&endDate=10-10-2023' \
--header 'APIKEY: <your-api-key>' \
--header 'ORGID: <your-org-id>'Access: Institute admins only.
Query parameters
1 referral codes created in the period, 2 all learners with their credit balance. Lowercase type.Start date, for example
10-10-2023 (DD-MM-YYYY). Used by type 1.End date, same format. Used by type
1; codes created before this moment count.Response:
referral_students(type1):user_id,name,email,referral_codeandcreated_at(DD-MM-YYYY).all_student_Credits(type2):id,name,email,credits,referral_codeandcreated_at(signup date, DD-MM-YYYY).
The array for the other type is empty.
Notes: Covers all organizations in your institute, not only ORGID. Dates are read as server time, and endDate at midnight excludes that day. Rate limit: 30 requests per 1 minute; going over locks you out for 30 minutes.