Page Comparison

...

1. • API_REQUEST_SUMMARY 

     This table contains the summary data of the request event stream.

     Code Block
     language sql title API_REQUEST_SUMMARY table schema
     CREATE TEMPORARY TABLE API_REQUEST_SUMMARY_FINAL USING CarbonAnalytics OPTIONS (tableName "API_REQUEST_SUMMARY", schema "api string -i, api_version string -i, version string -i, apiPublisher string -i, consumerKey string -i, userId string -i, context string -i, max_request_time long -i, total_request_count int -i, hostName string -i, year int -i, month int -i, day int -i, time string -i, key_api_facet facet -i, key_userId_facet facet -i, api_version_userId_facet facet -i, api_version_userId_apiPublisher_facet facet -i, api_version_userId_context_facet facet -i", primaryKeys "api,api_version,version,apiPublisher,consumerKey,userId,context,hostName,year,month,day" );

     Expand
     title Expand to find the table of descriptions for each column
     Code Block api : API Name api_version : API synapse artifact contained name [API Provider +"--"+API Name] version : API version apiPublisher : API provider context : api context consumerKey : consumer key of API invoked client application userId : API invoked end user name max_request_time: The latest API request occurred time total_request_count: Total request count for the requests coming for same API hostname : APIM server hostname year : The year of initial API request occurred of the batch of API requests month : The month of initial API request occurred of the batch of API requests day : The date of API initial request occurred of the batch of API requests time : The time of API initial request occurred of the batch of API requests

   • API_VERSION_USAGE_SUMMARY

     This table contains the summary data for API Manager usage. It is also derived from the request event table.

     Code Block
     language sql title VERSION_USAGE_SUMMARY table schema
     CREATE TEMPORARY TABLE API_VERSION_USAGE_SUMMARY_FINAL USING CarbonAnalytics OPTIONS (tableName "API_VERSION_USAGE_SUMMARY", schema "api string -i, version string -i, apiPublisher string -i, context string -i, total_request_count int -i, hostName string -i, year int -i, month int -i, day int -i, time string -i, max_request_time long -i, api_version_context_facet facet -i", primaryKeys "api,version,apiPublisher,context,hostName,year,month,day" );

     The table below contains the descriptions of each column

     Expand
     title Expand to find the table of descriptions for each column
     Code Block api : API Name version : API version apiPublisher : API provider context : api context consumerKey total_request_count: consumer Total request key count of an API invoked client application resourcePath : API resource url pattern version hostname : APIM server hostname year : The year of initial API request occurred of the batch of API request requests method month : HTTP The Verb month of initial API request [eg:GET/POST] total_request_count :Total request count for a particular API resource pattern hostname : APIM server hostname year : The year of initial API request occurred occurred of the batch of API requests month : The month of initial API request occurred of the batch of API requests day : The date of API initial request occurred of the batch of API requests time : The time of API initial request occurred of the batch of API requests

     API

   • API_Resource_USAGE_SUMMARY

     This table contains the summarized data for API Manager usage by resources and it is also derived from request event table.

     Code Block
     language sql title API_Resource_USAGE_SUMMARY table schema
     CREATE TEMPORARY TABLE API_Resource_USAGE_SUMMARY_FINAL USING CarbonAnalytics OPTIONS (tableName "API_Resource_USAGE_SUMMARY", schema "api string -i, version string -i, apiPublisher string -i, consumerKey string -i, resourcePath string -i, context string -i, method string -i, total_request_count int -i, hostName string -i, year int -i, month int -i, day int -i, time string -i, max_request_time long -i, key_api_method_path_facet facet -i, api_version_context_method_facet facet -i", primaryKeys "api,version,apiPublisher,consumerKey,context,resourcePath,method,hostName,year,month,day" );

   • API_RESPONSE_SUMMARY

     This table contains the summarized data from API responses. It is derived from the response event table.

     Code Block
     language sql title API_RESPONSE_SUMMARY table schema
     CREATE TEMPORARY TABLE API_RESPONSE_SUMMARY_FINAL USING CarbonAnalytics OPTIONS (tableName "API_RESPONSE_SUMMARY", schema "api_version string -i, apiPublisher string -i, context string -i, serviceTime int -i, total_response_count int -i, hostName string -i, year int -i, month int -i, day int -i, time string -i, max_request_time long -i, api_version_context_facet facet -i", primaryKeys "api,version,apiPublisher,context,hostName,year,month,day" );

   • API_FAULT

     Expand
     title Expand to find the table of descriptions for each column
     Code Block api : API Name version : API version apiPublisher : API provider context : api context consumerKey : consumer key of API invoked client application resourcePath : API resource url pattern of API request method : HTTP Verb of API request [eg:GET/POST] total_request_count :Total request count for a particular API resource pattern hostname : APIM server hostname year : The year of initial API request occurred of the batch of API requests month : The month of initial API request occurred of the batch of API requests day : The date of API initial request occurred of the batch of API requests time : The time of API initial request occurred of the batch of API requests

   • API_RESPONSE_SUMMARY

     This table contains the summarized data of faulty API invocations and from API responses. It is derived from the fault response event streamtable.

     Code Block
     language sql title API_FAULTRESPONSE_SUMMARY table schema
     CREATE TEMPORARY TABLE API_FAULTRESPONSE_SUMMARY_FINAL USING CarbonAnalytics OPTIONS (tableName "API_FAULTRESPONSE_SUMMARY", schema "api string -i, _version string -i, apiPublisher string -i, consumerKeycontext string -i, contextserviceTime stringint -i, total_faultresponse_count int -i, hostName string -i, year int -i, month int -i, day int -i, time string -i, max_request_time long -i, consumerKey_api_facet facet -i, api_version_apiPublisher_context_facet facet -i", primaryKeys "api,version,apiPublisher,consumerKey,context,hostName,year,month,day" );

   • API_DESTINATION_SUMMARY

     This table contains the summarized data of the API destinations and is derived from the destination event stream.

     Code Block
     language sql title API_DESTINATION_SUMMARY table schema
     CREATE TEMPORARY TABLE API_DESTINATION_SUMMARY_FINAL USING CarbonAnalytics OPTIONS (tableName "API_DESTINATION_SUMMARY", schema "api string -i, version string -i, apiPublisher string -i, context string -i, destination string -i, total_request_count int -i, hostName string -i, year int -i, month int -i, day int -i, time string -i, max_request_time long -i, api_version_context_dest_facet facet -i", primaryKeys "api,version,apiPublisher,context,destination,hostName,year,month,day" );

   • API_LAST_ACCESS_TIME_SUMMARY

     This table contains the summary data of the last access times of the API and is derived from the request event stream.

     API_LAST_ACCESS_TIME

     Code Block
     language	sql
     title

     Expand
     title Expand to find the table of descriptions for each column
     Code Block api_version : API synapse artifact contained name [API Provider +"--"+API Name] apiPublisher : API provider context : api context consumerKey : consumer key of API invoked client application serviceTime :Total time taken to serve the batch of API requests in APIM side total_response_count: Total response count for the API requests for a specific API hostname : APIM server hostname year : The year of initial API request occurred of the batch of API requests month : The month of initial API request occurred of the batch of API requests day : The date of API initial request occurred of the batch of API requests time : The time of API initial request occurred of the batch of API requests

   • API_FAULT_SUMMARY

     This table contains the summarized data of faulty API invocations and is derived from the fault event stream.

     Code Block
     title API_FAULT_SUMMARY table schema
     CREATE TEMPORARY TABLE API_LASTFAULT_ACCESS_TIME_SUMMARY_FINAL USING CarbonAnalytics OPTIONS (tableName "API_LASTFAULT_ACCESS_TIME_SUMMARY", schema "tenantDomainapi string -i, version string -i, apiPublisher string -i, apiconsumerKey string -i, versioncontext string -i, userId stringtotal_fault_count int -i, hostName string -i, year int -i, month int -i, contextday int -i, time string -i, max_request_time long -i", primaryKeys "tenantDomain,apiPublisher,api"consumerKey_api_facet facet -i, );

     API_THROTTLED_OUT_SUMMARY

     This table contains the summary of the throttle out API invocation data. It is derived from the throttle out event table and request table.

     Code Block
     language sql title API_THROTTLED_OUT_SUMMARY table schema
     CREATE TEMPORARY TABLE THROTTLED_OUT_FINAL_SUMMARY USING CarbonAnalytics OPTIONS (tableName "API_THROTTLED_OUT_SUMMARY", schema "api string -i, api_version string -i, context string -i, apiPublisher string -i, applicationName string -i, tenantDomain string -i, year int -i, month int -i, day int -i, week int -i, time string -i, success_request_count int -i, throttleout_count int -i, max_request_time long -i, api_year_month_week_day_facet facet -i, applicationName_facet facet -i", primaryKeys "api,api_version,context,apiPublisher,applicationName,tenantDomain,year,month,day" );api_version_apiPublisher_context_facet facet -i", primaryKeys "api,version,apiPublisher,consumerKey,context,hostName,year,month,day" );

     Expand
     title Expand to find the table of descriptions for each column
     Code Block api : API Name version : API version apiPublisher : API provider consumerKey : consumer key of API invoked client application context : api context total_fault_count: Total faulty API request count for a specific API hostname : APIM server hostname year : The year of initial API request occurred of the batch of API requests month : The month of initial API request occurred of the batch of API requests day : The date of API initial request occurred of the batch of API requests time : The time of API initial request occurred of the batch of API requests

   • API_DESTINATION_SUMMARY

     This table contains the summarized data of the API destinations and is derived from the destination event stream.

     Code Block
     language sql title API_DESTINATION_SUMMARY table schema
     CREATE TEMPORARY TABLE API_DESTINATION_SUMMARY_FINAL USING CarbonAnalytics OPTIONS (tableName "API_DESTINATION_SUMMARY", schema "api string -i, version string -i, apiPublisher string -i, context string -i, destination string -i, total_request_count int -i, hostName string -i, year int -i, month int -i, day int -i, time string -i, max_request_time long -i, api_version_context_dest_facet facet -i", primaryKeys "api,version,apiPublisher,context,destination,hostName,year,month,day" );

     Expand
     title Expand to find the table of descriptions for each column
     Code Block api : API Name version : API version apiPublisher : API provider context : api context destination : API endpoint hostname total_request_count : Total request count for the requests coming for same API to same destination hostname : APIM server hostname year : The year of initial API request occurred of the batch of API requests month : The month of initial API request occurred of the batch of API requests day : The date of API initial request occurred of the batch of API requests time : The time of API initial request occurred of the batch of API requests

   • API_LAST_ACCESS_TIME_SUMMARY

     This table contains the summary data of the last access times of the API and is derived from the request event stream.

     Code Block
     language sql title API_LAST_ACCESS_TIME_SUMMARY table schema
     CREATE TEMPORARY TABLE API_LAST_ACCESS_TIME_SUMMARY_FINAL USING CarbonAnalytics OPTIONS (tableName "API_LAST_ACCESS_TIME_SUMMARY", schema "tenantDomain string -i, apiPublisher string -i, api string -i, version string -i, userId string -i, context string -i, max_request_time long -i", primaryKeys "tenantDomain,apiPublisher,api" );

     Expand
     title Expand to find the table of descriptions for each column
     Code Block api : API Name version : API version apiPublisher : API provider context : api context userId : API invoked end user name tenantDomain : tenant domain of API provider max_request_time: latest API request occurred time

   • API_THROTTLED_OUT_SUMMARY

     This table contains the summary of the throttle out API invocation data. It is derived from the throttle out event table and request table.

     Code Block
     language sql title API_THROTTLED_OUT_SUMMARY table schema
     CREATE TEMPORARY TABLE THROTTLED_OUT_FINAL_SUMMARY USING CarbonAnalytics OPTIONS (tableName "API_THROTTLED_OUT_SUMMARY", schema "api string -i, api_version string -i, context string -i, apiPublisher string -i, applicationName string -i, tenantDomain string -i, year int -i, month int -i, day int -i, week int -i, time string -i, success_request_count int -i, throttleout_count int -i, max_request_time long -i, api_year_month_week_day_facet facet -i, applicationName_facet facet -i", primaryKeys "api,api_version,context,apiPublisher,applicationName,tenantDomain,year,month,day" );

     Expand
     title Expand to find the table of descriptions for each column
     Code Block api : API Name api_version : API synapse artifact contained name [API Provider +"--"+API Name] apiPublisher : API provider context : api context applicationName : client application name tenantDomain : tenant domain of API provider throttleout_count : Total throttled out API request count for the particular API success_request_count: Total successful API request count for the particular API year : The year of initial API request occurred of the batch of API requests month : The month of initial API request occurred of the batch of API requests day : The date of API initial request occurred of the batch of API requests time : The time of API initial request occurred of the batch of API requests

API Manager summarized tables (RDBMS)

...