cja_get_dataviews {cjar}

Get data view ids

Description

This function will pull a list of data views ids that you have access to. These are similar to report suites in Adobe Analytics.

Usage

cja_get_dataviews(
  expansion = c("name"),
  parentDataGroupId = NULL,
  externalIds = NULL,
  externalParentIds = NULL,
  dataviewIds = NULL,
  includeType = NULL,
  cached = TRUE,
  limit = 1000,
  page = 0,
  sortDirection = "ASC",
  sortProperty = "id",
  debug = FALSE
)

Arguments

expansion

Comma-delimited list of additional fields to include on response. Options include: "name" "description" "owner" "isDeleted" "parentDataGroupId" "segmentList" "currentTimezoneOffset" "timezoneDesignator" "modified" "createdDate" "organization" "curationEnabled" "recentRecordedAccess" "sessionDefinition" "externalData" "containerNames"

parentDataGroupId

Filters data views by a single parentDataGroupId

externalIds

Comma-delimited list of external ids to limit the response with

externalParentIds

Comma-delimited list of external parent ids to limit the response with.

dataviewIds

Comma-delimited list of data view ids to limit the response with.

includeType

Include additional DataViews not owned by user. Options: "deleted"

cached

return cached results. TRUE (default) or FALSE

limit

number of results per page. 10 is default

page

Page number (base 0 - first page is 0). 0 is default

sortDirection

Sort direction ('ASC' (default) or DESC)

sortProperty

property to sort by (only modifiedDate and id are currently allowed). 'id' is default

debug

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

Details

Expansion available items: "name" "description" "owner" "isDeleted" "parentDataGroupId" "segmentList" "currentTimezoneOffset" "timezoneDesignator" "modified" "createdDate" "organization" "curationEnabled" "recentRecordedAccess" "sessionDefinition" "externalData" "containerNames"

Value

A data frame of dataview ids and their corresponding metadata

Examples

## Not run: 
cja_get_dataviews()

## End(Not run)