ticket: View a Ticket

Description Usage Arguments Details Value Examples

Description

ticket queries the Freshdesk API and returns data related to a ticket.

Usage

1
2
3
4
ticket(client, ticket_id, tickets_path = "/api/v2/tickets", include = NULL,
  valid_include_parameters = ticket_include_parameters,
  priorities_lookup = ticket_priorities, sources_lookup = ticket_sources,
  status_lookup = ticket_status)

Arguments

client

The Freshdesk API client object (see freshdesk_client).

ticket_id

The ID of the ticket you would like to view.

tickets_path

The path of the tickets API. Defaults to /api/v2/tickets. You should not need to change the default value.

include

Optional include a vector of query string parameters.

valid_include_parameters

Optional vector of valid include parameters. Defaults to ticket_include_parameters which is defined in the package.

priorities_lookup

Optional dataframe of ticket priorities and associated values. Defaults to ticket_priorities which is defined in the package.

sources_lookup

Optional dataframe of ticket sources and associated values. Defaults to ticket_sources which is defined in the package.

status_lookup

Optional dataframe of ticket status and associated values. Defaults to ticket_status which is defined in the package.

Details

This function queries the Freshdesk API based on ticket id to view the details regarding this ticket. You can optionally include conversation, requester, company or extra stats data.

Value

A list with the attributes of the ticket.

Examples

1
2
3
4
5
6
7
## Not run: 
fc <- freshdesk_client("your-domain", "your-api-key")

# view ticket with id = 3 and include addtional company and requester data
t <- ticket(fc, 3, include = "requester,company")

## End(Not run)

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