| URL Pattern | View Class or Function | Available in KPI |
|---|---|---|
/api/v1/forms/<form_id>/csv_import |
onadata.apps.api.viewsets.xform_viewset.csv_import |
No |
The entire KoboCAT user interface has been removed. The last release to contain a user interface or any of the endpoints listed below was 2.023.21.
| URL Pattern | View Class or Function | View Name |
|---|---|---|
/ |
onadata.apps.main.views.home |
|
/<username>/ |
onadata.apps.main.views.profile |
user_profile |
/<username>/api-token |
onadata.apps.main.views.api_token |
api_token |
| URL Pattern | View Class or Function | View Name |
|---|---|---|
/login_redirect/ |
onadata.apps.main.views.login_redirect |
|
/<str:username>/forms/<str:id_string>/map |
onadata.apps.main.views.view_func |
redirect_map_to_kpi |
/<str:username>/reports/<str:id_string>/digest.html |
onadata.apps.main.views.view_func |
redirect_analyze_data_to_kpi |
/<str:username>/reports/<str:id_string>/export.html |
onadata.apps.main.views.view_func |
redirect_view_data_in_table_to_kpi |
| URL Pattern | View Class or Function | View Name |
|---|---|---|
/api/v1/forms/<pk>/enketo\.<format>/ |
onadata.apps.api.viewsets.xform_viewset.XFormViewSet |
xform-enketo |
/api/v1/forms/<pk>/enketo |
onadata.apps.api.viewsets.xform_viewset.XFormViewSet |
xform-enketo |
| URL Pattern | View Class or Function | View Name |
|---|---|---|
/forms/<uuid> |
onadata.apps.main.views.show |
show_form |
/<username>/forms/<id_string>/api |
onadata.apps.main.views.api |
mongo_view_api |
/<username>/forms/<id_string>/data\.csv |
onadata.apps.viewer.views.data_export |
csv_export |
/<username>/forms/<id_string>/data\.kml |
onadata.apps.viewer.views.kml_export |
|
/<username>/forms/<id_string>/data\.xls |
onadata.apps.viewer.views.data_export |
xls_export |
/<username>/forms/<id_string>/delete-doc/<data_id> |
onadata.apps.main.views.delete_metadata |
delete_metadata |
/<username>/forms/<id_string>/doc/<data_id> |
onadata.apps.main.views.download_metadata |
download_metadata |
/<username>/forms/<id_string>/edit |
onadata.apps.main.views.edit |
edit_form |
/<username>/forms/<id_string>/formid-media/<data_id> |
onadata.apps.main.views.download_media_data |
download_media_data |
/<username>/forms/<id_string>/form_settings |
onadata.apps.main.views.show_form_settings |
show_form_settings |
/<username>/forms/<id_string> |
onadata.apps.main.views.show |
show_form |
/<username>/forms/<id_string>/photos |
onadata.apps.main.views.form_photos |
form_photos |
/<username>/superuser_stats/<base_filename> |
onadata.apps.logger.views.retrieve_superuser_stats |
|
/<username>/superuser_stats/ |
onadata.apps.logger.views.superuser_stats |
| URL Pattern | View Class or Function | View Name |
|---|---|---|
/admin/doc/bookmarklets/ |
django.contrib.admindocs.views.BookmarkletsView |
django-admindocs-bookmarklets |
/admin/doc/ |
django.contrib.admindocs.views.BaseAdminDocsView |
django-admindocs-docroot |
/admin/doc/filters/ |
django.contrib.admindocs.views.TemplateFilterIndexView |
django-admindocs-filters |
/admin/doc/models/<app_label>\.<model_name>/ |
django.contrib.admindocs.views.ModelDetailView |
django-admindocs-models-detail |
/admin/doc/models/ |
django.contrib.admindocs.views.ModelIndexView |
django-admindocs-models-index |
/admin/doc/tags/ |
django.contrib.admindocs.views.TemplateTagIndexView |
django-admindocs-tags |
/admin/doc/templates/<path:template>/ |
django.contrib.admindocs.views.TemplateDetailView |
django-admindocs-templates |
/admin/doc/views/ |
django.contrib.admindocs.views.ViewIndexView |
django-admindocs-views-index |
/admin/doc/views/<view>/ |
django.contrib.admindocs.views.ViewDetailView |
django-admindocs-views-detail |
/api-docs/ |
django.views.generic.base.RedirectView |
The last release to contain any of the endpoints listed below was 2.021.21.
| URL Pattern | View Class or Function | Description | Available in KPI |
|---|---|---|---|
/<username>/exports/<id_string>.csv |
onadata.apps.export.views._wrapper |
Old version of formpack (not legacy) exports | Yes |
/<username>/exports/<id_string>.html |
onadata.apps.export.views._wrapper |
Old version of formpack (not legacy) exports | Yes |
/<username>/exports/<id_string>.xlsx |
onadata.apps.export.views._wrapper |
Old version of formpack (not legacy) exports | Yes |
/<username>/exports/<id_string>/ |
onadata.apps.export.views._wrapper |
Old version of formpack (not legacy) exports | Yes |
/<username>/forms/<id_string>/add-submission-with |
onadata.apps.viewer.views.add_submission_with |
Unknown (no hits in access log, undocumented, no UI, no significant development since 2013) | No |
/<username>/forms/<id_string>/data.sav.zip |
onadata.apps.viewer.views.data_export |
SPSS SAV data export (dropped from UI in 2015) | No |
/<username>/forms/<id_string>/delete_data |
onadata.apps.main.views.delete_data |
Delete an individual submission | Yes |
/<username>/forms/<id_string>/edit-data/<data_id> |
onadata.apps.logger.views.edit_data |
Edit a submission in Enketo | Yes |
/<username>/forms/<id_string>/enter-data |
onadata.apps.logger.views.enter_data |
Add a submission with Enketo | Yes |
/<username>/forms/<id_string>/instance |
onadata.apps.viewer.views.instance |
View a single instance | Yes |
/<username>/forms/<id_string>/map |
onadata.apps.viewer.views.map_view |
View submissions on a map | Yes |
/<username>/forms/<id_string>/map_embed |
onadata.apps.viewer.views.map_embed_view |
View submissions on a map | Yes |
/<username>/forms/<id_string>/view-data |
onadata.apps.viewer.views.data_view |
View submissions in a table | Yes |
/<username>/reports/<id_string>/digest.html |
onadata.apps.survey_report.views._wrapper |
“Analyze data” (outdated version of KPI’s “Reports”) | Yes |
/<username>/reports/<id_string>/digest/ |
onadata.apps.survey_report.views._wrapper |
Old version of formpack (not legacy) exports | Yes |
/<username>/reports/<id_string>/export.csv |
onadata.apps.survey_report.views._wrapper |
Old version of formpack (not legacy) exports | Yes |
/<username>/reports/<id_string>/export.html |
onadata.apps.survey_report.views._wrapper |
Old version of formpack (not legacy) exports | Yes |
/<username>/reports/<id_string>/export.xlsx |
onadata.apps.survey_report.views._wrapper |
Old version of formpack (not legacy) exports | Yes |
/<username>/reports/<id_string>/export/ |
onadata.apps.survey_report.views._wrapper |
Old version of formpack (not legacy) exports | Yes |
/<username>/reports/<id_string>/submission/<submission>.html |
onadata.apps.survey_report.views._wrapper |
Old version of formpack (not legacy) exports | Yes |
| URL Pattern | View Class or Function | Description | Available in KPI |
|---|---|---|---|
/<username>/<id_string>/toggle_downloadable/ |
onadata.apps.logger.views.toggle_downloadable |
Switch data collection on and off for a project | Yes, as “archive” |
/<username>/cloneform |
onadata.apps.main.views.clone_xlsform |
Unused and undocumented form cloning feature | Yes |
/<username>/delete/<id_string>/ |
onadata.apps.logger.views.delete_xform |
Delete an entire project | Yes |
/<username>/forms/<id_string>/delete-doc/<data_id> |
onadata.apps.main.views.delete_metadata |
Delete background documents | No |
/<username>/forms/<id_string>/perms |
onadata.apps.main.views.set_perm |
Set project permissions | Yes |
/<username>/forms/<id_string>/preview |
onadata.apps.main.views.enketo_preview |
Preview a form in Enketo | Yes |
/<username>/forms/<id_string>/public_api |
onadata.apps.main.views.public_api |
Basic form metadata: title, owner’s username, date created/modified, id_string, uuid, sharing status, archival status | Yes, but only if public access to the project is explicitly granted |
/<username>/forms/<id_string>/qrcode |
onadata.apps.main.views.qrcode |
QR code (as a HTML page) containing Enketo data-entry URL | No |
/<username>/forms/<id_string>/update |
onadata.apps.main.views.update_xform |
Overwrite a project with new XLSForm | Yes |
/api/v1/forms/<pk>/enketo |
onadata.apps.api.viewsets.xform_viewset.XFormViewSet |
Retrieve Enketo data entry URL | Yes |
| URL Pattern | View Class or Function | Description | Available in KPI |
|---|---|---|---|
/<username>/activity |
onadata.apps.main.views.activity |
Audit log entries (non-functional) | No |
/<username>/activity/api |
onadata.apps.main.views.activity_api |
Audit log entries (non-functional) | No |
/<username>/forms/<id_string>/gdocs |
onadata.apps.viewer.views.google_xls_export |
Google Docs export (non-functional) | No |
/<username>/forms/<id_string>/sms_multiple_submissions |
onadata.apps.sms_support.views.import_multiple_submissions_for_form |
Data collection via SMS (non-functional) | No |
/<username>/forms/<id_string>/sms_submission |
onadata.apps.sms_support.views.import_submission_for_form |
Data collection via SMS (non-functional) | No |
/<username>/forms/<id_string>/sms_submission/<service>/ |
onadata.apps.sms_support.providers.import_submission_for_form |
Data collection via SMS (non-functional) | No |
/<username>/forms/<id_string>/thank_you_submission |
onadata.apps.viewer.views.thank_you_submission |
Data collection via SMS (non-functional) | No |
/<username>/sms_multiple_submissions |
onadata.apps.sms_support.views.import_multiple_submissions |
Data collection via SMS (non-functional) | No |
/<username>/sms_submission |
onadata.apps.sms_support.views.import_submission |
Data collection via SMS (non-functional) | No |
/<username>/sms_submission/<service>/ |
onadata.apps.sms_support.providers.import_submission |
Data collection via SMS (non-functional) | No |
/about-us/ |
onadata.apps.main.views.about_us |
Unused informational page | Yes (on kobotoolbox.org) |
/accounts/activate/<activation_key>/ |
registration.backends.default.views.ActivationView |
Unused user management | Yes (always was) |
/accounts/activate/complete/ |
django.views.generic.base.TemplateView |
Unused user management | Yes (always was) |
/accounts/password/change/ |
django.contrib.auth.views.password_change |
Unused user management | Yes (always was) |
/accounts/password/change/done/ |
django.contrib.auth.views.password_change_done |
Unused user management | Yes (always was) |
/accounts/password/reset/ |
django.contrib.auth.views.password_reset |
Unused user management | Yes (always was) |
/accounts/password/reset/complete/ |
django.contrib.auth.views.password_reset_complete |
Unused user management | Yes (always was) |
/accounts/password/reset/confirm/<uidb64>/<token>/ |
django.contrib.auth.views.password_reset_confirm |
Unused user management | Yes (always was) |
/accounts/password/reset/done/ |
django.contrib.auth.views.password_reset_done |
Unused user management | Yes (always was) |
/accounts/register/ |
onadata.apps.main.registration_views.FHRegistrationView |
Unused user management | Yes (always was) |
/accounts/register/complete/ |
django.views.generic.base.TemplateView |
Unused user management | Yes (always was) |
/activity/fields |
onadata.apps.main.views.activity_fields |
Schema for audit log | No |
/api/v1/profiles/<user>/change_password |
onadata.apps.api.viewsets.user_profile_viewset.UserProfileViewSet |
Unused user management | Yes (always was) |
/api/v1/profiles/<user>/change_password.<format>/ |
onadata.apps.api.viewsets.user_profile_viewset.UserProfileViewSet |
Unused user management | Yes (always was) |
/faq/ |
onadata.apps.main.views.faq |
Unused informational page | Yes (on kobotoolbox.org) |
/gauthtest/ |
onadata.apps.main.google_export.google_oauth2_request |
Google authentication (non-functional) | No |
/getting_started/ |
onadata.apps.main.views.getting_started |
Unused informational page | Yes (on kobotoolbox.org) |
/gwelcome/ |
onadata.apps.main.google_export.google_auth_return |
Google authentication (non-functional) | No |
/people/ |
onadata.apps.main.views.members_list |
Unused informational page | Yes (on kobotoolbox.org) |
/privacy/ |
onadata.apps.main.views.privacy |
Unused informational page | Yes |
/resources/ |
onadata.apps.main.views.resources |
Unused informational page | Yes (on kobotoolbox.org) |
/support/ |
onadata.apps.main.views.support |
Unused informational page | Yes (on kobotoolbox.org) |
/syntax/ |
onadata.apps.main.views.syntax |
Unused informational page | Yes (on kobotoolbox.org) |
/tos/ |
onadata.apps.main.views.tos |
Unused informational page | Yes |
/tutorial/ |
onadata.apps.main.views.tutorial |
Unused informational page | Yes (on kobotoolbox.org) |
/typeahead_usernames |
onadata.apps.main.views.username_list |
Username autocompletion for legacy permissions UI (not API endpoint for external use) | No (removed for privacy) |
/xls2xform/ |
onadata.apps.main.views.xls2xform |
Unused informational page | Yes (on kobotoolbox.org) |
KoboCAT endpoint removals as of release 2.020.40
The last release to contain any of the endpoints listed below was https://github.com/kobotoolbox/kobocat/releases/tag/2.020.39.
| URL Pattern | View Class or Function | View Name |
|---|---|---|
/<username>/forms/<id_string>/stats |
onadata.apps.viewer.views.charts |
form-stats |
/<username>/forms/<id_string>/tables |
onadata.apps.viewer.views.stats_tables |
|
/api/v1/charts |
onadata.apps.api.viewsets.charts_viewset.ChartsViewSet |
chart-list |
/api/v1/charts.<format>/ |
onadata.apps.api.viewsets.charts_viewset.ChartsViewSet |
chart-list |
/api/v1/charts/<pk> |
onadata.apps.api.viewsets.charts_viewset.ChartsViewSet |
chart-detail |
/api/v1/charts/<pk>.<format>/ |
onadata.apps.api.viewsets.charts_viewset.ChartsViewSet |
chart-detail |
/api/v1/stats |
onadata.apps.api.viewsets.stats_viewset.StatsViewSet |
stats-list |
/api/v1/stats.<format>/ |
onadata.apps.api.viewsets.stats_viewset.StatsViewSet |
stats-list |
/api/v1/stats/<pk> |
onadata.apps.api.viewsets.stats_viewset.StatsViewSet |
stats-detail |
/api/v1/stats/<pk>.<format>/ |
onadata.apps.api.viewsets.stats_viewset.StatsViewSet |
stats-detail |
/api/v1/stats/submissions |
onadata.apps.api.viewsets.submissionstats_viewset.SubmissionStatsViewSet |
submissionstats-list |
/api/v1/stats/submissions.<format>/ |
onadata.apps.api.viewsets.submissionstats_viewset.SubmissionStatsViewSet |
submissionstats-list |
/api/v1/stats/submissions/<pk> |
onadata.apps.api.viewsets.submissionstats_viewset.SubmissionStatsViewSet |
submissionstats-detail |
/api/v1/stats/submissions/<pk>.<format>/ |
onadata.apps.api.viewsets.submissionstats_viewset.SubmissionStatsViewSet |
submissionstats-detail |
/stats/ |
onadata.apps.stats.views.stats |
form-stats |
/stats/submissions/ |
onadata.apps.stats.views.submissions |
| URL Pattern | View Class or Function | View Name |
|---|---|---|
/api/v1/forms/<pk>/clone |
onadata.apps.api.viewsets.xform_viewset.XFormViewSet |
xform-clone |
/api/v1/forms/<pk>/clone.<format>/ |
onadata.apps.api.viewsets.xform_viewset.XFormViewSet |
xform-clone |
| URL Pattern | View Class or Function | View Name |
|---|---|---|
/api/v1/forms/<pk>/share |
onadata.apps.api.viewsets.xform_viewset.XFormViewSet |
xform-share |
/api/v1/forms/<pk>/share.<format>/ |
onadata.apps.api.viewsets.xform_viewset.XFormViewSet |
xform-share |
| URL Pattern | View Class or Function | View Name |
|---|---|---|
/api/v1/profiles |
onadata.apps.api.viewsets.user_profile_viewset.UserProfileViewSet |
userprofile-list |
/api/v1/profiles.<format>/ |
onadata.apps.api.viewsets.user_profile_viewset.UserProfileViewSet |
userprofile-list |
/api/v1/profiles/<user> |
onadata.apps.api.viewsets.user_profile_viewset.UserProfileViewSet |
userprofile-detail |
/api/v1/profiles/<user>.<format>/ |
onadata.apps.api.viewsets.user_profile_viewset.UserProfileViewSet |
userprofile-detail |
/api/v1/profiles/<user>/change_password |
onadata.apps.api.viewsets.user_profile_viewset.UserProfileViewSet |
userprofile-change-password |
/api/v1/profiles/<user>/change_password.<format>/ |
onadata.apps.api.viewsets.user_profile_viewset.UserProfileViewSet |
userprofile-change-password |
/api/v1/user/reset |
onadata.apps.api.viewsets.connect_viewset.ConnectViewSet |
userprofile-reset |
/api/v1/user/reset.<format>/ |
onadata.apps.api.viewsets.connect_viewset.ConnectViewSet |
userprofile-reset |
/api/v1/users |
onadata.apps.api.viewsets.user_viewset.UserViewSet |
user-list |
/api/v1/users.<format>/ |
onadata.apps.api.viewsets.user_viewset.UserViewSet |
user-list |
/api/v1/users/<username> |
onadata.apps.api.viewsets.user_viewset.UserViewSet |
user-detail |
/api/v1/users/<username>.<format>/ |
onadata.apps.api.viewsets.user_viewset.UserViewSet |
user-detail |
These endpoints existed but were neither maintained nor tested, and their features were never available in the UI. They might be added to KPI at an indeterminate future time given interest and funding.
| URL Pattern | View Class or Function | View Name |
|---|---|---|
/api/v1/orgs |
onadata.apps.api.viewsets.organization_profile_viewset.OrganizationProfileViewSet |
organizationprofile-list |
/api/v1/orgs.<format>/ |
onadata.apps.api.viewsets.organization_profile_viewset.OrganizationProfileViewSet |
organizationprofile-list |
/api/v1/orgs/<user> |
onadata.apps.api.viewsets.organization_profile_viewset.OrganizationProfileViewSet |
organizationprofile-detail |
/api/v1/orgs/<user>.<format>/ |
onadata.apps.api.viewsets.organization_profile_viewset.OrganizationProfileViewSet |
organizationprofile-detail |
/api/v1/orgs/<user>/members |
onadata.apps.api.viewsets.organization_profile_viewset.OrganizationProfileViewSet |
organizationprofile-members |
/api/v1/orgs/<user>/members.<format>/ |
onadata.apps.api.viewsets.organization_profile_viewset.OrganizationProfileViewSet |
organizationprofile-members |
/api/v1/projects |
onadata.apps.api.viewsets.project_viewset.ProjectViewSet |
project-list |
/api/v1/projects.<format>/ |
onadata.apps.api.viewsets.project_viewset.ProjectViewSet |
project-list |
/api/v1/projects/<pk> |
onadata.apps.api.viewsets.project_viewset.ProjectViewSet |
project-detail |
/api/v1/projects/<pk>.<format>/ |
onadata.apps.api.viewsets.project_viewset.ProjectViewSet |
project-detail |
/api/v1/projects/<pk>/forms |
onadata.apps.api.viewsets.project_viewset.ProjectViewSet |
project-forms |
/api/v1/projects/<pk>/forms.<format>/ |
onadata.apps.api.viewsets.project_viewset.ProjectViewSet |
project-forms |
/api/v1/projects/<pk>/labels |
onadata.apps.api.viewsets.project_viewset.ProjectViewSet |
project-labels |
/api/v1/projects/<pk>/labels.<format>/ |
onadata.apps.api.viewsets.project_viewset.ProjectViewSet |
project-labels |
/api/v1/projects/<pk>/share |
onadata.apps.api.viewsets.project_viewset.ProjectViewSet |
project-share |
/api/v1/projects/<pk>/share.<format>/ |
onadata.apps.api.viewsets.project_viewset.ProjectViewSet |
project-share |
/api/v1/projects/<pk>/star |
onadata.apps.api.viewsets.project_viewset.ProjectViewSet |
project-star |
/api/v1/projects/<pk>/star.<format>/ |
onadata.apps.api.viewsets.project_viewset.ProjectViewSet |
project-star |
/api/v1/teams |
onadata.apps.api.viewsets.team_viewset.TeamViewSet |
team-list |
/api/v1/teams.<format>/ |
onadata.apps.api.viewsets.team_viewset.TeamViewSet |
team-list |
/api/v1/teams/<pk> |
onadata.apps.api.viewsets.team_viewset.TeamViewSet |
team-detail |
/api/v1/teams/<pk>.<format>/ |
onadata.apps.api.viewsets.team_viewset.TeamViewSet |
team-detail |
/api/v1/teams/<pk>/members |
onadata.apps.api.viewsets.team_viewset.TeamViewSet |
team-members |
/api/v1/teams/<pk>/members.<format>/ |
onadata.apps.api.viewsets.team_viewset.TeamViewSet |
team-members |
| URL Pattern | View Class or Function | View Name |
|---|---|---|
/api/v1/user/<user>/starred |
onadata.apps.api.viewsets.connect_viewset.ConnectViewSet |
userprofile-starred |
/api/v1/user/<user>/starred.<format>/ |
onadata.apps.api.viewsets.connect_viewset.ConnectViewSet |
userprofile-starred |
| URL Pattern | View Class or Function | View Name |
|---|---|---|
/<username>/forms/<id_string>/bamboo |
onadata.apps.main.views.link_to_bamboo |
|
/<username>/form-submissions |
onadata.apps.logger.views.ziggy_submissions |