Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

GET /analytics/custom_actions/scripts

SUMMARY Retrieves a list of meta-data for available custom action script files.

Retrieves a list of meta-data for available custom action script files.

Table 1: GET /analytics/custom_actions/scripts resource details:

GET /analytics/custom_actions/scripts resource details

MIME Type

application/json

Table 2: GET /analytics/custom_actions/scripts request parameter details:

GET /analytics/custom_actions/scripts request parameter details

Parameter Type Optionality Data Type MIME Type Description

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

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.

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

Table 3: GET /analytics/custom_actions/scripts response codes:

GET /analytics/custom_actions/scripts response codes

HTTP Response Code Unique Code Description

200

The requested custom action script file has been retrieved.

500

1020

An internal server error occurred while retrieving available custom action script file meta-data.

Response Description

Array of available custom action script file meta-data, each with the following fields:
  • id - Number - Unique ID of the custom action script file within the JSA deployment.
  • name - String - Name of the custom action script file.

Response Sample