cjar (version 0.2.0)

cja_get_filter: Get a filter in CJA

Description

Retrieves a specific filter, also known as a segment in Adobe Analytics.

Usage

cja_get_filter(
  id = NULL,
  toBeUsedInRsid = NULL,
  locale = "en_US",
  expansion = "definition",
  debug = FALSE
)

Value

A filter list

Arguments

id

The filter id to retrieve

toBeUsedInRsid

The data view where the filter is intended to be used. This data view will be used to determine things like compatibility and permissions.

locale

Locale - Default: "en_US"

expansion

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

debug

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

Details

Expansion options can include the following: "compatibility", "definition", "internal", "modified", "isDeleted", "definitionLastModified", "createdDate", "recentRecordedAccess", "performanceScore", "owner", "dataId", "ownerFullName", "dataName", "sharesFullName", "approved", "favorite", "shares", "tags", "usageSummary", "usageSummaryWithRelevancyScore"

Examples

if (FALSE) {
cja_get_filter()
}