Skip to main content

Fetch Analytics

Endpoint: /analytics/fetch

Request Parameters

FieldTypeRequiredDescription
room_idsarrayYesArray of room IDs to fetch analytics for.
fromnumberNoStarting index for records. Default is 0.
limitnumberNoMaximum number of records to return. Default is 20.
order_bystringNoSort order: DESC or ASC. Default is DESC.

Example Request:

{
"room_ids": ["room01"],
"from": 0,
"limit": 20,
"order_by": "DESC"
}

Response

FieldTypePositionDescription
statusbooleanrootIndicates if the request was successful.
msgstringrootResponse message.
resultobjectrootContains the analytics data.

Result

FieldTypeDescription
total_analyticsnumberTotal number of analytics records found.
fromnumberStarting index for the returned records.
limitnumberNumber of records returned.
order_bystringSort order used for the records.
analytics_listArray<analytics-info>List of analytics records.

Analytics Info

FieldTypeDescription
room_idstringThe ID of the room.
file_idstringThe ID of the analytics file.
file_namestringThe name of the analytics file.
file_sizenumberThe size of the file in bytes.
creation_timenumberFile creation time (Unix timestamp).
room_creation_timenumberRoom creation time (Unix timestamp).