Skip to main content

Problem Statement


The /events API, when used with the stream_type parameter set to admin_logs or admin_logs_streaming, returns limited metadata in the source field — typically including only basic attributes like id, name, parent, and owned_by.

However, when the same endpoint is used without explicitly setting the stream_type parameter (which defaults to all), the source field includes significantly more detailed information. This includes attributes like path_collection, file_version, timestamps (created_at, modified_at, etc.), and ownership metadata.

 

Proposed Enhancement
 

We request that the /events API be enhanced to return a more complete source object structure across all stream_type values — especially for admin_logs and admin_logs_streaming.

 

Alternative Suggestion

 

If a uniform response structure cannot be guaranteed across all stream types, we propose introducing an optional API query parameter that allows clients to explicitly request extended metadata in the response (e.g., fields=source.path_collection).

 

Contextual Comparison

 

With stream_type=admin_logs or admin_logs_streaming:

"source": {
"item_type": "file",
"item_id": "1711022311716",
"item_name": "example.txt",
"parent": {
"type": "folder",
"name": "test_box",
"id": "295795724485"
},
"owned_by": {
"type": "user",
"id": "19096390853",
"name": "Fname Lname"
}
}

With default stream_type=all:

"source": {
"type": "file",
"id": "17484723617539",
"name": "createdata.py",
"path_collection": {
"entries":
{ "type": "folder", "id": "0", "name": "All Files" },
{ "type": "folder", "id": "295795724485", "name": "test_box" },
{ "type": "folder", "id": "302492601162", "name": "TEST_FOLDER" }
]
},
...
}

 

Be the first to reply!

Reply