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.Mcf.Get

Contents

REST Resource
Creating a Request
Request Lenses

Description

Returns Analytics Multi-Channel Funnels data for a view (profile).

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

Synopsis

type DataMcfGetResource = "analytics" :> ("v3" :> ("data" :> ("mcf" :> (QueryParam "ids" Text :> (QueryParam "start-date" Text :> (QueryParam "end-date" Text :> (QueryParam "metrics" Text :> (QueryParam "samplingLevel" DataMcfGetSamplingLevel :> (QueryParam "filters" Text :> (QueryParam "sort" Text :> (QueryParam "dimensions" Text :> (QueryParam "start-index" (Textual Int32) :> (QueryParam "max-results" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] McfData))))))))))))))
dataMcfGet :: Text -> Text -> Text -> Text -> DataMcfGet
data DataMcfGet
dmgMetrics :: Lens' DataMcfGet Text
dmgSamplingLevel :: Lens' DataMcfGet (Maybe DataMcfGetSamplingLevel)
dmgFilters :: Lens' DataMcfGet (Maybe Text)
dmgIds :: Lens' DataMcfGet Text
dmgEndDate :: Lens' DataMcfGet Text
dmgSort :: Lens' DataMcfGet (Maybe Text)
dmgDimensions :: Lens' DataMcfGet (Maybe Text)
dmgStartIndex :: Lens' DataMcfGet (Maybe Int32)
dmgMaxResults :: Lens' DataMcfGet (Maybe Int32)
dmgStartDate :: Lens' DataMcfGet Text

REST Resource

type DataMcfGetResource = "analytics" :> ("v3" :> ("data" :> ("mcf" :> (QueryParam "ids" Text :> (QueryParam "start-date" Text :> (QueryParam "end-date" Text :> (QueryParam "metrics" Text :> (QueryParam "samplingLevel" DataMcfGetSamplingLevel :> (QueryParam "filters" Text :> (QueryParam "sort" Text :> (QueryParam "dimensions" Text :> (QueryParam "start-index" (Textual Int32) :> (QueryParam "max-results" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] McfData)))))))))))))) Source #

A resource alias for analytics.data.mcf.get method which the DataMcfGet request conforms to.

Creating a Request

dataMcfGet Source #

Arguments

:: Text	`dmgMetrics`
-> Text	`dmgIds`
-> Text	`dmgEndDate`
-> Text	`dmgStartDate`
-> DataMcfGet

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

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

data DataMcfGet Source #

Returns Analytics Multi-Channel Funnels data for a view (profile).

See: dataMcfGet smart constructor.

Instances

Eq DataMcfGet Source #
Instance details Defined in Network.Google.Resource.Analytics.Data.Mcf.Get Methods (==) :: DataMcfGet -> DataMcfGet -> Bool # (/=) :: DataMcfGet -> DataMcfGet -> Bool #
Data DataMcfGet Source #
Instance details Defined in Network.Google.Resource.Analytics.Data.Mcf.Get Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DataMcfGet -> c DataMcfGet # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DataMcfGet # toConstr :: DataMcfGet -> Constr # dataTypeOf :: DataMcfGet -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DataMcfGet) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DataMcfGet) # gmapT :: (forall b. Data b => b -> b) -> DataMcfGet -> DataMcfGet # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DataMcfGet -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DataMcfGet -> r # gmapQ :: (forall d. Data d => d -> u) -> DataMcfGet -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DataMcfGet -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DataMcfGet -> m DataMcfGet # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DataMcfGet -> m DataMcfGet # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DataMcfGet -> m DataMcfGet #
Show DataMcfGet Source #
Instance details Defined in Network.Google.Resource.Analytics.Data.Mcf.Get Methods showsPrec :: Int -> DataMcfGet -> ShowS # show :: DataMcfGet -> String # showList :: [DataMcfGet] -> ShowS #
Generic DataMcfGet Source #
Instance details Defined in Network.Google.Resource.Analytics.Data.Mcf.Get Associated Types type Rep DataMcfGet :: Type -> Type # Methods from :: DataMcfGet -> Rep DataMcfGet x # to :: Rep DataMcfGet x -> DataMcfGet #
GoogleRequest DataMcfGet Source #
Instance details Defined in Network.Google.Resource.Analytics.Data.Mcf.Get Associated Types type Rs DataMcfGet :: Type # type Scopes DataMcfGet :: [Symbol] # Methods requestClient :: DataMcfGet -> GClient (Rs DataMcfGet) #
type Rep DataMcfGet Source #
Instance details Defined in Network.Google.Resource.Analytics.Data.Mcf.Get type Rep DataMcfGet = D1 (MetaData "DataMcfGet" "Network.Google.Resource.Analytics.Data.Mcf.Get" "gogol-analytics-0.4.0-8oDsBGD0bWo5StLtdNIJLF" False) (C1 (MetaCons "DataMcfGet'" PrefixI True) (((S1 (MetaSel (Just "_dmgMetrics") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_dmgSamplingLevel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DataMcfGetSamplingLevel))) :: (S1 (MetaSel (Just "_dmgFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_dmgIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_dmgEndDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))) :: ((S1 (MetaSel (Just "_dmgSort") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_dmgDimensions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_dmgStartIndex") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :: (S1 (MetaSel (Just "_dmgMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_dmgStartDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))
type Scopes DataMcfGet Source #
Instance details Defined in Network.Google.Resource.Analytics.Data.Mcf.Get type Scopes DataMcfGet = "https://www.googleapis.com/auth/analytics" ': ("https://www.googleapis.com/auth/analytics.readonly" ': ([] :: [Symbol]))
type Rs DataMcfGet Source #
Instance details Defined in Network.Google.Resource.Analytics.Data.Mcf.Get type Rs DataMcfGet = McfData

Request Lenses

dmgMetrics :: Lens' DataMcfGet Text Source #

A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric must be specified.

dmgSamplingLevel :: Lens' DataMcfGet (Maybe DataMcfGetSamplingLevel) Source #

The desired sampling level.

dmgFilters :: Lens' DataMcfGet (Maybe Text) Source #

A comma-separated list of dimension or metric filters to be applied to the Analytics data.

dmgIds :: Lens' DataMcfGet Text Source #

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

dmgEndDate :: Lens' DataMcfGet Text Source #

End date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.

dmgSort :: Lens' DataMcfGet (Maybe Text) Source #

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

dmgDimensions :: Lens' DataMcfGet (Maybe Text) Source #

A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'.

dmgStartIndex :: Lens' DataMcfGet (Maybe Int32) Source #

An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

dmgMaxResults :: Lens' DataMcfGet (Maybe Int32) Source #

The maximum number of entries to include in this feed.

dmgStartDate :: Lens' DataMcfGet Text Source #

Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.