Request/Response Parameters Summary
POST /reporting/clientPropertyList
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. Required only for non-cookie authentication. |
|
•
|
sessionId (string)—The sessionId obtained via POST /auth/login. Required only for non-cookie authentication. |
|
•
|
productId (integer)—The product ID on which this request is being done. |
|
•
|
startAtClientId (string)—Optional property to specify the client ID to start at for paging purposes. |
|
•
|
properties (array)—Array of strings containing the list of properties to be included in the current data. |
|
•
|
retDailyData (object)—Optional parameter used if the daily data is being requested. The format for this object is described below. |
|
•
|
globalFilters (object)—Optional JSON object containing the filters to be applied to the available data. Details about these filters can be found in Global Filters. |
|
|
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). |
|
•
|
results (array)—Contains the results as requested represented as a JSON object. The result format is described below. |
|
•
|
reachedEnd (boolean)—Boolean value showing whether the end has been reached or not. This value is false if there are remaining clients which can be retrieved by requesting more pages. |
|
•
|
nextClientId (string)—Returned only if reachedEnd is false. This value can be passed to the startAtClientId property to request the next page. |
|