list_unsampled_reports: Unsampled Reports

Description Usage Arguments Value References See Also

View source: R/unsampledReports.R

Description

Lists unsampled reports to which the user has access.

Usage

1
2
list_unsampled_reports(accountId, webPropertyId, profileId,
  start.index = NULL, max.results = NULL, token)

Arguments

accountId

character. Account ID to retrieve unsampled reports for. Must be a specific account ID, ~all is not supported.

webPropertyId

character. Web property ID to retrieve unsampled reports for. Must be a specific web property ID, ~all is not supported.

profileId

character. View (Profile) ID to retrieve unsampled reports for. Must be a specific view (profile) ID, ~all is not supported.

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

id

Unsampled report ID.

kind

Resource type for an Analytics unsampled report.

title

Title of the unsampled report.

accountId

Account ID to which this unsampled report belongs.

webPropertyId

Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY.

profileId

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.

downloadType

The type of download you need to use for the report data file.

driveDownloadDetails

Download details for a file stored in Google Drive.

cloudStorageDownloadDetails

Download details for a file stored in Google Cloud Storage.

created

Time this unsampled report was created.

updated

Time this unsampled report was last modified.

driveDownloadDetails.documentId

Id of the document/file containing the report data.

cloudStorageDownloadDetails.bucketId

Id of the bucket the file object is stored in.

cloudStorageDownloadDetails.objectId

Id of the file object containing the report data.

References

Management API - Unsampled Reports Overview

See Also

Other Management API: get_custom_dimension, get_custom_metric, get_experiment, get_filter, get_goal, get_profile, get_unsampled_report, get_upload, get_webproperty, list_accounts, list_custom_data_sources, list_custom_dimensions, list_custom_metrics, list_experiments, list_filters, list_goals, list_profiles, list_segments, list_uploads, list_webproperties


RGA documentation built on May 2, 2019, 6:47 a.m.