cja_get_metrics {cjar}

Get a list of metrics in CJA

Description

Retrieves a list of metrics available in a specified dataview

Usage

cja_get_metrics(
  dataviewId = Sys.getenv("CJA_DATAVIEW_ID"),
  expansion = "description",
  includeType = NULL,
  locale = "en_US",
  debug = FALSE
)

Arguments

dataviewId

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.

expansion

Comma-delimited list of additional segment metadata fields to include on response. See Details for all options available.

includeType

Include additional segments not owned by user. Options include: "shared" "templates" "deleted" "internal"

locale

Locale - Default: "en_US"

debug

Used to help troubleshoot api call issues. Shows the call and result in the console

Details

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"

Value

A data frame of metrics in a specified dataview

Examples

## Not run: 
cja_get_metrics(dataviewId = "dv_5f4f1e2572ea0000003ce262")

## End(Not run)