suso_getINT_log: Survey Solutions API call for audit log on interviewers

In michael-cw/SurveySolutionsAPI: Comprehensive API access to your Survey Solutions Server

Survey Solutions API call for audit log on interviewers

Description

Get log of interviewer

Usage

suso_getINT_log(
  url = suso_get_api_key("susoServer"),
  usr = suso_get_api_key("susoUser"),
  pass = suso_get_api_key("susoPass"),
  int_id = NULL,
  workspace = NULL,
  token = NULL,
  startDate = NULL,
  endDate = NULL
)

Arguments

url	Survey Solutions server address
usr	Survey Solutions API user
pass	Survey Solutions API password
int_id	interviewer id
workspace	If workspace name is provide requests are made regarding this specific workspace, if no workspace is provided defaults to primary workspace
token	If Survey Solutions server token is provided usr and pass will be ignored
startDate	Start data for the period of interest, date must be provided as character in the format: YYYY-MM-DD, and will start at 00:00.00 server time of the specified day
endDate	End date for the period of interest, date must be provided ascharacter in the format: YYYY-MM-DD, and will end at 23:59:59 server time of the specified day. If not end date is provided, the current date will be used.

Examples

## Not run: 
# without start or end date, the last 7 days of log file will be shown
suso_getINT_log(
          workspace = "myworkspace",
          int_id = "xxxx-xxxx-xxxx-xxx"
          )
# if you want to extent this period beyond the 7 days, just provide a start date
suso_getINT_log(
          workspace = "myworkspace",
          int_id = "xxxx-xxxx-xxxx-xxx",
          startDate = "2023-01-01"
          )
# or if you want it for a specific period, provide start and end date
suso_getINT_log(
          workspace = "myworkspace",
          int_id = "xxxx-xxxx-xxxx-xxx",
          startDate = "2023-01-01",
          endDate = "2023-02-01"
          )
# if you provide both, start and end date for the same day, you will receive
# all data for said day, from midnight until the 23:59:59
suso_getINT_log(
          workspace = "myworkspace",
          int_id = "xxxx-xxxx-xxxx-xxx",
          startDate = "2023-02-14",
          endDate = "2023-02-14")

## End(Not run)

michael-cw/SurveySolutionsAPI documentation built on Jan. 14, 2024, 2:58 a.m.