tickets_csv: Save a list of Tickets to a csv file

In jjanuszczak/freshdeskr: An R Client for the Freshdesk API

Description

tickets queries the Freshdesk API, saves a list of tickets to a file and returns a data frame of ticke data.

Usage

tickets_csv(client, file, tickets_path = "/api/v2/tickets",
  remove_fields = c("description", "description_text"),
  include_requester = FALSE, include_stats = FALSE,
  include_custom_fields = FALSE, updated_since = NULL, max_records = Inf)

Arguments

client	The Freshdesk API client object (see freshdesk_client).
file	The csv file path to which the tickets data will be saved.
tickets_path	The path of the tickets API. Defaults to /api/v2/tickets. You should not need to change the default value.
remove_fields	Fields returned by the Freshdesk API to remove from the data frame. Defaults to removing the description and description_text fields which could be quite verbose.
include_requester	If TRUE returns additional attributes of the requester.
include_stats	If TRUE returns additional attributes of the status.
include_custom_fields	If TRUE customer fields will be included in the results.
updated_since	Specifies tickets to include in results based on last time they were updated. If set to NULL, only tickets updated in the last 30 days are returned. The value can be a Date object or a character string in the format YYYY-MM-DD.
max_records	Specifies the maximum number of records to return. If the number of records specified is less then 30, up to 30 records will be returned by default if they exist.

Details

This function queries the Freshdesk API to view and save the details regarding multiple tickets to a csv file.

Value

A data frame of tickets.

Examples

## Not run: 
fc <- freshdesk_client("your-domain", "your-api-key")

# view tickets
t <- tickets_csv(fc)

## End(Not run)

jjanuszczak/freshdeskr documentation built on May 29, 2019, 11:05 p.m.