Q: Can I modify student data through the API?

A: No, this is a read-only API for data retrieval and analytics only. Students and instructors make data modifications through the Smrt English platform.

Q: How often is data updated?

A: Data is real-time. When you query the API, you receive the current state of student progress as it exists in the Smrt English system.

Q: Is there a rate limit?

A: Currently there is no strict rate limit, but please be respectful of resources. We recommend implementing caching on your side and avoiding excessive repeated requests. Contact your Smrt representative if you need high-volume access.

Q: Can I access students from multiple institutions?

A: Each API key is tied to one institution. If your organization operates multiple institutions using Smrt English, please contact your Smrt representative to discuss your needs.

Q: What if a student doesn't have any completed assignments?

A: The assignments array will be empty [], and summary statistics will show 0 completed with appropriate metrics.

Q: Why do some fields not appear in the response?

A: Empty, null, or zero-value fields are automatically filtered out to keep responses clean and efficient. This reduces data transfer and makes parsing easier.

Q: Can I use email addresses to look up students?

A: Yes, the API accepts both user IDs (numeric) and email addresses as student identifiers.

Q: How do I get student user IDs for my institution?

A: Student user IDs can be obtained from your institution's Smrt English administrative interface, or you can use email addresses directly if you have them.

Q: What happens if a student transfers to a different institution?

A: If a student is no longer enrolled at your institution, the API will return a 404 (Not Found) error when you attempt to access their data.