getReport: Function for getting report from Infinity API

View source: R/getReport.R

getReportR Documentation

Function for getting report from Infinity API

Description

Function for getting report from Infinity API

Usage

getReport(url, username, password, pagination = FALSE)

Arguments

url

URL for getting data. See buildUrl

username

Username, string

password

Password, string

pagination

Results from the Infinity API are restricted to a maximum of number of rows per request. This maximum number is typically 10,000 and if you specify a higher limit value the API will return an error. For getting of all records parameter pagination = TRUE. If the number of rows in result data frame will be less than 10,000 than pagination doesn't used.

Examples

## Not run: 
# Create list of parameters
params <- triggerInit(igrp = 840,
                     trigger = "calls",
                     limit = 10500,
                     sort = "triggerDatetime-desc"
                     display = c("triggerDatetime",
                                 "srcPhoneNumber",
                                 "callState",
                                 "txr",
                                 "destPhoneNumber",
                                 "ringTime"))
# Build URL for getting report
 url <- buildUrl(params)

# Getting report from Infinity API to data frame
 df <- getReport(url, "username", "password", pagination = TRUE)

## End(Not run)


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