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

Network.Google.Resource.Analytics.Data.Realtime.Get

Contents

REST Resource
Creating a Request
Request Lenses

Description

Returns real time data for a view (profile).

See: Google Analytics API Reference for analytics.data.realtime.get.

Synopsis

REST Resource

type DataRealtimeGetResource = "analytics" :> ("v3" :> ("data" :> ("realtime" :> (QueryParam "ids" Text :> (QueryParam "metrics" Text :> (QueryParam "filters" Text :> (QueryParam "sort" Text :> (QueryParam "dimensions" Text :> (QueryParam "max-results" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] RealtimeData)))))))))) Source #

A resource alias for analytics.data.realtime.get method which the DataRealtimeGet request conforms to.

Creating a Request

dataRealtimeGet Source #

Arguments

:: Text	`drgMetrics`
-> Text	`drgIds`
-> DataRealtimeGet

Creates a value of DataRealtimeGet with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data DataRealtimeGet Source #

Returns real time data for a view (profile).

See: dataRealtimeGet smart constructor.

Instances

Eq DataRealtimeGet Source #
Methods (==) :: DataRealtimeGet -> DataRealtimeGet -> Bool # (/=) :: DataRealtimeGet -> DataRealtimeGet -> Bool #
Data DataRealtimeGet Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DataRealtimeGet -> c DataRealtimeGet # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DataRealtimeGet # toConstr :: DataRealtimeGet -> Constr # dataTypeOf :: DataRealtimeGet -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c DataRealtimeGet) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DataRealtimeGet) # gmapT :: (forall b. Data b => b -> b) -> DataRealtimeGet -> DataRealtimeGet # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DataRealtimeGet -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DataRealtimeGet -> r # gmapQ :: (forall d. Data d => d -> u) -> DataRealtimeGet -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DataRealtimeGet -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DataRealtimeGet -> m DataRealtimeGet # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DataRealtimeGet -> m DataRealtimeGet # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DataRealtimeGet -> m DataRealtimeGet #
Show DataRealtimeGet Source #
Methods showsPrec :: Int -> DataRealtimeGet -> ShowS # show :: DataRealtimeGet -> String # showList :: [DataRealtimeGet] -> ShowS #
Generic DataRealtimeGet Source #
Associated Types type Rep DataRealtimeGet :: * -> * # Methods from :: DataRealtimeGet -> Rep DataRealtimeGet x # to :: Rep DataRealtimeGet x -> DataRealtimeGet #
GoogleRequest DataRealtimeGet Source #
Associated Types type Rs DataRealtimeGet :: * # type Scopes DataRealtimeGet :: [Symbol] # Methods requestClient :: DataRealtimeGet -> Client (Rs DataRealtimeGet) #
type Rep DataRealtimeGet Source #
type Rep DataRealtimeGet = D1 (MetaData "DataRealtimeGet" "Network.Google.Resource.Analytics.Data.Realtime.Get" "gogol-analytics-0.1.1-EfBAd1n6PTiCzEHlr4hlvf" False) (C1 (MetaCons "DataRealtimeGet'" PrefixI True) ((::) ((::) (S1 (MetaSel (Just Symbol "_drgMetrics") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((::) (S1 (MetaSel (Just Symbol "_drgFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_drgIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))) ((::) (S1 (MetaSel (Just Symbol "_drgSort") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_drgDimensions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_drgMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))))))))
type Scopes DataRealtimeGet Source #
type Scopes DataRealtimeGet = (:) Symbol "https://www.googleapis.com/auth/analytics" ((:) Symbol "https://www.googleapis.com/auth/analytics.readonly" ([] Symbol))
type Rs DataRealtimeGet Source #
type Rs DataRealtimeGet = RealtimeData

Request Lenses

drgMetrics :: Lens' DataRealtimeGet Text Source #

A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified.

drgFilters :: Lens' DataRealtimeGet (Maybe Text) Source #

A comma-separated list of dimension or metric filters to be applied to real time data.

drgIds :: Lens' DataRealtimeGet Text Source #

Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.

drgSort :: Lens' DataRealtimeGet (Maybe Text) Source #

A comma-separated list of dimensions or metrics that determine the sort order for real time data.

drgDimensions :: Lens' DataRealtimeGet (Maybe Text) Source #

A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'.

drgMaxResults :: Lens' DataRealtimeGet (Maybe Int32) Source #

The maximum number of entries to include in this feed.