Calls API Report on Supplier dashboard

Suggest Edits

This Calls API Report registers a log of all the API calls made to the Cint system which allows suppliers to monitor and troubleshoot any API call issues. This report is essential when it comes to optimizing and improving your API integration. If a supplier wants to download the logs, they must export the report as a CSV file. The export allows for a supplier to filter on:

  • Minutes
  • Hours
  • Days
  • User ID
  • API call URL

Troubleshooting Recommendations for the Calls API Report:

Before Limit & After Limit: The API Calls Report provides the number of studies available Before limit & after limit based on the limit parameter used on the API call. This is particularly helpful to suppliers with a basic API integration to adjust the limit of surveys exposed to them as needed. For user-based calls, it will also show the number of surveys available before and after limit, to help suppliers decide if this should be adjusted.

  • Limit - When specified, the API response will contain the given number of items/surveys. If the limit parameter is not passed in the API call then it will return a default value which is 10 (if 10 or more surveys are available). Limit is an integer value.
  • Studies Before Limit - This column shows all surveys available on python end for that API call.
  • Studies After Limit - This column shows number of suitable surveys returned for that API call, considering the value passed in the “limit” parameter.
158

High Response Times: Response time is the average time taken by the API to return the response after a call has been made. Response time might vary depending on the call i.e. number of variables/data passed, limit requested, country etc. If an increase in response time is detected, suppliers can use this report to understand when the when the response times started increases or if there are trends or patterns they can identify. For example, API calls that include numerous profiling information for a user can take longer to process.

  • If an API call has a high response time and multiple profilers, we recommend making the call again and checking to see if it takes equally as long. Due to our system registering these profilers to a users profile, the first attempt with new profilers can take longer. The second call should come in faster as we already have the information logged.
  • Or, a supplier can remove profilers to try and identify a specific profiler that is causing a delay. In case response time is still high, please reach out to your account manager

API Call Fails: The “Status” column can confirm whether a call was processed with “No issues" or “Failed.” If failed, please check the “Message” column which will provide details as to why the system did not return any surveys for call.

504 Gateway time out: This status can indicate an overload on Cint’s servers. In this case, calls will not be recorded under this report. Please reach out to your account manager with the URL, date and time of when the API call was made to further investigate.

Updated 5 months ago