Activity
All events within Directus are tracked and stored in the activities collection. This gives you full accountability over everything that happens. Learn more about Activity.
The Activity Object
action string
Action that was performed.
collection string
Collection identifier in which the item resides.
comment string
User comment. This will store the comments that show up in the right sidebar of the item edit page in the admin app.
id integer
Unique identifier for the object.
ip string
The IP address of the user at the time the action took place.
item string
Unique identifier for the item the action applied to. This is always a string, even for integer primary keys.
timestamp string
When the action happened.
user many-to-one
The user who performed this action. Many-to-one to users.
user_agent string
User agent string of the browser the user used when the action took place.
revisions one-to-many
Any changes that were made in this activity. One-to-many to revisions.
{
"action": "create",
"collection": "articles",
"comment": null,
"id": 5,
"ip": "139.178.128.0",
"item": "1",
"timestamp": "2021-02-02T12:50:26-05:00",
"user": "2d321940-69f5-445f-be6b-c773fa58a820",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.2 Safari/605.1.15",
"revisions": [4]
}{
"action": "create",
"collection": "articles",
"comment": null,
"id": 5,
"ip": "139.178.128.0",
"item": "1",
"timestamp": "2021-02-02T12:50:26-05:00",
"user": "2d321940-69f5-445f-be6b-c773fa58a820",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.2 Safari/605.1.15",
"revisions": [4]
}List Activity Actions
Returns a list of activity actions.
Request
Query Parameters
Supports all global query parameters.
Returns
An array of up to limit activity objects. If no items are available, data will be an empty array.
Example
Retrieve Activity Action
Returns a single activity action by primary key.
Request
Query Parameters
Supports all global query parameters.
Response
Returns an activity object if a valid identifier was provided.
Example
Create a Comment
Creates a new comment on a given item.
Request
Request Body
collection Required
Collection in which the item resides.
item Required
Primary Key of the item to comment on.
comment Required
The comment content. Supports Markdown.
Response
Returns the activity object of the created comment.
Example
Update a Comment
Updates an existing comment by activity action primary key.
Response
Request Body
comment Required
The updated comment content. Supports Markdown.
Response
Returns the activity object of the created comment.
Example
Delete a Comment
Deletes a comment.