| Copyright | (c) 2015 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
Description
Returns Analytics data for a view (profile).
See: Google Analytics API Reference for analytics.data.ga.get.
- 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 "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)
- 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
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 "dimensions" Text :> (QueryParam "start-index" (Textual Int32) :> (QueryParam "max-results" (Textual Int32) :> (QueryParam "segment" Text :> (QueryParam "alt" AltJSON :> Get `[JSON]` GaData)))))))))))))))) Source
A resource alias for analytics.data.ga.get method which the
DataGaGet request conforms to.
Creating a Request
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:
Returns Analytics data for a view (profile).
See: dataGaGet smart constructor.
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.
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.
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.