freshdesk_api_call: Calls Freshdesk API

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

Description

freshdesk_api_call makes a single query the Freshdesk API and returns a result.

Usage

freshdesk_api_call(client, path, query = NULL)

Arguments

client	The Freshdesk API client object (see freshdesk_client).
path	The API query path.
query	API query string.

Details

This function queries the Freshdesk API based on a path and returns a freshdesk_api object containing the http response, the parsed content, and the API rate limit status.

Value

An S3 object contaitning the following attributes:

• content: the parsed content of the response.

• path: the API query path.

• response: the complete httr reponse object.

• rate_limit_remaining: the API calls remaining in the current period.

• rate_limit_total: the total API calls for the current period.

Examples

## Not run: 
fc <- freshdesk_client("foo", "MyAPIKey")
apidata <- freshdesk_api(fc, "/api/v2/tickets/3")
apidata$rate_limit_remaining

## End(Not run)

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