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.Webmasters.Searchanalytics.Query

Contents

REST Resource
Creating a Request
Request Lenses

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))))))) #

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

Creating a Request

searchanalyticsQuery #

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:

sqSiteURL
sqPayload

data SearchanalyticsQuery #

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 #
Methods (==) :: SearchanalyticsQuery -> SearchanalyticsQuery -> Bool # (/=) :: SearchanalyticsQuery -> SearchanalyticsQuery -> Bool #
Data SearchanalyticsQuery #
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 #
Methods showsPrec :: Int -> SearchanalyticsQuery -> ShowS # show :: SearchanalyticsQuery -> String # showList :: [SearchanalyticsQuery] -> ShowS #
Generic SearchanalyticsQuery #
Associated Types type Rep SearchanalyticsQuery :: * -> * # Methods from :: SearchanalyticsQuery -> Rep SearchanalyticsQuery x # to :: Rep SearchanalyticsQuery x -> SearchanalyticsQuery #
GoogleRequest SearchanalyticsQuery #
Associated Types type Rs SearchanalyticsQuery :: * # type Scopes SearchanalyticsQuery :: [Symbol] # Methods requestClient :: SearchanalyticsQuery -> Client (Rs SearchanalyticsQuery) #
type Rep SearchanalyticsQuery #
type Rep SearchanalyticsQuery = D1 (MetaData "SearchanalyticsQuery" "Network.Google.Resource.Webmasters.Searchanalytics.Query" "gogol-webmaster-tools-0.3.0-IwhjJAKumUr6xIq8Oik1Zg" False) (C1 (MetaCons "SearchanalyticsQuery'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_sqSiteURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_sqPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SearchAnalyticsQueryRequest))))
type Scopes SearchanalyticsQuery #
type Scopes SearchanalyticsQuery = (:) Symbol "https://www.googleapis.com/auth/webmasters" ((:) Symbol "https://www.googleapis.com/auth/webmasters.readonly" ([] Symbol))
type Rs SearchanalyticsQuery #
type Rs SearchanalyticsQuery = SearchAnalyticsQueryResponse

Request Lenses

sqSiteURL :: Lens' SearchanalyticsQuery Text #

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

sqPayload :: Lens' SearchanalyticsQuery SearchAnalyticsQueryRequest #

Multipart request metadata.