get_ga: Get the Anaytics data from Core Reporting API for a view...

Description Usage Arguments Value References See Also Examples

Description

Get the Anaytics data from Core Reporting API for a view (profile)

Usage

1
2
3
4
get_ga(profile.id, start.date = "7daysAgo", end.date = "yesterday",
  metrics = "ga:users,ga:sessions,ga:pageviews", dimensions = NULL,
  sort = NULL, filters = NULL, segment = NULL, sampling.level = NULL,
  start.index = NULL, max.results = NULL, token)

Arguments

profile.id

integer or character. Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. Can be obtained using the list_profiles or via the web interface Google Analytics.

start.date

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

end.date

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

metrics

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

dimensions

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

sort

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

filters

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

segment

character. An Analytics segment to be applied to data. Can be obtained using the list_segments or via the web interface Google Analytics.

sampling.level

character. The desired sampling level. Allowed values: "default", "faster", "higher_precision".

start.index

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

max.results

integer. The maximum number of entries to include in this feed.

token

Token2.0 class object with a valid authorization data.

Value

A data frame including the Analytics data for a view (profile). Addition information about profile and request query stored in the attributes.

References

Core Reporting API - Dimensions & Metrics Reference

Core Reporting API - Query Parameter Details

Core Reporting API - Common Queries

Google Analytics Demos & Tools - Query Explorer

See Also

authorize list_dimsmets

Other Reporting API: firstdate; get_mcf; get_realtime, get_rt

Examples

1
2
3
4
5
6
7
8
9
## Not run: 
# get token data
authorize()
# get report data
ga_data <- get_ga("profile_id", start.date = "30daysAgo", end.date = "today",
                  metrics = "ga:sessions", dimensions = "ga:source,ga:medium",
                  sort = "-ga:sessions")

## End(Not run)

jdeboer/RGA-1 documentation built on May 18, 2019, 11:29 p.m.