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

Contents

REST Resource
Creating a Request
Request Lenses

Description

Returns Analytics data for a view (profile).

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

Synopsis

type DataGaGetResource = "analytics" :> ("v3" :> ("data" :> ("ga" :> (QueryParam "ids" Text :> (QueryParam "start-date" Text :> (QueryParam "end-date" Text :> (QueryParam "metrics" Text :> (QueryParam "samplingLevel" DataGaGetSamplingLevel :> (QueryParam "filters" Text :> (QueryParam "output" DataGaGetOutput :> (QueryParam "sort" Text :> (QueryParam "include-empty-rows" Bool :> (QueryParam "dimensions" Text :> (QueryParam "start-index" (Textual Int32) :> (QueryParam "max-results" (Textual Int32) :> (QueryParam "segment" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] GaData)))))))))))))))))
dataGaGet :: Text -> Text -> Text -> Text -> DataGaGet
data DataGaGet
dggMetrics :: Lens' DataGaGet Text
dggSamplingLevel :: Lens' DataGaGet (Maybe DataGaGetSamplingLevel)
dggFilters :: Lens' DataGaGet (Maybe Text)
dggIds :: Lens' DataGaGet Text
dggEndDate :: Lens' DataGaGet Text
dggOutput :: Lens' DataGaGet (Maybe DataGaGetOutput)
dggSort :: Lens' DataGaGet (Maybe Text)
dggIncludeEmptyRows :: Lens' DataGaGet (Maybe Bool)
dggDimensions :: Lens' DataGaGet (Maybe Text)
dggStartIndex :: Lens' DataGaGet (Maybe Int32)
dggMaxResults :: Lens' DataGaGet (Maybe Int32)
dggSegment :: Lens' DataGaGet (Maybe Text)
dggStartDate :: Lens' DataGaGet Text

REST Resource

A resource alias for analytics.data.ga.get method which the DataGaGet request conforms to.

Creating a Request

dataGaGet Source #

Arguments

:: Text	`dggMetrics`
-> Text	`dggIds`
-> Text	`dggEndDate`
-> Text	`dggStartDate`
-> DataGaGet

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

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

data DataGaGet Source #

Returns Analytics data for a view (profile).

See: dataGaGet smart constructor.

Instances

Eq DataGaGet Source #
Instance details Defined in Network.Google.Resource.Analytics.Data.Ga.Get Methods (==) :: DataGaGet -> DataGaGet -> Bool # (/=) :: DataGaGet -> DataGaGet -> Bool #
Data DataGaGet Source #
Instance details Defined in Network.Google.Resource.Analytics.Data.Ga.Get Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DataGaGet -> c DataGaGet # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DataGaGet # toConstr :: DataGaGet -> Constr # dataTypeOf :: DataGaGet -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DataGaGet) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DataGaGet) # gmapT :: (forall b. Data b => b -> b) -> DataGaGet -> DataGaGet # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DataGaGet -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DataGaGet -> r # gmapQ :: (forall d. Data d => d -> u) -> DataGaGet -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DataGaGet -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DataGaGet -> m DataGaGet # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DataGaGet -> m DataGaGet # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DataGaGet -> m DataGaGet #
Show DataGaGet Source #
Instance details Defined in Network.Google.Resource.Analytics.Data.Ga.Get Methods showsPrec :: Int -> DataGaGet -> ShowS # show :: DataGaGet -> String # showList :: [DataGaGet] -> ShowS #
Generic DataGaGet Source #
Instance details Defined in Network.Google.Resource.Analytics.Data.Ga.Get Associated Types type Rep DataGaGet :: Type -> Type # Methods from :: DataGaGet -> Rep DataGaGet x # to :: Rep DataGaGet x -> DataGaGet #
GoogleRequest DataGaGet Source #
Instance details Defined in Network.Google.Resource.Analytics.Data.Ga.Get Associated Types type Rs DataGaGet :: Type # type Scopes DataGaGet :: [Symbol] # Methods requestClient :: DataGaGet -> GClient (Rs DataGaGet) #
type Rep DataGaGet Source #
Instance details Defined in Network.Google.Resource.Analytics.Data.Ga.Get type Rep DataGaGet = D1 (MetaData "DataGaGet" "Network.Google.Resource.Analytics.Data.Ga.Get" "gogol-analytics-0.4.0-8oDsBGD0bWo5StLtdNIJLF" False) (C1 (MetaCons "DataGaGet'" PrefixI True) (((S1 (MetaSel (Just "_dggMetrics") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: (S1 (MetaSel (Just "_dggSamplingLevel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DataGaGetSamplingLevel)) :: S1 (MetaSel (Just "_dggFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 (MetaSel (Just "_dggIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: (S1 (MetaSel (Just "_dggEndDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_dggOutput") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DataGaGetOutput))))) :: ((S1 (MetaSel (Just "_dggSort") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_dggIncludeEmptyRows") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :: S1 (MetaSel (Just "_dggDimensions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_dggStartIndex") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :: S1 (MetaSel (Just "_dggMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))) :: (S1 (MetaSel (Just "_dggSegment") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_dggStartDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))
type Scopes DataGaGet Source #
Instance details Defined in Network.Google.Resource.Analytics.Data.Ga.Get type Scopes DataGaGet = "https://www.googleapis.com/auth/analytics" ': ("https://www.googleapis.com/auth/analytics.readonly" ': ([] :: [Symbol]))
type Rs DataGaGet Source #
Instance details Defined in Network.Google.Resource.Analytics.Data.Ga.Get type Rs DataGaGet = GaData

Request Lenses

dggMetrics :: Lens' DataGaGet Text Source #

A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified.

dggSamplingLevel :: Lens' DataGaGet (Maybe DataGaGetSamplingLevel) Source #

The desired sampling level.

dggFilters :: Lens' DataGaGet (Maybe Text) Source #

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

dggIds :: Lens' DataGaGet 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.

dggEndDate :: Lens' DataGaGet Text Source #

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

dggOutput :: Lens' DataGaGet (Maybe DataGaGetOutput) Source #

The selected format for the response. Default format is JSON.

dggSort :: Lens' DataGaGet (Maybe Text) Source #

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

dggIncludeEmptyRows :: Lens' DataGaGet (Maybe Bool) Source #

The response will include empty rows if this parameter is set to true, the default is true

dggDimensions :: Lens' DataGaGet (Maybe Text) Source #

A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.

dggStartIndex :: Lens' DataGaGet (Maybe Int32) Source #

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

dggMaxResults :: Lens' DataGaGet (Maybe Int32) Source #

The maximum number of entries to include in this feed.

dggSegment :: Lens' DataGaGet (Maybe Text) Source #

An Analytics segment to be applied to data.

dggStartDate :: Lens' DataGaGet 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.