list_unsampled_reports: Lists unsampled reports which the user has access to

In jdeboer/RGA-1: A Google Analytics API Client

Description

Lists unsampled reports which the user has access to

Usage

list_unsampled_reports(account.id, webproperty.id, profile.id,
  start.index = NULL, max.results = NULL, token)

Arguments

account.id	integer or character. The account ID to retrieve unsampled reports for. Must be a specific account ID, ~all is not supported.
webproperty.id	character. Web property ID to retrieve unsampled reports for. Must be a specific web property ID, ~all is not supported. Requires specified account.id.
profile.id	ineger or character. View (Profile) ID to retrieve unsampled reports for. Must be a specific view (profile) ID, ~all is not supported. Requires specified account.id and webproperty.id.
start.index	integer. An index of the first unsampled report to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
max.results	integer. The maximum number of unsampled reports to include in this response.
token	Token2.0 class object with a valid authorization data.

Value

An unsampled report collection lists Analytics unsampled reports to which the user has access. Each view (profile) can have a set of unsampled reports. Each resource in the unsampled report collection corresponds to a single Analytics unsampled report.

id	Unsampled report ID.
title	Title of the unsampled report.
account.id	Account ID to which this unsampled report belongs.
webproperty.id	Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY.
profile.id	View (Profile) ID to which this unsampled report belongs.
start-date	The start date for the unsampled report.
end-date	The end date for the unsampled report.
metrics	The metrics for the unsampled report.
dimensions	The dimensions for the unsampled report.
filters	The filters for the unsampled report.
segment	The segment for the unsampled report.
status	Status of this unsampled report. Possible values are PENDING, COMPLETED, or FAILED.
download.type	The type of download you need to use for the report data file.
created	Time this unsampled report was created.
updated	Time this unsampled report was last modified.

References

Management API - Unsampled Reports

See Also

authorize

Other Management API: get_custom_dimension; get_custom_metric; get_experiment; get_filter; get_goal; get_profile; get_unsampled_report; get_webproperty; list_accounts; list_custom_dimensions; list_custom_metrics; list_custom_sources; list_experiments; list_filters; list_goals; list_profiles; list_segments; list_webproperties

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