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 |
Push changes to activities
See: Admin Reports API Reference for reports.activities.watch
.
- type ActivitiesWatchResource = "admin" :> ("reports" :> ("v1" :> ("activity" :> ("users" :> (Capture "userKey" Text :> ("applications" :> (Capture "applicationName" Text :> ("watch" :> (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 "alt" AltJSON :> (ReqBody `[JSON]` Channel :> Post `[JSON]` Channel))))))))))))))))))
- activitiesWatch :: Channel -> Text -> Text -> ActivitiesWatch
- data ActivitiesWatch
- awStartTime :: Lens' ActivitiesWatch (Maybe Text)
- awFilters :: Lens' ActivitiesWatch (Maybe Text)
- awPayload :: Lens' ActivitiesWatch Channel
- awCustomerId :: Lens' ActivitiesWatch (Maybe Text)
- awActorIPAddress :: Lens' ActivitiesWatch (Maybe Text)
- awEndTime :: Lens' ActivitiesWatch (Maybe Text)
- awApplicationName :: Lens' ActivitiesWatch Text
- awPageToken :: Lens' ActivitiesWatch (Maybe Text)
- awEventName :: Lens' ActivitiesWatch (Maybe Text)
- awUserKey :: Lens' ActivitiesWatch Text
- awMaxResults :: Lens' ActivitiesWatch (Maybe Int32)
REST Resource
type ActivitiesWatchResource = "admin" :> ("reports" :> ("v1" :> ("activity" :> ("users" :> (Capture "userKey" Text :> ("applications" :> (Capture "applicationName" Text :> ("watch" :> (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 "alt" AltJSON :> (ReqBody `[JSON]` Channel :> Post `[JSON]` Channel)))))))))))))))))) Source
A resource alias for reports.activities.watch
method which the
ActivitiesWatch
request conforms to.
Creating a Request
Creates a value of ActivitiesWatch
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ActivitiesWatch Source
Push changes to activities
See: activitiesWatch
smart constructor.
Request Lenses
awStartTime :: Lens' ActivitiesWatch (Maybe Text) Source
Return events which occured at or after this time.
awFilters :: Lens' ActivitiesWatch (Maybe Text) Source
Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...
awPayload :: Lens' ActivitiesWatch Channel Source
Multipart request metadata.
awCustomerId :: Lens' ActivitiesWatch (Maybe Text) Source
Represents the customer for which the data is to be fetched.
awActorIPAddress :: Lens' ActivitiesWatch (Maybe Text) Source
IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.
awEndTime :: Lens' ActivitiesWatch (Maybe Text) Source
Return events which occured at or before this time.
awApplicationName :: Lens' ActivitiesWatch Text Source
Application name for which the events are to be retrieved.
awPageToken :: Lens' ActivitiesWatch (Maybe Text) Source
Token to specify next page.
awEventName :: Lens' ActivitiesWatch (Maybe Text) Source
Name of the event being queried.
awUserKey :: Lens' ActivitiesWatch 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.
awMaxResults :: Lens' ActivitiesWatch (Maybe Int32) Source
Number of activity records to be shown in each page.