Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

ON THIS PAGE

Response Description
Response Sample

GET /analytics/custom_actions/interpreters/{interpreter_id}

SUMMARY Retrieves a custom action interpreter based on supplied interpreter_id.

Retrieves a custom action interpreter based on supplied interpreter_id.

Table 1: GET /analytics/custom_actions/interpreters/{interpreter_id} resource details:
GET /analytics/custom_actions/interpreters/{interpreter_id} resource details
MIME Type
application/json

Table 2: GET /analytics/custom_actions/interpreters/{interpreter_id} request parameter details:
GET /analytics/custom_actions/interpreters/{interpreter_id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
interpreter_id	path	Required	Number (Integer)	text/plain	Number id of custom action interpreter to be retrieved.
fields	query	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3: GET /analytics/custom_actions/interpreters/{interpreter_id} response codes:
GET /analytics/custom_actions/interpreters/{interpreter_id} response codes
HTTP Response Code	Unique Code	Description
200		- The requested custom action interpreter has been retrieved.
404	1002	The requested custom action interpreter could not be found.
500	1020	An internal server error occurred while retrieving custom action interpreter with supplied interpreter_id.

Response Description

A custom action interpreter with the following fields:

id - Number - Unique ID of the custom action interpreter within the JSA deployment.
name - String - Name of the custom action interpreter.

Response Sample