gogol-webmaster-tools-0.4.0: Google Search Console SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Webmasters.Searchanalytics.Query

Contents

Description

Query your data with filters and parameters that you define. Returns zero or more rows grouped by the row keys that you define. You must define a date range of one or more days. When date is one of the group by values, any days without data are omitted from the result list. If you need to know which days have data, issue a broad date range query grouped by date for any metric, and see which day rows are returned.

See: Search Console API Reference for webmasters.searchanalytics.query.

Synopsis

REST Resource

type SearchanalyticsQueryResource = "webmasters" :> ("v3" :> ("sites" :> (Capture "siteUrl" Text :> ("searchAnalytics" :> ("query" :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] SearchAnalyticsQueryRequest :> Post '[JSON] SearchAnalyticsQueryResponse))))))) Source #

A resource alias for webmasters.searchanalytics.query method which the SearchanalyticsQuery request conforms to.

Creating a Request

searchanalyticsQuery Source #

Arguments

:: Text

sqSiteURL

-> SearchAnalyticsQueryRequest

sqPayload

-> SearchanalyticsQuery 

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

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

data SearchanalyticsQuery Source #

Query your data with filters and parameters that you define. Returns zero or more rows grouped by the row keys that you define. You must define a date range of one or more days. When date is one of the group by values, any days without data are omitted from the result list. If you need to know which days have data, issue a broad date range query grouped by date for any metric, and see which day rows are returned.

See: searchanalyticsQuery smart constructor.

Instances
Eq SearchanalyticsQuery Source # 
Instance details

Defined in Network.Google.Resource.Webmasters.Searchanalytics.Query

Methods

(==) :: SearchanalyticsQuery -> SearchanalyticsQuery -> Bool #

(/=) :: SearchanalyticsQuery -> SearchanalyticsQuery -> Bool #

Data SearchanalyticsQuery Source # 
Instance details

Defined in Network.Google.Resource.Webmasters.Searchanalytics.Query

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SearchanalyticsQuery -> c SearchanalyticsQuery #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SearchanalyticsQuery #

toConstr :: SearchanalyticsQuery -> Constr #

dataTypeOf :: SearchanalyticsQuery -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SearchanalyticsQuery) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SearchanalyticsQuery) #

gmapT :: (forall b. Data b => b -> b) -> SearchanalyticsQuery -> SearchanalyticsQuery #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SearchanalyticsQuery -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SearchanalyticsQuery -> r #

gmapQ :: (forall d. Data d => d -> u) -> SearchanalyticsQuery -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SearchanalyticsQuery -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SearchanalyticsQuery -> m SearchanalyticsQuery #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchanalyticsQuery -> m SearchanalyticsQuery #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchanalyticsQuery -> m SearchanalyticsQuery #

Show SearchanalyticsQuery Source # 
Instance details

Defined in Network.Google.Resource.Webmasters.Searchanalytics.Query

Methods

showsPrec :: Int -> SearchanalyticsQuery -> ShowS #

show :: SearchanalyticsQuery -> String #

showList :: [SearchanalyticsQuery] -> ShowS #

Generic SearchanalyticsQuery Source # 
Instance details

Defined in Network.Google.Resource.Webmasters.Searchanalytics.Query

Associated Types

type Rep SearchanalyticsQuery :: Type -> Type #

Methods

from :: SearchanalyticsQuery -> Rep SearchanalyticsQuery x #

to :: Rep SearchanalyticsQuery x -> SearchanalyticsQuery #

GoogleRequest SearchanalyticsQuery Source # 
Instance details

Defined in Network.Google.Resource.Webmasters.Searchanalytics.Query

Associated Types

type Rs SearchanalyticsQuery :: Type #

type Scopes SearchanalyticsQuery :: [Symbol] #

Methods

requestClient :: SearchanalyticsQuery -> GClient (Rs SearchanalyticsQuery) #

type Rep SearchanalyticsQuery Source # 
Instance details

Defined in Network.Google.Resource.Webmasters.Searchanalytics.Query

type Rep SearchanalyticsQuery = D1 (MetaData "SearchanalyticsQuery" "Network.Google.Resource.Webmasters.Searchanalytics.Query" "gogol-webmaster-tools-0.4.0-LKq04HhuGk13qpGnIbIn8X" False) (C1 (MetaCons "SearchanalyticsQuery'" PrefixI True) (S1 (MetaSel (Just "_sqSiteURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_sqPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SearchAnalyticsQueryRequest)))
type Scopes SearchanalyticsQuery Source # 
Instance details

Defined in Network.Google.Resource.Webmasters.Searchanalytics.Query

type Scopes SearchanalyticsQuery = "https://www.googleapis.com/auth/webmasters" ': ("https://www.googleapis.com/auth/webmasters.readonly" ': ([] :: [Symbol]))
type Rs SearchanalyticsQuery Source # 
Instance details

Defined in Network.Google.Resource.Webmasters.Searchanalytics.Query

type Rs SearchanalyticsQuery = SearchAnalyticsQueryResponse

Request Lenses

sqSiteURL :: Lens' SearchanalyticsQuery Text Source #

The site's URL, including protocol. For example: http://www.example.com/

sqPayload :: Lens' SearchanalyticsQuery SearchAnalyticsQueryRequest Source #

Multipart request metadata.