search
About CoherentAPI referenceSupportYouTube

API Call History

Spark stores all the API calls made to the Spark services. The API Call History can be used to display information about individual API calls and downloading subsets of API calls.

To access this feature, after choosing a specific service from Folder overview, choose the API Call History icon from the service sidebar.

hashtag
View and filter API calls

The API Call History page shows the list of all the API calls made to a Spark service.

  • By default all service versions are shown by descending descending Log Time.

  • The API calls can be further filtered by choosing a service version and/or using the log time.

  • Search for specific records by Call ID, Call Purpose, Correlation ID, Source System, Username.

    • Call Purpose, Correlation ID, and Source System are fields that can be included into the request_meta when making a call to the Spark API. It allows the system making the call to include some identifiers that can be reviewed through the API Call History.

  • Search for API calls that may have errors or warnings.

hashtag
Review an individual API call

hashtag
View the detailed log of the API call

Administrators may want to interrogate the specifics of an API call for diagnosis. In the "three-dot menu", choose Detailed log.

The Detailed log will display information about the API call including the Request body and Response body.

hashtag
Download the Excel file with inputs

triangle-exclamation

If multiple Xinputs in the file overlap and refer to the same range, this may lead to unexpected behaviors for this functionality.

Business users may want to review the specifics of an API call in Excel to review the calculation. A copy of the Excel file can be downloaded in the "three-dot menu", choose Download as Excel.

  1. Spark input ranges such as Xinput will be populated with the fields from the API request. If a field is not provided and the default is used, the default will be populated instead of the API call input.

  2. Spark output ranges such as Xoutput will not be populated with the fields from the API response. This is because the original formulas should not be overwritten.

There are multiple options for Download as Excel file:

  • Download as Excel file users our latest technology which is faster and has better support for dynamic array functions such as Using CS.SPARK_XCALL() UDF.

  • Download as Excel file (Legacy) uses our previous implementation. The resulting Excel file includes a cover worksheet to describe the originating Spark service. There may be some inconsistencies compared to the newer implementation which has additional updates.

hashtag
Run in API Tester

The inputs from the particular API call can be sent to the API Tester to make it easier to repeat an API call again.

hashtag
Download the API Call History

A flat file containing the API Call History can be useful for regression and analysis.

  1. View and filter API calls to identify the relevant API calls.

  2. A further subset of the API calls can be selected using the checkboxes.

  3. Click the Download all API calls button.

  4. There will be different download options available.

  5. The resulting file will include the exact inputs/outputs that were used for the selected API calls.

    • The downloaded results file can be used as a testbed in the Testing Center, see Create new testbed.

Last updated