Get current time to agent response (TAR)

get

https://{instance}.response.lithium.com/api/v2/bots/currentTAR

Retrieves the current Time to Agent Response (TAR)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Details

Retrieves the current Time to Agent Response (TAR) -- the delta between the time an original author’s post was pulled into Khoros Vare and the time of the agent’s response from Care. Specify a time range for which to collect data as a query parameter and optionally pass in other query parameters to filter the response by priority, work queues, response types, and smart views.

📘
Note
Smart view definitions that include priority and/or work queues will override priority and work queue IDs passed as specific query parameters in the same call.

Query Params

timeRangeInMillis

int64

required

(Required) The time range (in milliseconds) to collect TAR data. The time range starts from the time the call is made and runs back to the number of milliseconds passed. This is similar to selecting a Live range in the Analytics UI. Max value is one year (31556952000 milliseconds).

priorities

string

A comma-separated list of case priorities used to filter the TAR data. For example, passing '0,1,2' indicates to include only cases with priorities of 0,1, and 2.

workqueueIds

string

A comma-separated list of long workqueueIds used to filter the TAR data. For example, passing '1001,1002,2340' filters the data to include only those work queues.

responseType

string

Response types to query for. Supported values: 'FIRST' or 'SUBSEQUENT' (case-insensitive). Omitting the query parameter returns all response types. This query parameters is equivalent to the "Response Type" filter used in the Analytics UI when adding a Response widget to a dashboard.

smartViewId

int64

A single smart View ID by which to filter the TAR data.

If the smart view ID passed includes priority and/or work queue definitions, the priorities and work queues defined in the smart view will override values passed with priorities and workqueueIds parameters.

For example, suppose Smart View 102 includes priorities 0 and 5 and work queues 10,11, and, 12. Making a call with timeRangeInMillis=3600000&priorities=1,2,3&workqueueIds=1001,1002,1003&smartViewId=102 will result in data matching the definition defined for Smart View 102 only. The priorities and workqueueIds parameters will be ignored.

On the other hand, if smart view 102 defines a series of tags and has no definitions for priorities or work queues, then that same call would result in matching the tags from smart view 102 and filtering to priorities 1,2, and 3 in work queues 1001,1002, and 1003.

Responses

Details

📘Note

200200

400400

📘
Note