Commit 8bce54ba authored by Laury Bueno's avatar Laury Bueno
Browse files

[Docs] Add info about activity endpoints

parent e450be9c
...@@ -30,6 +30,23 @@ urlpatterns = [ ...@@ -30,6 +30,23 @@ urlpatterns = [
``` ```
## Activity streams ## Activity streams
Its possible to log `user-access` by sending a POST request to `/api/stats/user-access/`. Payload example:
Accepted actions: ```json
- user accessed the platform {
"area": "dashboard"
}
```
Note: available areas must be created via Django Admin previously: `<HOST>/django/admin/stats/accessiblearea/`
To log generic activities, send a POST request to `/api/user-actions/`.
```json
{
"verb": "created comment",
"action_object_id": 7, # optional
"action_object_type": "Topic", # optional
"target_id": 26, # optional
"target_type": "Forum" # optional
}
```
Note: any model used as object or target must have been previously registered at `django-courses/courses/stats/apps.py`
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment