API Root
========

.. attention::

   We've begun releasing new API functionality under our v2 area,
   :doc:`../v2/root`

::

    /detective/api/

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/``.
Similarly, if your school is on ``au.aspiredu.com``,
then the path will be ``https://au.aspiredu.com/detective/api/``.

GET
---

Available Response Content-Types:
  ``application/json``
Links:
  ``advisor_viewers``: :doc:`advisor_viewers`
    Manage the viewers of the advisors for your school.
  ``advisor_students``: :doc:`advisor_students`
    Manage the students for the advisors for your school.
  ``dashboard_viewers``: :doc:`dashboard_viewers`
    Manage the viewers of the dashboards for your school.
  ``dashboard_students``: :doc:`dashboard_students`
    Manage the students for the dashboards for your school.