Calling the GetAvailableReports Method in the Surpass Web API

Note: Version 2 of the Surpass API is now available. For any customers not already using API v1, please refer to the API v2 Developer Portal.

The GetAvailableReports web method in the Surpass API returns all of the standard Surpass reports available. This will return all of the information required to call the GetReport web method.

GetAvailableReports


GET api/v1/Analytics/GetAvailableReports

Input Parameters


There are no input parameters required to call the GetAvailableReports web method in the Surpass API.

Request


The GetAvailableReports web method can be called directly by browsing to the URL.

An example of this call is as follows:

https://[YourSurpassEnvironment].surpass.com/api/v1/Analytics/GetAvailableReports

Required Permissions


To successfully call GetAvailableReports the user specified in the header of the request must have the 'ViewReports' permission in Surpass.

Return

The response from the GetAvailableReports method will provide all of the available reports and all required information to call the GetReport method in the Surpass API.

If the call was unsuccessful then you will receive an error message, all error messages available in the Surpass API can be found here.

An example of the response can be found using the below link:  

JSON response

XML response




Next Article

Feedback and Knowledge Base