triggerInit: Collect request parameters

In ETikalenko/Infinity: Package for getting call tracking reports from Infinity API

Collect request parameters

Description

Function collects all request parameters in one list for passing to function buildUrl

Usage

triggerInit(igrp = NULL, trigger = NULL, limit = NULL, offset = NULL,
  sort = NULL, filter = NULL, startDate = NULL, endDate = NULL,
  tz = NULL, display = NULL, attributionModelId = NULL,
  nestAttributions = NULL)

Arguments

igrp	(int) Installation ID
trigger	- (string) A trigger represents a single tracked event in Infinity. Possible values: all - Get all triggers calls - Get all call triggers ( where trigger action is call ) calls/users - Get all Hosted PBX Call User triggers ( where trigger action is callUser ) callStatus - Get all call status triggers ( where trigger action is callBlegStart or callAlegStop ) goals - Get all goal triggers ( where trigger is marked as a goal ) transactions - Get all transaction triggers ( where trigger has transaction currency or goal currency fields )#' callRate triggers are excluded from these reports callsGoalsTransactions - Get all triggers with any transaction, call or goal details. This is a union of the three routes "calls", "goals" and "transactions" described above touchPoints - Get all touch point triggers. This is a collection of recent land, call and goal triggers. You can only query back as far as your Installation's trigger retention period on this route
limit	(int) Limit result set.
offset	(int) Offset result set.
sort	(array) One or more sorts. String or vector of strings.
filter	(array) Optional. One or more filters. String or vector of strings.
startDate	(string) Optional. Start Date to filter by, Start Date must be of the format YYYY-MM-DD.
endDate	(string) Optional. End Date to filter by, End Date must be of the format YYYY-MM-DD.
tz	(string) Optional. Timezone to convert to.
display	(array) Optional. One ore more fields to display in report. String or vector of strings.
attributionModelId	(int) Optional. Attribution Model ID to use for report. Can be 'none' to remove attribution data from report.
nestAttributions	(int) Optional. Enables/Disables nested multiple attribution output. If disabled will return multiple rows per trigger for each attributed land.

Value

List of parameters required for getting reports

See Also

Full description of filter and sort fields can be found at https://www.infinitycloud.com/service/api/reports_v2_triggers.html

Examples

## Not run: 
params <- triggerInit(igrp = 840,
                     trigger = "calls",
                     limit = 50,
                     sort = "triggerDatetime-desc",
                     display = c("triggerDatetime",
                                 "srcPhoneNumber",
                                 "callState",
                                 "txr",
                                 "destPhoneNumber",
                                 "ringTime"))

## End(Not run)

ETikalenko/Infinity documentation built on Aug. 14, 2022, 6:44 p.m.