RGA (version 0.4.2)

get_mcf: Multi-Channel Funnels Reporting API

Description

Get the Anaytics data from Multi-Channel Funnels Reporting API for a view (profile).

Usage

get_mcf(profileId = getOption("rga.profileId"), start.date = "7daysAgo", end.date = "yesterday", metrics = "mcf:totalConversions", dimensions = NULL, sort = NULL, filters = NULL, samplingLevel = NULL, start.index = NULL, max.results = NULL, fetch.by = NULL, token)

Arguments

profileId

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 a 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 an 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 Multi-Channel Funnels metrics. E.g., "mcf:totalConversions,mcf:totalConversionValue". At least one metric must be specified.

dimensions

character. A comma-separated list of Multi-Channel Funnels dimensions. E.g., "mcf:source,mcf:medium".

sort

character. 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.

samplingLevel

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.

fetch.by

character. Split the query by date range. Allowed values: "day", "week", "month", "quarter", "year". It does not work correctly with the ga:users and ga:NdayUsers metrics.

token

Token2.0 class object with a valid authorization data.

Value

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

References

MCF Reporting API - Dimensions & Metrics Reference

MCF Reporting API - Query Parameter Details

See Also

Other Reporting API: firstdate, get_ga, get_realtime

Examples

## Not run: 
# # get token data
# authorize()
# # get report data
# ga_data <- get_mcf(XXXXXXX, start.date = "30daysAgo", end.date = "today",
#                    metrics = "mcf:totalConversions",
#                    dimensions = "mcf:source,mcf:medium")
# ## End(Not run)