Analytics

The Analytics API is used to view the performance analytics of APIs and applications in the system. This API provides detailed information on the trends, hits, usage based on the filters applied.

List of resources

  • POST /analytics/{id}
    Retrieves the analytic insights for the given feed ID and matching filter criteria. Possible values are
    Value Description
    TRANSACTION_SUMMARY_FEED Retrieves the summary of all transactions.
    API_ACCESS_TREND_FEED Retrieves the API access trend.
    APP_ACCESS_TREND_FEED Retrieves the application access trend.
    API_RESPONSE_TIME_TREND_FEED Retrieves the API response time trend.
    TOP_API_HITS_BY_ACCESS_FEED Retrieves the list of APIs based on the number of hits.
    TOP_API_BY_FOLLOWERS_FEED Retrieves the list of APIs based on the number of followers.
    TOP_RESOURCE_HITS_BY_ACCESS_FEED Retrieves the list of resources based on the number of hits.
    TOP_STATUSCODE_HITS_BY_ACCESS_FEED Retrieves the list of status codes based on the number of hits.
    TOP_APP_HITS_BY_ACCESS_FEED Retrieves the list of applications based on the number of hits.
    APP_DISTRIBUTION_IN_API_FEED Retrieves the app distribution data from APIs.
    API_DISTRIBUTION_IN_APP_FEED Retrieves the API distribution data from applications.
    SIGN_UP_TREND_FEED Retrieves the user sign-up trend.
    LOGIN_TREND_FEED Retrieves the sign-in trend.
    ACCESS_LOGS Retrieves access logs.
    TOP_APP_TYPE_HITS_BY_ACCESS_FEED Retrieves the list of application types based on the number of hits.
    USER_SIGNUP_SUMMARY_FEED Retrieves the user sign-up summary.
    USER_LOGIN_SUMMARY_FEED Retrieves the user sign-in summary.
    TOP_CONSUMER_LOGINS Retrieves the list of first consumer sign-ins.
    TOTAL_USER_SIGNUP_AND_DELETE_FEED Retrieves the total number sign-ups and deletes.
  • POST /analytics/ACCESS_LOGS

    Retrieves the access logs for the matching filter criteria.

Sample cURL Command

curl --location --request POST 'developer_portal_rest_base/analytics/TRANSACTION_SUMMARY_FEED' \
--header 'Authorization: Basic basic_auth' \
--header 'Content-Type: application/json' \
--data-raw '{
    "apis":["api_id"]
}'