Skip to end of metadata
Go to start of metadata

The API Viewer

This tool has been deprecated. It is not available as of v2.0 Console products.

The API Viewer allows you to view and explore the API calls made by the Console UI. You can record API calls step by step, allowing you to mimic or automate Console workflows.

On This Page

Opening the API Viewer

To enable the viewer, click the Open API Viewer link in the bottom menu of any Console page or press Ctrl + Alt + a on your keyboard.

The API Viewer will remain on until you disable it, or until you clear your cookies.

If the viewer was disabled on page load, the console will not be able to show any data about the page load, unless you refresh that page. However, it will show you data from any subsequent AJAX calls.

Closing the API Viewer

To disable the API Viewer, first open it, then click the Disable Debugging link.

Once enabled, the API Viewer will remain enabled until you disable it. Impact on performance is generally minimal.

Page Load and AJAX Views

The API Viewer has two main modes of browsing: Page Load View and AJAX View.

Page Load View

Click Page Load to view API calls that were made while the current page was loading. Click the hyperlinks on the left side of the API Viewer to examine several different types of data.

Due to the dynamic nature of Console, some information is not available in this view; use the AJAX View to see more detailed information.

Timeline

Click the Timeline link to see information about how much time (shown in milliseconds in the Details column) it takes for each phase of the page load to take place. Click any segment of the timeline to zoom in on that segment and display the events that occurred during that segment. You can continue to drill down through each event to determine the time for each segment and sub-segment of the timeline.

API Viewer

Not active in the Page Load view; available in the AJAX View.

events

Displays a tree view of events that occurred during the loading of this page. Click the triangles to expand any node of the tree to see additional information.

api_calls

Displays a tree view of API calls made during the loading of this page, if any. Click the triangles to expand any node of the tree to see additional information.

api_debug

Displays the debug view of API calls made during the loading of this page, if any. Click the triangles to expand any node of the tree to see additional information.

errors

Displays a tree view of errors that occurred during the loading of this page, if any. Click the triangles to expand any node of the tree to see additional information.

_getAllParams()

Displays a list of all parameters loaded with this page.

$_POST

Displays the variables passed in a POST operation, if applicable.

$_GET

Displays the variables passed in a GET operation, if applicable.

Displays the current user cookie.

$_SERVER

Displays information about the currently-connected server.

view_params

DIsplays information about the parameters that were used to build the unique view for this page.

instance

Displays information about the current server instance.

duration_php

Displays the amount of time the page load took (in seconds).

AJAX View

When successful AJAX (Asynchronous JavaScript and XML) requests are made, the API Viewer adds an item to the AJAX dropdown menu. Requests are listed in the order in which they were made and include any API calls made after page load. To save browser memory, the API Viewer stores only the last 10 AJAX requests.

Timeline

Click Timeline to see information about how much time (shown in milliseconds in the Details column) it takes for each phase of the selected AJAX request to occur. Click any segment of the timeline to zoom in on that segment and display the events that occurred during that segment. You can continue to drill down through each event to determine the time for each segment and sub-segment of the timeline.

API Viewer

Click API Viewer to see basic information about the selected request. Click All Data to display all the data about the request.

Method: The HTTP method that was used. This will be one of: GET (retrieval), POST (creation), PUT (modification), or DELETE (deletion). Refer to the API Semantics for more information.

URL: This is the URL of the API that was called. For GET and DELETE requests, the query string is removed and displayed in the Data column.

Data: For POST or PUT calls, this is the raw data that was sent to the API, formatted in JSON.  This data contains information about the object created by the request. Click view json... to further explore this data. For GET and DELETE calls no raw data is sent – this data is contained in the query string. In these cases, a formatted version of the query string will be displayed.

Response: This shows the approximate size of the JSON data received from the API. The response contains the status of the call (success or failure), as well as any error messages and the number of objects retrieved. To explore this data, click view json...

API Time / Tx Time: API Time measures how long the API took to process the request. Tx (Transfer) Time measures how long the full request took, minus how long the API took to process the request. This is the round-trip latency / transfer time.

api_calls

Displays a tree view of the request. Click the triangles to expand any node of the tree to see additional information.

server_debug

Displays the full server debug view of the API call. Click the triangles to expand any node of the tree to see additional information.

name

Displays the name of the request. This is the same as the name currently selected in the dropdown list.

events

Displays the events that occurred with this request. Click the triangles to expand any node of the tree to see additional information.

full_response

Displays the complete JSON response object returned by the server for this request. Click the triangles to expand any node of the tree to see additional information.

request_data

Displays the JSON data sent in this request. Click the triangles to expand any node of the tree to see additional information.

curl

Displays the equivalent curl-formatted request for this AJAX request. You can copy and paste this command to replicate the current request via the API.

  • No labels