Copyright | (c) 2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Retrieves a report which is a collection of properties / statistics for a set of users.
See: Admin Reports API Reference for reports.userUsageReport.get
.
- type UserUsageReportGetResource = "admin" :> ("reports" :> ("v1" :> ("usage" :> ("users" :> (Capture "userKey" Text :> ("dates" :> (Capture "date" Text :> (QueryParam "filters" Text :> (QueryParam "customerId" Text :> (QueryParam "parameters" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` UsageReports)))))))))))))
- userUsageReportGet :: Text -> Text -> UserUsageReportGet
- data UserUsageReportGet
- uurgFilters :: Lens' UserUsageReportGet (Maybe Text)
- uurgCustomerId :: Lens' UserUsageReportGet (Maybe Text)
- uurgDate :: Lens' UserUsageReportGet Text
- uurgParameters :: Lens' UserUsageReportGet (Maybe Text)
- uurgPageToken :: Lens' UserUsageReportGet (Maybe Text)
- uurgUserKey :: Lens' UserUsageReportGet Text
- uurgMaxResults :: Lens' UserUsageReportGet (Maybe Word32)
REST Resource
type UserUsageReportGetResource = "admin" :> ("reports" :> ("v1" :> ("usage" :> ("users" :> (Capture "userKey" Text :> ("dates" :> (Capture "date" Text :> (QueryParam "filters" Text :> (QueryParam "customerId" Text :> (QueryParam "parameters" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` UsageReports))))))))))))) Source
A resource alias for reports.userUsageReport.get
method which the
UserUsageReportGet
request conforms to.
Creating a Request
Creates a value of UserUsageReportGet
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data UserUsageReportGet Source
Retrieves a report which is a collection of properties / statistics for a set of users.
See: userUsageReportGet
smart constructor.
Request Lenses
uurgFilters :: Lens' UserUsageReportGet (Maybe Text) Source
Represents the set of filters including parameter operator value.
uurgCustomerId :: Lens' UserUsageReportGet (Maybe Text) Source
Represents the customer for which the data is to be fetched.
uurgDate :: Lens' UserUsageReportGet Text Source
Represents the date in yyyy-mm-dd format for which the data is to be fetched.
uurgParameters :: Lens' UserUsageReportGet (Maybe Text) Source
Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.
uurgPageToken :: Lens' UserUsageReportGet (Maybe Text) Source
Token to specify next page.
uurgUserKey :: Lens' UserUsageReportGet Text Source
Represents the profile id or the user email for which the data should be filtered.
uurgMaxResults :: Lens' UserUsageReportGet (Maybe Word32) Source
Maximum number of results to return. Maximum allowed is 1000