Editing Existing WS APIs

Use the API editor to add or edit Requests and Variables for an existing or newly defined API.

Select Custom Data Sources \ RESTful Web Services \ Request Builder from the Analytics home screen. A list of WS APIs displays like so:

Click on an API in the list to display any Variables or Requests defined for the API (this will be blank for APIs defined during the creation of a new connection).

Using this display you can perform the following:

  • Edit existing Variables and Requests. Simply click on at item to open the editor for that item. These edit screens can be reviewed in the Editing Requests and Editing Variables sections.
  • Use the Add button to create new requests and variables for the API (see Adding Variables and Adding Requests for more information).

Other options are available in the Actions menu to the right of each Variable or Request (described below).

Show (API) Actions

Each Variable or Request has an Actions Menu used to access the following options.

Variables

Edit

Use this option to edit a Variable for the API. See Editing Variables for details.

Duplicate

Use this option to create a duplicate copy of any existing Variable.

  1. Press the Show Actions button and select the Duplicate option. The Duplicate Variable panel opens.

  2. Overwrite the suggested name (or not), and press the Duplicate button .

    The new duplicated Variable will appear in the variable list.

Delete

Use this option to delete an existing Variable.

  1. Press the Show Actions button and select the Delete option.

    The Delete screen displays to confirm your request or cancel.

  2. Press the Delete button .

Close

Press to close the Show Actions list.

Requests

Edit

Use this option to edit a Request for the API. See Editing Requests for details.

Duplicate

Use this option to create a duplicate copy of any existing Request.

  1. Press the Show Actions button and select the Duplicate option.

    The Duplicate Request panel opens.

  2. Overwrite the suggested name (or not), and press the Duplicate button .

    The new duplicated Request will appear in the request list.

Download

Use this option to create and download the API results as a .CSV file.

  1. Press the Show Actions button and select the Download option.

    The Download CSV File screen displays.

  2. Give the file a name and press Download to create the file.

Description File

Use this option to create a text file containing the description of the API Request.

  1. Press the Show Actions button and select the Description File option.

  2. The browser will prompt with options to open or save the file.

Delete

Use this option to delete an existing Request.

  1. Press the Show Actions button and select the Delete option.

    The Delete screen displays to confirm your request or cancel.

  2. Press the Delete button .

Close

Press to close the Show Actions list.

 

Related Topics