Request/Response Parameters Summary
POST /customEventTracking/listFiles
The request and response are both JSON objects. The following is a summary of the properties inside the request and response objects.
Request Properties
|
|
Request JSON Object
|
|
•
|
user (string)—The username of your Usage Intelligence user account. |
|
•
|
productId (integer)—The product ID on which this request is being done. |
|
Response JSON Object
|
|
•
|
status (string)—Contains OK if successful or SYNTAX ERROR or AUTH ERROR. |
|
•
|
reason (string)—Present only if status is not OK. Contains error message (reason). |
|
•
|
openDailyFiles (array)—Array of JSON objects containing information about daily files that are not finalized yet. This normally contains only 1 element which refers to today’s file. This file is still being used to collect data, and therefore, if it is downloaded now, the contents would be different than if it is downloaded later, even though the file name is the same. The objects in this array do not contain a compressedSizeKB element since this is constantly changing. Also, the objects contain a boolean property named isAvailable. If this file is currently being processed by the system, it may be unavailable for download, and therefore this value would be false. |
|
•
|
dailyFiles (array)—Array of JSON objects containing information about daily files that are finalized. These files can be requested for download. |
|
•
|
monthlyFiles (array)—Array of JSON objects containing information about monthly files. These files can be requested for download. |
|