agents: View a list of Agents

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

Description

tickets queries the Freshdesk API and returns a data frame of agent data.

Usage

agents(client, agents_path = "/api/v2/agents", max_records = Inf,
  ticket_scope_lookup = agent_ticket_scope, date_fields = agent_date_fields)

Arguments

client	The Freshdesk API client object (see freshdesk_client).
agents_path	The path of the agents API. Defaults to /api/v2/agents. You should not need to change the default value.
max_records	Specifies the maximum number of records to return.
ticket_scope_lookup	Optional dataframe of ticket scope and associated values. Defaults to agent_ticket_scope which is defined in the package.
date_fields	Fields returned by the Freshdesk API that are date fields. Defaults to agent_date_fields which is defined in the package.

Details

This function queries the Freshdesk API to view the details regarding multiple agents

Value

A data frame of agents or NULL if there are no agents.

Examples

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

# view agents
a <- agents(fc)

## End(Not run)

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