Retrieve and Update User Activity

PATCH

https://host.com/api/v1/activity/:id/

PATCH

/api/v1/activity/:id/

$ curl -X PATCH /api/v1/activity/1/ \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "id": 1,
3   "user": {
4     "id": 42,
5     "username": "jdoe",
6     "email": "jdoe@example.com",
7     "first_time_login": false,
8     "profile_picture": "https://cdn.aisquare.com/profiles/jdoe.jpg",
9     "full_name": "John Doe",
10     "theme": "dark",
11     "is_superuser": false,
12     "is_staff": true,
13     "is_active": true,
14     "is_verified": true
15   },
16   "workspace_group_id": 12,
17   "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
18   "created_at": "2024-01-15T09:30:00Z",
19   "updated_at": "2024-01-15T09:30:00Z",
20   "text": "User logged in successfully from IP 192.168.1.10",
21   "activity_type": 100,
22   "deleted_at": "2024-01-15T09:30:00Z",
23   "is_active": true,
24   "created_by": "admin_user",
25   "updated_by": "jdoe",
26   "deleted_by": "admin_user",
27   "workspace_group": 12
28 }

Retrieves or updates a specific user activity.

Path parameters

idintegerRequired

Request

This endpoint expects an object.

activity_typeenumOptional

100 - User Login
101 - User Logout
200 - Game Created
201 - Game Joined
202 - Game Left
203 - Game Started
204 - Game Completed
205 - Game Won
250 - Daily Streak
300 - Elo Gained
301 - Elo Lost
400 - XP Gained
500 - Resource Viewed
501 - Resource Liked
502 - Resource Unliked
503 - Resource Shared
504 - Resource Bookmarked
505 - Resource Unbookmarked
506 - Resource Commented
507 - Resource Created
508 - Resource Updated
509 - Resource Deleted
600 - Quest Created
601 - Quest Viewed
602 - Quest Updated
603 - Quest Deleted
604 - Quest Played
605 - Quest Completed
606 - Quest Leaderboard Viewed
700 - Publication Created
701 - Publication Viewed
702 - Publication Updated
703 - Publication Deleted
750 - Blog Created
751 - Blog Viewed
752 - Blog Read
753 - Blog Updated
754 - Blog Deleted
755 - Blog Bookmarked
756 - Blog Unbookmarked
757 - Blog Previewed
800 - Experience Created
801 - Experience Viewed
802 - Experience Updated
803 - Experience Deleted
804 - Experience Published
805 - Experience Autofilled
806 - Experience Bulk Deleted
900 - AI Domain Created
901 - AI Domain Viewed
902 - AI Domain Updated
903 - AI Domain Deleted
904 - AI Domain Saved
905 - AI Question Generated
906 - AI Answer Generated
907 - AI Explanation Generated
908 - AI Checker Generated
909 - AI Options Generated
910 - AI Chat Started
911 - AI Chat Message Sent
912 - AI Domain Knowledge Rebuilt
913 - AI Knowledge Searched
1000 - Podcast Created
1001 - Podcast Viewed
1002 - Podcast Listened
1003 - Podcast Updated
1004 - Podcast Deleted
1050 - Video Created
1051 - Video Viewed
1052 - Video Updated
1053 - Video Deleted
1054 - Video Published
1055 - Video Regenerated
1100 - Content Document Created
1101 - Content Document Viewed
1102 - Content Document Updated
1103 - Content Document Deleted
1104 - Content Document Reprocessed
1400 - Collection Created
1401 - Collection Viewed
1402 - Collection Updated
1403 - Collection Deleted
1404 - Collection Experience Added
1405 - Collection Experience Removed
1406 - Collection Experience Reordered
1200 - Profile Updated
1201 - Profile Picture Updated
1202 - Profile Viewed
1300 - User Followed
1301 - User Unfollowed
1302 - User Profile Visited

userobjectOptional

Mixin to handle profile_picture serialization for WebSocket compatibility.

This mixin adds a SerializerMethodField for profile_picture that converts ImageFieldFile objects to URL strings, making them JSON serializable for WebSocket consumers.

The mixin intelligently handles profile pictures from IAMUserDetail by:

Accessing the related details queryset on the IAMUser model
Extracting the ImageFieldFile from the first detail record
Converting it to a URL string for JSON serialization

Usage:

1 class MyUserSerializer(ProfilePictureMixin, serializers.ModelSerializer):
2     class Meta:
3         model = User
4         fields = ['id', 'username', 'profile_picture', ...]

Note:

This mixin expects the model to have a details related manager
The related detail should have a profile_picture ImageField
Returns None if no profile picture is found or an error occurs

deleted_atdatetime or nullOptional

is_activebooleanOptional

created_bystring or nullOptional<=255 characters

updated_bystring or nullOptional<=255 characters

deleted_bystring or nullOptional<=255 characters

textstringOptional<=1023 characters

resourceany or nullOptional

workspace_groupinteger or nullOptional

Workspace group this activity belongs to (derived from user personal workspace or resource context)

Response

User activity details

idintegerRead-only

userobject

Mixin to handle profile_picture serialization for WebSocket compatibility.

This mixin adds a SerializerMethodField for profile_picture that converts ImageFieldFile objects to URL strings, making them JSON serializable for WebSocket consumers.

The mixin intelligently handles profile pictures from IAMUserDetail by:

Accessing the related details queryset on the IAMUser model
Extracting the ImageFieldFile from the first detail record
Converting it to a URL string for JSON serialization

Usage:

1 class MyUserSerializer(ProfilePictureMixin, serializers.ModelSerializer):
2     class Meta:
3         model = User
4         fields = ['id', 'username', 'profile_picture', ...]

Note:

This mixin expects the model to have a details related manager
The related detail should have a profile_picture ImageField
Returns None if no profile picture is found or an error occurs

workspace_group_idintegerRead-only

uidstringRead-onlyformat: "uuid"

created_atdatetimeRead-only

updated_atdatetimeRead-only

textstring<=1023 characters

activity_typeenum

100 - User Login
101 - User Logout
200 - Game Created
201 - Game Joined
202 - Game Left
203 - Game Started
204 - Game Completed
205 - Game Won
250 - Daily Streak
300 - Elo Gained
301 - Elo Lost
400 - XP Gained
500 - Resource Viewed
501 - Resource Liked
502 - Resource Unliked
503 - Resource Shared
504 - Resource Bookmarked
505 - Resource Unbookmarked
506 - Resource Commented
507 - Resource Created
508 - Resource Updated
509 - Resource Deleted
600 - Quest Created
601 - Quest Viewed
602 - Quest Updated
603 - Quest Deleted
604 - Quest Played
605 - Quest Completed
606 - Quest Leaderboard Viewed
700 - Publication Created
701 - Publication Viewed
702 - Publication Updated
703 - Publication Deleted
750 - Blog Created
751 - Blog Viewed
752 - Blog Read
753 - Blog Updated
754 - Blog Deleted
755 - Blog Bookmarked
756 - Blog Unbookmarked
757 - Blog Previewed
800 - Experience Created
801 - Experience Viewed
802 - Experience Updated
803 - Experience Deleted
804 - Experience Published
805 - Experience Autofilled
806 - Experience Bulk Deleted
900 - AI Domain Created
901 - AI Domain Viewed
902 - AI Domain Updated
903 - AI Domain Deleted
904 - AI Domain Saved
905 - AI Question Generated
906 - AI Answer Generated
907 - AI Explanation Generated
908 - AI Checker Generated
909 - AI Options Generated
910 - AI Chat Started
911 - AI Chat Message Sent
912 - AI Domain Knowledge Rebuilt
913 - AI Knowledge Searched
1000 - Podcast Created
1001 - Podcast Viewed
1002 - Podcast Listened
1003 - Podcast Updated
1004 - Podcast Deleted
1050 - Video Created
1051 - Video Viewed
1052 - Video Updated
1053 - Video Deleted
1054 - Video Published
1055 - Video Regenerated
1100 - Content Document Created
1101 - Content Document Viewed
1102 - Content Document Updated
1103 - Content Document Deleted
1104 - Content Document Reprocessed
1400 - Collection Created
1401 - Collection Viewed
1402 - Collection Updated
1403 - Collection Deleted
1404 - Collection Experience Added
1405 - Collection Experience Removed
1406 - Collection Experience Reordered
1200 - Profile Updated
1201 - Profile Picture Updated
1202 - Profile Viewed
1300 - User Followed
1301 - User Unfollowed
1302 - User Profile Visited

deleted_atdatetime or null

is_activeboolean

created_bystring or null<=255 characters

updated_bystring or null<=255 characters

deleted_bystring or null<=255 characters

resourceany or null

workspace_groupinteger or null

Workspace group this activity belongs to (derived from user personal workspace or resource context)

Errors

401

Unauthorized Error

404

Not Found Error