API Root

/detective/api/v2/

This is the only API resource that is a fixed path that needs to be understood by an API client. From this resource, all other resources can be found via links in the body of this resource, and if needed in links in the bodies of resources that are linked from here, recursively.

This path is relative to the domain that your school is on. If we did not inform you which path to use, please email support@aspiredu.com to ask. For example, if your school is on apps.aspiredu.com, then the path would be https://apps.aspiredu.com/detective/api/v2/. Similarly, if your school is on au.aspiredu.com, then the path will be https://au.aspiredu.com/detective/api/v2/.

GET

Available Response Content-Types:

application/json

Links:

dashboards: Dashboards

Manage the dashboards for your school.

dashboard_uploads: Dashboard Uploads

Fetch previous uploads and upload students / viewers for multiple dashboards.

dashboard_unassigned_students: Dashboard Unassigned Students

Fetch the students who are not assigned to a dashboard.