View Reports

Details

API Details
NameView Reports
Description

Displays the specified report for the specified tenant.

  • This API does not support sorting.

  • This API supports the CSV format for the response. See Response Schema > CSV (Only for Reports).
MethodGET
URI

v1/tenants/tenantId/reports?reportType=report_type&startDate=start_date&endDate=end_date

CloudCenter ReleaseIntroduced in CloudCenter 4.0
Notes
  • For additional context on <PORT> usage in the following example(s), see Base URI Format.
  • The CloudCenter GET APIs display up to 20 entities in the listing by default. If you have more than 20 entities in your resource listing, use the pagination query parameters to view them beyond the first 20 entities returned by default. See the CloudCenter API Overview  > Pagination  section for additional context.
ESB Headeraction: get.tenants.tenantId.reports
actionparam: reportType=report_type&startDate=start_date&endDate=end_date

Example

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/1/reports?reportType=USER_SESSION_ACTIVITY_REPORT&startDate=1433142000000&endDate=1434092399000"

Response

{
 "resource": "https://<HOST>:<PORT>/v1/tenants/1/reports?reportType=USER_SESSION_ACTIVITY_REPORT&
startDate=1433142000000&endDate=1434092399000",
 "size": 1,
 "pageNumber": 0,
 "totalElements": 1,
 "totalPages": 1,
 "userSessionActivityReports": [
 {
 "id": null,
 "resource": null,
 "perms": [],
 "emailAddr": "admin@cliqrtech.com",
 "recentActivityTimeStamp": 1434069999000,
 "activityCount": 115,
 "isLoggedIn": false
 }
 ]
}

Request Attributes

tenantId
  • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See Add Sub-Tenants > Tenant ID and Tenant Name Dependency.

  • Type: String

Required

reportType

Required

startDate

Required

endDate

Required

Response Attributes

This response example includes the userSessionActivity report. The following reports also can be viewed by using this API: 

resource
  • Description: Unique URL to access this resource.
  • Type: String

See pageResource or Pagination for additional context

userSessionActivityReport
  • Description: Identifies information about the user's session
  • Type: Array of mapped attributes

    emailAddr
    • Description: Unique (in the system) email address for this resource and must match the regular expression
    • Type: String
    recentActivityTimeStamp
    • DescriptionThe date and time of the most recent login to the CCM 
    • Type: Long
    activityCount
    • Description:The total number of times that this user has logged in to the CloudCenter platform
    • Type: Long
    isLoggedIn
    • Description: Indicates whether this user is currently logged in to the CCM.
      • true = Use is logged in to the CloudCenter platform
      • false = User is not logged in to the CloudCenter platform
    • Type: Boolean

 

id
  • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

  • Type: String
resource
  • Description: Unique URL to access this resource.
  • Type: String

perms (click for additional details)

emailAddr
  • Description: Unique (in the system) email address for this resource and must match the regular expression
  • Type: String
recentActivityTimeStamp
  • DescriptionThe date and time of the most recent login to the CCM 
  • Type: Long
activityCount
  • Description:The total number of times that this user has logged in to the CloudCenter platform
  • Type: Long
isLoggedIn
  • Description: Indicates whether this user is currently logged in to the CCM.
    • true = Use is logged in to the CloudCenter platform
    • false = User is not logged in to the CloudCenter platform
  • Type: Boolean