seg_val: Validate a segment in adobe analytics

View source: R/segment_validate.R

seg_valR Documentation

Validate a segment in adobe analytics

Description

Returns a segment validation response for a segment contained in a json string object.

Usage

seg_val(
  segment_body = NULL,
  rsid = Sys.getenv("AW_REPORTSUITE_ID"),
  debug = FALSE,
  company_id = Sys.getenv("AW_COMPANY_ID")
)

Arguments

segment_body

The json string of the segment that is being validated (required)

rsid

Adobe report suite ID (RSID). If an environment variable called AW_REPORTSUITE_ID exists in .Renviron or elsewhere and no rsid argument is provided, then the AW_REPORTSUITE_ID value will be used. Use aw_get_reportsuites() to get a list of available rsid values.

debug

This enables the api call information to show in the console for help with debugging issues. default is FALSE

company_id

Company ID. If an environment variable called AW_COMPANY_ID exists in .Renviron or elsewhere and no company_id argument is provided, then the AW_COMPANY_ID value will be used. Use get_me() to get a list of available company_id values.

Value

If the segment is valid a message saying the segment validates is returned. If the segment doesn't validate the errors are returned in a data frame.


adobeanalyticsr documentation built on Oct. 18, 2022, 5:06 p.m.