Copyright | (c) 2015-2016 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 list of activities for a specific customer and application.
See: Admin Reports API Reference for reports.activities.list
.
Synopsis
- type ActivitiesListResource = "admin" :> ("reports" :> ("v1" :> ("activity" :> ("users" :> (Capture "userKey" Text :> ("applications" :> (Capture "applicationName" Text :> (QueryParam "startTime" Text :> (QueryParam "filters" Text :> (QueryParam "customerId" Text :> (QueryParam "actorIpAddress" Text :> (QueryParam "endTime" Text :> (QueryParam "pageToken" Text :> (QueryParam "eventName" Text :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "orgUnitID" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] Activities)))))))))))))))))
- activitiesList :: Text -> Text -> ActivitiesList
- data ActivitiesList
- alStartTime :: Lens' ActivitiesList (Maybe Text)
- alFilters :: Lens' ActivitiesList (Maybe Text)
- alCustomerId :: Lens' ActivitiesList (Maybe Text)
- alActorIPAddress :: Lens' ActivitiesList (Maybe Text)
- alEndTime :: Lens' ActivitiesList (Maybe Text)
- alApplicationName :: Lens' ActivitiesList Text
- alPageToken :: Lens' ActivitiesList (Maybe Text)
- alEventName :: Lens' ActivitiesList (Maybe Text)
- alUserKey :: Lens' ActivitiesList Text
- alMaxResults :: Lens' ActivitiesList (Maybe Int32)
- alOrgUnitId :: Lens' ActivitiesList Text
REST Resource
type ActivitiesListResource = "admin" :> ("reports" :> ("v1" :> ("activity" :> ("users" :> (Capture "userKey" Text :> ("applications" :> (Capture "applicationName" Text :> (QueryParam "startTime" Text :> (QueryParam "filters" Text :> (QueryParam "customerId" Text :> (QueryParam "actorIpAddress" Text :> (QueryParam "endTime" Text :> (QueryParam "pageToken" Text :> (QueryParam "eventName" Text :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "orgUnitID" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] Activities))))))))))))))))) Source #
A resource alias for reports.activities.list
method which the
ActivitiesList
request conforms to.
Creating a Request
Creates a value of ActivitiesList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ActivitiesList Source #
Retrieves a list of activities for a specific customer and application.
See: activitiesList
smart constructor.
Instances
Request Lenses
alStartTime :: Lens' ActivitiesList (Maybe Text) Source #
Return events which occurred at or after this time.
alFilters :: Lens' ActivitiesList (Maybe Text) Source #
Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...
alCustomerId :: Lens' ActivitiesList (Maybe Text) Source #
Represents the customer for which the data is to be fetched.
alActorIPAddress :: Lens' ActivitiesList (Maybe Text) Source #
IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.
alEndTime :: Lens' ActivitiesList (Maybe Text) Source #
Return events which occurred at or before this time.
alApplicationName :: Lens' ActivitiesList Text Source #
Application name for which the events are to be retrieved.
alPageToken :: Lens' ActivitiesList (Maybe Text) Source #
Token to specify next page.
alEventName :: Lens' ActivitiesList (Maybe Text) Source #
Name of the event being queried.
alUserKey :: Lens' ActivitiesList Text Source #
Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users.
alMaxResults :: Lens' ActivitiesList (Maybe Int32) Source #
Number of activity records to be shown in each page.
alOrgUnitId :: Lens' ActivitiesList Text Source #
the organizational unit's(OU) ID to filter activities from users belonging to a specific OU or one of its sub-OU(s)