cja_get_metrics.Rd
Retrieves a list of metrics available in a specified dataview
cja_get_metrics(
dataviewId = Sys.getenv("CJA_DATAVIEW_ID"),
expansion = "description",
includeType = NULL,
locale = "en_US",
debug = FALSE
)
Required The id of the dataview for which to retrieve metrics. If an environment variable called CJA_DATAVIEW_ID
exists
in .Renviron
or elsewhere and no dataviewId
argument is provided, then the CJA_DATAVIEW_ID
value will
be used. Use cja_get_dataviews()
to get a list of available dataviewId
.
Comma-delimited list of additional segment metadata fields to include on response. See Details for all options available.
Include additional segments not owned by user. Options include: "shared" "templates" "deleted" "internal"
Locale - Default: "en_US"
Used to help troubleshoot api call issues. Shows the call and result in the console
A data frame of metrics in a specified dataview
Expansion options can include the following: "approved" "favorite" "tags" "usageSummary" "usageSummaryWithRelevancyScore" "description" "sourceFieldId" "segmentable" "required" "hideFromReporting" "hidden" "includeExcludeSetting" "fieldDefinition" "bucketingSetting" "noValueOptionsSetting" "defaultmetricsort" "persistenceSetting" "storageId" "tableName" "dataSetIds" "dataSetType" "type" "schemaPath" "hasData" "sourceFieldName" "schemaType" "sourceFieldType" "fromGlobalLookup" "multiValued" "precision"
if (FALSE) {
cja_get_metrics(dataviewId = "dv_5f4f1e2572ea0000003ce262")
}