openapi: 3.2.0 info: x-ibm-name: analytics version: 2.0.0 title: IBM API Connect Analytics API x-ibm-summary: API for the API Connect Analytics subsystem description: '## API for the API Connect Analytics subsystem This API includes the capability to retrieve information about API events stored in APIC Analytics, retrieve the data used by the Analytics dashboards in the UI, obtain information on what filter parameters are supported and also obtain information about internal cluster management, health and operations.' termsOfService: https://www.ibm.com/terms-of-service contact: name: IBM url: https://www.ibm.com email: help@ibm.com servers: - url: '' description: Analytics V2 base path tags: - name: Analytics paths: /{analytics-service}/cloud/events: description: 'Return a result set of analytics API events scoped to the cloud. The items in the result set are determined by the passed in request query to this API. The order of the result set is sorted from newest to oldest events by specified ''datetime''. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: List events at cloud scope description: 'Returns a result set of analytics API events scoped to the cloud. The items in the result set are determined by the passed in request query to this API. The order of the result set is sorted from newest to oldest events by specified ''datetime''. In this API, references to ''field'' refer to the analytics API event fields documented here: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.analytics.doc/api_event_records_fields.html Note this operation is limited to only being able to return 10,000 events, if you need more than that then use the scroll operation.' operationId: events_cloudList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/event_fields_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/provider_org_id_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/sort_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/timezone_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/EventListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/events/scroll: description: 'You can use the scroll operation to retrieve a large number of results. You can request an unlimited number of results in batches. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' post: summary: Scroll through results in batches description: Returns an initial batch of results following the requested size or a default of 1000 as well as a 'scroll_id'. Pass this scroll ID to the next scroll operation to get back the next batch of results. Typically, the scroll ID does not change between requests, but it can change, so make sure to always use the latest scroll ID. operationId: events_cloudScroll security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/event_fields_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/provider_org_id_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' requestBody: content: application/json: schema: $ref: '#/components/schemas/ScrollRequest' application/yaml: schema: $ref: '#/components/schemas/ScrollRequest' responses: '200': $ref: '#/components/responses/ScrollResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/events/scroll/delete: description: Clears the search context and results for a scrolling search. parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' post: summary: Clears the scroll search context description: Clears the scroll search context and results for a scrolling search. Should be used when the scroll context is not needed since otherwise it will stay open until it times out. operationId: events_cloudScrollDelete security: - oauth: - api-analytics:view requestBody: content: application/json: schema: $ref: '#/components/schemas/ScrollDeleteRequest' application/yaml: schema: $ref: '#/components/schemas/ScrollDeleteRequest' responses: '200': $ref: '#/components/responses/ScrollDeleteResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/events/{event-id}: description: 'Return a single analytics API event by ID scoped to the cloud. The item in the result set is determined by the passed in request query to this API. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/event-id' - $ref: '#/components/parameters/event_fields_optional' - $ref: '#/components/parameters/timezone_optional' get: summary: Get specific event at cloud scope description: 'Return a single analytics API event by ID scoped to the cloud. The item in the result set is determined by the passed in request query to this API. In this API, references to ''field'' refer to the analytics API event fields documented here: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.analytics.doc/api_event_records_fields.html' operationId: events_cloudGet security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/EventResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/events/{event-id}/context: description: 'Return investigation context for a single analytics API event scoped to the cloud: how the event compares with recent calls to the same operation, whether other calls around the same time had the same problem, what changed shortly before the event, and related calls. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/event-id' get: summary: Get investigation context for an event at cloud scope description: Return investigation context for a single analytics API event scoped to the cloud. The response has four optional sections, each omitted when it cannot be calculated. 'baseline' compares the event's latency, sizes and status code with the same operation over the previous 24 hours. 'blast_radius' gives call and error counts, per-minute, for 15 minutes either side of the event for the operation, API, backend, gateway service and application. 'changes' lists changes detected in the 24 hours before the event, from API event traffic (for example a new gateway version or a backend starting to fail), from product lifecycle updates received from API Manager and, when the caller has permission to view audit data and audit data is sent to analytics, from API Manager audit events for the event's API, product, application and consumer organization. 'performance' compares the event's assembly policy durations with recent successful calls to the same operation and gives hourly latency percentiles. 'related' lists calls that share the event's global transaction ID, calls from the same client within 60 seconds, and the trace ID. All date-time values are UTC. operationId: events_cloudContext security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/EventContextResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/events/count: description: 'Return a count of analytics API events scoped to the cloud. The count in the result is the number of API events that match the passed in request query. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Count events at cloud scope description: Return the count of analytics API events scoped to the cloud that match the passed in request query. operationId: events_cloudCount security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/provider_org_id_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/EventCountResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/events: description: 'Return a result set of analytics API events scoped to the organization. The items in the result set are determined by the passed in request query to this API. The order of the result set is sorted from newest to oldest events by specified ''datetime''. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: List events at provider organization scope description: 'Return a result set of analytics API events scoped to the provider organization. The items in the result set are determined by the passed in request query to this API. The order of the result set is sorted from newest to oldest events by specified ''datetime''. In this API, references to ''field'' refer to the analytics API event fields documented here: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.analytics.doc/api_event_records_fields.html Note this operation is limited to only being able to return 10,000 events, if you need more than that then use the scroll operation.' operationId: events_orgList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/event_fields_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/sort_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/timezone_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/EventListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/events/scroll: description: 'You can use the scroll operation to retrieve a large number of results. You can request an unlimited number of results in batches. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' post: summary: Scroll through results in batches description: Returns an initial batch of results following the requested size or a default of 1000 as well as a 'scroll_id'. Pass this scroll ID to the next scroll operation to get back the next batch of results. Typically, the scroll ID does not change between requests, but it can change, so make sure to always use the latest scroll ID. operationId: events_orgScroll security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/event_fields_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' requestBody: content: application/json: schema: $ref: '#/components/schemas/ScrollRequest' application/yaml: schema: $ref: '#/components/schemas/ScrollRequest' responses: '200': $ref: '#/components/responses/ScrollResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/events/scroll/delete: description: Clears the search context and results for a scrolling search. parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' post: summary: Clears the scroll search context description: Clears the scroll search context and results for a scrolling search. Should be used when the scroll context is not needed since otherwise it will stay open until it times out. operationId: events_orgScrollDelete security: - oauth: - api-analytics:view requestBody: content: application/json: schema: $ref: '#/components/schemas/ScrollDeleteRequest' application/yaml: schema: $ref: '#/components/schemas/ScrollDeleteRequest' responses: '200': $ref: '#/components/responses/ScrollDeleteResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/events/{event-id}: description: 'Return a single analytics API event by ID scoped to the provider organization. The item in the result set is determined by the passed in request query to this API. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/event-id' - $ref: '#/components/parameters/event_fields_optional' - $ref: '#/components/parameters/timezone_optional' get: summary: Get specific event at provider organization scope description: 'Return a single analytics API event by ID scoped to the provider organization. The item in the result set is determined by the passed in request query to this API. In this API, references to ''field'' refer to the analytics API event fields documented here: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.analytics.doc/api_event_records_fields.html' operationId: events_orgGet security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/EventResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/events/{event-id}/context: description: 'Return investigation context for a single analytics API event scoped to the provider organization: how the event compares with recent calls to the same operation, whether other calls around the same time had the same problem, what changed shortly before the event, and related calls. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/event-id' get: summary: Get investigation context for an event at organization scope description: Return investigation context for a single analytics API event scoped to the provider organization. The response has four optional sections, each omitted when it cannot be calculated. 'baseline' compares the event's latency, sizes and status code with the same operation over the previous 24 hours. 'blast_radius' gives call and error counts, per-minute, for 15 minutes either side of the event for the operation, API, backend, gateway service and application. 'changes' lists changes detected in the 24 hours before the event, from API event traffic (for example a new gateway version or a backend starting to fail), from product lifecycle updates received from API Manager and, when the caller has permission to view audit data and audit data is sent to analytics, from API Manager audit events for the event's API, product, application and consumer organization. 'performance' compares the event's assembly policy durations with recent successful calls to the same operation and gives hourly latency percentiles. 'related' lists calls that share the event's global transaction ID, calls from the same client within 60 seconds, and the trace ID. All date-time values are UTC. operationId: events_orgContext security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/EventContextResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/events/count: description: 'Return a count of analytics API events scoped to the provider organization. The count in the result is the number of API events that match the passed in request query. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Count events at provider organization scope description: Return the count of analytics API events scoped to the provider organization that match the passed in request query. operationId: events_orgCount security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/EventCountResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/events: description: 'Return a result set of analytics API events scoped to the catalog. The items in the result set are determined by the passed in request query to this API. The order of the result set is sorted from newest to oldest events by specified ''datetime''. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: List events at catalog scope description: 'Return a result set of analytics API events scoped to the catalog. The items in the result set are determined by the passed in request query to this API. The order of the result set is sorted from newest to oldest events by specified ''datetime''. In this API, references to ''field'' refer to the analytics API event fields documented here: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.analytics.doc/api_event_records_fields.html Note this operation is limited to only being able to return 10,000 events, if you need more than that then use the scroll operation at cloud or organization scope.' operationId: events_catalogList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/event_fields_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/sort_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/timezone_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/EventListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/events/{event-id}: description: 'Return a single analytics API event by ID scoped to the catalog. The item in the result set is determined by the passed in request query to this API. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/event-id' - $ref: '#/components/parameters/event_fields_optional' - $ref: '#/components/parameters/timezone_optional' get: summary: Get specific event at catalog scope description: 'Return a single analytics API event by ID scoped to the catalog. The item in the result set is determined by the passed in request query to this API. In this API, references to ''field'' refer to the analytics API event fields documented here: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.analytics.doc/api_event_records_fields.html' operationId: events_catalogGet security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/EventResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/events/{event-id}/context: description: 'Return investigation context for a single analytics API event scoped to the catalog: how the event compares with recent calls to the same operation, whether other calls around the same time had the same problem, what changed shortly before the event, and related calls. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/event-id' get: summary: Get investigation context for an event at catalog scope description: Return investigation context for a single analytics API event scoped to the catalog. The response has four optional sections, each omitted when it cannot be calculated. 'baseline' compares the event's latency, sizes and status code with the same operation over the previous 24 hours. 'blast_radius' gives call and error counts, per-minute, for 15 minutes either side of the event for the operation, API, backend, gateway service and application. 'changes' lists changes detected in the 24 hours before the event, from API event traffic (for example a new gateway version or a backend starting to fail), from product lifecycle updates received from API Manager and, when the caller has permission to view audit data and audit data is sent to analytics, from API Manager audit events for the event's API, product, application and consumer organization. 'performance' compares the event's assembly policy durations with recent successful calls to the same operation and gives hourly latency percentiles. 'related' lists calls that share the event's global transaction ID, calls from the same client within 60 seconds, and the trace ID. All date-time values are UTC. operationId: events_catalogContext security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/EventContextResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/events/count: description: 'Return a count of analytics API events scoped to the catalog. The count in the result is the number of API events that match the passed in request query. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Count events at catalog scope description: Return the count of analytics API events scoped to the catalog that match the passed in request query. operationId: events_catalogCount security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/EventCountResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/events: description: 'Return a result set of analytics API events scoped to the space. The items in the result set are determined by the passed in request query to this API. The order of the result set is sorted from newest to oldest events by specified ''datetime''. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: List events at space scope description: 'Return a result set of analytics API events scoped to the space. The items in the result set are determined by the passed in request query to this API. The order of the result set is sorted from newest to oldest events by specified ''datetime''. In this API, references to ''field'' refer to the analytics API event fields documented here: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.analytics.doc/api_event_records_fields.html Note this operation is limited to only being able to return 10,000 events, if you need more than that then use the scroll operation at cloud or organization scope.' operationId: events_spaceList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/event_fields_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/sort_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/timezone_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/EventListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/events/{event-id}: description: 'Return a single analytics API event by ID scoped to the space. The item in the result set is determined by the passed in request query to this API. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/event-id' - $ref: '#/components/parameters/event_fields_optional' - $ref: '#/components/parameters/timezone_optional' get: summary: Get specific event at space scope description: 'Return a single analytics API event by ID scoped to the space. The item in the result set is determined by the passed in request query to this API. In this API, references to ''field'' refer to the analytics API event fields documented here: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.analytics.doc/api_event_records_fields.html' operationId: events_spaceGet security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/EventResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/events/{event-id}/context: description: 'Return investigation context for a single analytics API event scoped to the space: how the event compares with recent calls to the same operation, whether other calls around the same time had the same problem, what changed shortly before the event, and related calls. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/event-id' get: summary: Get investigation context for an event at space scope description: Return investigation context for a single analytics API event scoped to the space. The response has four optional sections, each omitted when it cannot be calculated. 'baseline' compares the event's latency, sizes and status code with the same operation over the previous 24 hours. 'blast_radius' gives call and error counts, per-minute, for 15 minutes either side of the event for the operation, API, backend, gateway service and application. 'changes' lists changes detected in the 24 hours before the event, from API event traffic (for example a new gateway version or a backend starting to fail), from product lifecycle updates received from API Manager and, when the caller has permission to view audit data and audit data is sent to analytics, from API Manager audit events for the event's API, product, application and consumer organization. 'performance' compares the event's assembly policy durations with recent successful calls to the same operation and gives hourly latency percentiles. 'related' lists calls that share the event's global transaction ID, calls from the same client within 60 seconds, and the trace ID. All date-time values are UTC. operationId: events_spaceContext security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/EventContextResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/events/count: description: 'Return a count of analytics API events scoped to the space. The count in the result is the number of API events that match the passed in request query. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Count events at space scope description: Return a count of analytics API events scoped to the space. operationId: events_spaceCount security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/EventCountResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/discover-timeline: description: 'Return the data needed to populate the Timeline chart in discover view at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Get the data needed to populate the Timeline chart in discover view at cloud… description: Return the data needed to populate the Timeline chart in discover view at cloud scope. operationId: events_cloudTimeline security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/event_fields_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/provider_org_id_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/timezone_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/DiscoverTimelineResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/discover-timeline: description: 'Return the data needed to populate the Timeline chart in discover view at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the Timeline chart in discover view at org scope description: Return the data needed to populate the Timeline chart in discover view at org scope. operationId: events_orgTimeline security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/event_fields_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/timezone_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/DiscoverTimelineResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/discover-timeline: description: 'Return the data needed to populate the Timeline chart in discover view at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the Timeline chart in discover view at catalog… description: Return the data needed to populate the Timeline chart in discover view at catalog scope. operationId: events_catalogTimeline security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/event_fields_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/timezone_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/DiscoverTimelineResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/discover-timeline: description: 'Return the data needed to populate the Timeline chart in discover view at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/space' get: summary: Get the data needed to populate the Timeline chart in discover view at space… description: Return the data needed to populate the Timeline chart in discover view at space scope. operationId: events_spaceTimeline security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/event_fields_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/timezone_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/DiscoverTimelineResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/audit-timeline: description: 'Return a result set of Audit events scoped to the cloud. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: List audits for timeline chart description: Returns a list of audit events sorted by eventTime, scoped to cloud. operationId: audit_cloudTimeline security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/action_optional' - $ref: '#/components/parameters/audit_api_optional' - $ref: '#/components/parameters/audit_mcp_server_optional' - $ref: '#/components/parameters/audit_product_optional' - $ref: '#/components/parameters/audit_actor_optional' - $ref: '#/components/parameters/audit_area_optional' - $ref: '#/components/parameters/audit_changes_only_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/attachments_optional' - $ref: '#/components/parameters/auditId_optional' - $ref: '#/components/parameters/audit_entity_optional' - $ref: '#/components/parameters/catalogId_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/eventGenerator_optional' - $ref: '#/components/parameters/initiator_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/logSourceCRN_optional' - $ref: '#/components/parameters/logSourceType_optional' - $ref: '#/components/parameters/observer_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/outcome_optional' - $ref: '#/components/parameters/providerOrgId_optional' - $ref: '#/components/parameters/reason_optional' - $ref: '#/components/parameters/requestData_optional' - $ref: '#/components/parameters/requestPath_optional' - $ref: '#/components/parameters/responseData_optional' - $ref: '#/components/parameters/sort_optional' - $ref: '#/components/parameters/spaceId_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/tags_optional' - $ref: '#/components/parameters/target_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/timezone_optional' - $ref: '#/components/parameters/typeURI_optional' responses: '200': $ref: '#/components/responses/AuditTimelineResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/audit-timeline: description: 'Return a result set of Audit events scoped to the organization. The order of the result set is sorted from newest to oldest events by ''eventTime''. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Audit timeline at organization scope description: Returns a timeline of audit events across the provider organization. operationId: audit_orgTimeline security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/action_optional' - $ref: '#/components/parameters/audit_api_optional' - $ref: '#/components/parameters/audit_mcp_server_optional' - $ref: '#/components/parameters/audit_product_optional' - $ref: '#/components/parameters/audit_actor_optional' - $ref: '#/components/parameters/audit_area_optional' - $ref: '#/components/parameters/audit_changes_only_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/attachments_optional' - $ref: '#/components/parameters/auditId_optional' - $ref: '#/components/parameters/audit_entity_optional' - $ref: '#/components/parameters/catalogId_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/eventGenerator_optional' - $ref: '#/components/parameters/initiator_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/logSourceCRN_optional' - $ref: '#/components/parameters/logSourceType_optional' - $ref: '#/components/parameters/observer_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/outcome_optional' - $ref: '#/components/parameters/reason_optional' - $ref: '#/components/parameters/requestData_optional' - $ref: '#/components/parameters/requestPath_optional' - $ref: '#/components/parameters/responseData_optional' - $ref: '#/components/parameters/sort_optional' - $ref: '#/components/parameters/spaceId_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/tags_optional' - $ref: '#/components/parameters/target_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/timezone_optional' - $ref: '#/components/parameters/typeURI_optional' responses: '200': $ref: '#/components/responses/AuditTimelineResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/dashboards/api: description: 'Return the data needed to populate the API dashboard at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Get the data needed to populate the API dashboard at cloud scope description: Return the data needed to populate the API dashboard at cloud scope. operationId: dashboards_cloudApi security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/provider_org_id_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/ApiDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/dashboards/application: description: 'Return the data needed to populate the Application dashboard at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Get the data needed to populate the Application dashboard at cloud scope description: Return the data needed to populate the Application dashboard at cloud scope. operationId: dashboards_cloudApplication security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/provider_org_id_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/ApplicationDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/dashboards/consumer: description: 'Return the data needed to populate the Consumer dashboard at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Get the data needed to populate the Consumer dashboard at cloud scope description: Return the data needed to populate the Consumer dashboard at cloud scope. operationId: dashboards_cloudConsumer security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/provider_org_id_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/ConsumerDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/dashboards/gateway: description: 'Return the data needed to populate the Gateway Operations dashboard at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Get the data needed to populate the Gateway Operations dashboard at cloud scope description: Return the data needed to populate the Gateway Operations dashboard at cloud scope. operationId: dashboards_cloudGateway security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/provider_org_id_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/GatewayDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/dashboards/latency: description: 'Return the data needed to populate the Latency dashboard at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Get the data needed to populate the Latency dashboard at cloud scope description: Return the data needed to populate the Latency dashboard at cloud scope. operationId: dashboards_cloudLatency security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/provider_org_id_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/LatencyDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/dashboards/client: description: 'Return the data needed to populate the Client dashboard at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Get the data needed to populate the Client dashboard at cloud scope description: Return the data needed to populate the Client dashboard at cloud scope. operationId: dashboards_cloudClient security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/provider_org_id_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/ClientDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/dashboards/client/worldmap: description: 'Return the data needed to populate the world map at client dashboard at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Get the data needed to populate the worldmap dashboard at cloud scope description: Return the data needed to populate the worldmap dashboard at cloud scope. operationId: dashboards_cloudWorldmap security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bottom_right_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/provider_org_id_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/top_left_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/zoom_optional' responses: '200': $ref: '#/components/responses/WorldmapDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/dashboards/mcp: description: 'Return the data needed to populate the MCP (Model Context Protocol) dashboard at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Get the data needed to populate the MCP dashboard at cloud scope description: Return the data needed to populate the MCP (Model Context Protocol) dashboard at cloud scope. operationId: dashboards_cloudMcp security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/daily_limit_optional' - $ref: '#/components/parameters/daily_offset_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/provider_org_id_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/McpDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/dashboards/product: description: 'Return the data needed to populate the Product dashboard at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Get the data needed to populate the Product dashboard at cloud scope description: Return the data needed to populate the Product dashboard at cloud scope. operationId: dashboards_cloudProduct security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/provider_org_id_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/ProductDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/dashboards/status: description: 'Return the data needed to populate the Status dashboard at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Get the data needed to populate the Status dashboard at cloud scope description: Return the data needed to populate the Status dashboard at cloud scope. operationId: dashboards_cloudStatus security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/provider_org_id_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/StatusDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/dashboards/summary: description: 'Return the data needed to populate the SUMMARY dashboard at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Get the data needed to populate the SUMMARY dashboard at cloud scope description: Return the data needed to populate the SUMMARY dashboard at cloud scope. operationId: dashboards_cloudSummary security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/provider_org_id_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/SummaryDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/dashboards/consumption: description: 'Return the data needed to populate the Consumption dashboard at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Get the data needed to populate the Consumption dashboard at cloud scope description: Return the data needed to populate the Consumption dashboard at cloud scope. operationId: dashboards_cloudConsumption security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/daily_limit_optional' - $ref: '#/components/parameters/daily_offset_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/provider_org_id_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/ConsumptionResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/dashboards/data: description: 'Return the data needed to populate the Data dashboard at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Get the data needed to populate the Data dashboard at cloud scope description: Return the data needed to populate the Data dashboard at cloud scope. operationId: dashboards_cloudData security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/provider_org_id_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/DataDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/dashboards/ai: description: 'Return the data needed to populate the AI LLM dashboard at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Get the data needed to populate the AI LLM dashboard at cloud scope description: Return the data needed to populate the AI LLM dashboard at cloud scope. operationId: dashboards_cloudAi security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/daily_limit_optional' - $ref: '#/components/parameters/daily_offset_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/provider_org_id_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/AiDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/dashboards/api-backend: description: 'Return the data needed to populate the Backend dashboard at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Get the data needed to populate the Backend dashboard at cloud scope description: Return the data needed to populate the Backend dashboard at cloud scope. operationId: dashboards_cloudBackend security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/BackendDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/status-code-mismatch: description: 'Return the paginated list of status code mismatch events at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Get the paginated list of status code mismatch events at cloud scope description: Return the paginated list of status code mismatch events at cloud scope. operationId: statusCodeMismatch_cloud security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/timeframe_optional' responses: '200': $ref: '#/components/responses/StatusCodeMismatchResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/policy-errors: description: 'Return the paginated list of policy error events at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Get the paginated list of policy error events at cloud scope description: Return the paginated list of policy error events at cloud scope. operationId: policyErrors_cloud security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/timeframe_optional' responses: '200': $ref: '#/components/responses/PolicyErrorsResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/dashboards/api: description: 'Return the data needed to populate the API dashboard at provider organization scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the API dashboard at provider organization scope description: Return the data needed to populate the API dashboard at provider organization scope. operationId: dashboards_orgApi security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/ApiDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/dashboards/application: description: 'Return the data needed to populate the Application dashboard at provider organization scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the Application dashboard at provider… description: Return the data needed to populate the Application dashboard at provider organization scope. operationId: dashboards_orgApplication security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/ApplicationDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/dashboards/consumer: description: 'Return the data needed to populate the Consumer dashboard at provider organization scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the Consumer dashboard at provider organization… description: Return the data needed to populate the Consumer dashboard at provider organization scope. operationId: dashboards_orgConsumer security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/ConsumerDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/dashboards/gateway: description: 'Return the data needed to populate the Gateway Operations dashboard at provider organization scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the Gateway Operations dashboard at provider… description: Return the data needed to populate the Gateway Operations dashboard at provider organization scope. operationId: dashboards_orgGateway security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/GatewayDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/dashboards/latency: description: 'Return the data needed to populate the Latency dashboard at provider organization scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the Latency dashboard at provider organization… description: Return the data needed to populate the Latency dashboard at provider organization scope. operationId: dashboards_orgLatency security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/LatencyDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/dashboards/client: description: 'Return the data needed to populate the Client dashboard at provider organization scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the Client dashboard at provider organization… description: Return the data needed to populate the Client dashboard at provider organization scope. operationId: dashboards_orgClient security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/ClientDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/dashboards/client/worldmap: description: 'Return the data needed to populate the worldmap at client dashboard at provider organization scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the worldmap at client dashboard at provider… description: Return the data needed to populate the worldmap at client dashboard at provider organization scope. operationId: dashboards_orgWorldmap security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bottom_right_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/top_left_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/zoom_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/WorldmapDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/dashboards/mcp: description: 'Return the data needed to populate the MCP (Model Context Protocol) dashboard at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the MCP dashboard at org scope description: Return the data needed to populate the MCP (Model Context Protocol) dashboard at org scope. operationId: dashboards_orgMcp security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/event_fields_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/sort_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/timezone_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/McpDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/dashboards/product: description: 'Return the data needed to populate the Product dashboard at provider organization scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the Product dashboard at provider organization… description: Return the data needed to populate the Product dashboard at provider organization scope. operationId: dashboards_orgProduct security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/ProductDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/dashboards/status: description: 'Return the data needed to populate the Status dashboard at provider organization scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the Status dashboard at provider organization… description: Return the data needed to populate the Status dashboard at provider organization scope. operationId: dashboards_orgStatus security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/StatusDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/dashboards/summary: description: 'Return the data needed to populate the SUMMARY dashboard at provider organization scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the SUMMARY dashboard at provider organization… description: Return the data needed to populate the SUMMARY dashboard at provider organization scope. operationId: dashboards_orgSummary security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/SummaryDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/dashboards/consumption: description: 'Return the data needed to populate the Consumption dashboard at provider organization scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the Consumption dashboard at provider… description: Return the data needed to populate the Consumption dashboard at provider organization scope. operationId: dashboards_orgConsumption security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/daily_limit_optional' - $ref: '#/components/parameters/daily_offset_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/ConsumptionResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/dashboards/data: description: 'Return the data needed to populate the Data dashboard at provider organization scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the Data dashboard at provider organization… description: Return the data needed to populate the Data dashboard at provider organization scope. operationId: dashboards_orgData security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/DataDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/dashboards/ai: description: 'Return the data needed to populate the AI LLM dashboard at provider organization scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the AI LLM dashboard at provider organization… description: Return the data needed to populate the AI LLM dashboard at provider organization scope. operationId: dashboards_orgAi security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/daily_limit_optional' - $ref: '#/components/parameters/daily_offset_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/AiDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/dashboards/api-backend: description: 'Return the data needed to populate the Backend dashboard at provider organization scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the Backend dashboard at provider organization… description: Return the data needed to populate the Backend dashboard at provider organization scope. operationId: dashboards_orgBackend security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/BackendDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/status-code-mismatch: description: 'Return the paginated list of status code mismatch events at provider organization scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Get the paginated list of status code mismatch events at provider organization… description: Return the paginated list of status code mismatch events at provider organization scope. operationId: statusCodeMismatch_org security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/timeframe_optional' responses: '200': $ref: '#/components/responses/StatusCodeMismatchResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/policy-errors: description: 'Return the paginated list of policy error events at provider organization scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Get the paginated list of policy error events at provider organization scope description: Return the paginated list of policy error events at provider organization scope. operationId: policyErrors_org security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/catalog_id_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/timeframe_optional' responses: '200': $ref: '#/components/responses/PolicyErrorsResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/dashboards/api: description: 'Return the data needed to populate the API dashboard at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the API dashboard at catalog scope description: Return the data needed to populate the API dashboard at catalog scope. operationId: dashboards_catalogApi security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/ApiDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/dashboards/application: description: 'Return the data needed to populate the Application dashboard at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the Application dashboard at catalog scope description: Return the data needed to populate the Application dashboard at catalog scope. operationId: dashboards_catalogApplication security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/ApplicationDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/dashboards/consumer: description: 'Return the data needed to populate the Consumer dashboard at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the Consumer dashboard at catalog scope description: Return the data needed to populate the Consumer dashboard at catalog scope. operationId: dashboards_catalogConsumer security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/ConsumerDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/dashboards/gateway: description: 'Return the data needed to populate the Gateway Operations dashboard at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the Gateway Operations dashboard at catalog… description: Return the data needed to populate the Gateway Operations dashboard at catalog scope. operationId: dashboards_catalogGateway security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/GatewayDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/dashboards/latency: description: 'Return the data needed to populate the Latency dashboard at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the Latency dashboard at catalog scope description: Return the data needed to populate the Latency dashboard at catalog scope. operationId: dashboards_catalogLatency security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/LatencyDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/dashboards/client: description: 'Return the data needed to populate the Client dashboard at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the Client dashboard at catalog scope description: Return the data needed to populate the Client dashboard at catalog scope. operationId: dashboards_catalogClient security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/ClientDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/dashboards/client/worldmap: description: 'Return the data needed to populate the worldmap at client dashboard at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the worldmap at client dashboard at catalog… description: Return the data needed to populate the worldmap at client dashboard at catalog scope. operationId: dashboards_catalogWorldmap security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bottom_right_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/top_left_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/zoom_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/WorldmapDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/dashboards/mcp: description: 'Return the data needed to populate the MCP (Model Context Protocol) dashboard at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the MCP dashboard at catalog scope description: Return the data needed to populate the MCP (Model Context Protocol) dashboard at catalog scope. operationId: dashboards_catalogMcp security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/event_fields_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/sort_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/timezone_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/McpDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/dashboards/product: description: 'Return the data needed to populate the Product dashboard at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the Product dashboard at catalog scope description: Return the data needed to populate the Product dashboard at catalog scope. operationId: dashboards_catalogProduct security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/ProductDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/dashboards/status: description: 'Return the data needed to populate the Status dashboard at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the Status dashboard at catalog scope description: Return the data needed to populate the Status dashboard at catalog scope. operationId: dashboards_catalogStatus security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/StatusDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/dashboards/summary: description: 'Return the data needed to populate the SUMMARY dashboard at catalog scope ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the SUMMARY dashboard at catalog scope description: Return the data needed to populate the SUMMARY dashboard at catalog scope. operationId: dashboards_catalogSummary security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/SummaryDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/dashboards/consumption: description: 'Return the data needed to populate the Consumption dashboard at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the Consumption dashboard at catalog scope description: Return the data needed to populate the Consumption dashboard at catalog scope. operationId: dashboards_catalogConsumption security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/daily_limit_optional' - $ref: '#/components/parameters/daily_offset_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/ConsumptionResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/dashboards/data: description: 'Return the data needed to populate the Data dashboard at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the Data dashboard at catalog scope description: Return the data needed to populate the Data dashboard at catalog scope. operationId: dashboards_catalogData security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/DataDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/dashboards/ai: description: 'Return the data needed to populate the AI LLM dashboard at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the AI LLM dashboard at catalog scope description: Return the data needed to populate the AI LLM dashboard at catalog scope. operationId: dashboards_catalogAi security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/daily_limit_optional' - $ref: '#/components/parameters/daily_offset_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/AiDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/dashboards/api-backend: description: 'Return the data needed to populate the Backend dashboard at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' get: summary: Get the data needed to populate the Backend dashboard at catalog scope description: Return the data needed to populate the Backend dashboard at catalog scope. operationId: dashboards_catalogBackend security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/BackendDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/status-code-mismatch: description: 'Return the paginated list of status code mismatch events at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' get: summary: Get the paginated list of status code mismatch events at catalog scope description: Return the paginated list of status code mismatch events at catalog scope. operationId: statusCodeMismatch_catalog security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/timeframe_optional' responses: '200': $ref: '#/components/responses/StatusCodeMismatchResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/policy-errors: description: 'Return the paginated list of policy error events at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' get: summary: Get the paginated list of policy error events at catalog scope description: Return the paginated list of policy error events at catalog scope. operationId: policyErrors_catalog security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/timeframe_optional' responses: '200': $ref: '#/components/responses/PolicyErrorsResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/api: description: 'Return the data needed to populate the API dashboard at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/space' get: summary: Get the data needed to populate the API dashboard at space scope description: Return the data needed to populate the API dashboard at space scope. operationId: dashboards_spaceApi security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/ApiDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/application: description: 'Return the data needed to populate the Application dashboard at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Get the data needed to populate the Application dashboard at space scope description: Return the data needed to populate the Application dashboard at space scope. operationId: dashboards_spaceApplication security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/ApplicationDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/consumer: description: 'Return the data needed to populate the Consumer dashboard at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Get the data needed to populate the Consumer dashboard at space scope description: Return the data needed to populate the Consumer dashboard at space scope. operationId: dashboards_spaceConsumer security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/ConsumerDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/gateway: description: 'Return the data needed to populate the Gateway Operations dashboard at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Get the data needed to populate the Gateway Operations dashboard at space scope description: Return the data needed to populate the Gateway Operations dashboard at space scope. operationId: dashboards_spaceGateway security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/GatewayDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/latency: description: 'Return the data needed to populate the Latency dashboard at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Get the data needed to populate the Latency dashboard at space scope description: Return the data needed to populate the Latency dashboard at space scope. operationId: dashboards_spaceLatency security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/LatencyDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/client: description: 'Return the data needed to populate the Client dashboard at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Get the data needed to populate the Client dashboard at space scope description: Return the data needed to populate the Client dashboard at space scope. operationId: dashboards_spaceClient security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/ClientDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/client/worldmap: description: 'Return the data needed to populate the worldmap at client dashboard at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Get the data needed to populate the worldmap at client dashboard at space scope description: Return the data needed to populate the worldmap at client dashboard at space scope. operationId: dashboards_spaceWorldmap security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bottom_right_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/top_left_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/zoom_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/WorldmapDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/mcp: description: 'Return the data needed to populate the MCP (Model Context Protocol) dashboard at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Get the data needed to populate the MCP dashboard at space scope description: Return the data needed to populate the MCP (Model Context Protocol) dashboard at space scope. operationId: dashboards_spaceMcp security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/event_fields_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/sort_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/timezone_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/McpDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/product: description: 'Return the data needed to populate the Product dashboard at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Get the data needed to populate the Product dashboard at space scope description: Return the data needed to populate the Product dashboard at space scope. operationId: dashboards_spaceProduct security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/ProductDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/status: description: 'Return the data needed to populate the Status dashboard at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Get the data needed to populate the Status dashboard at space scope description: Return the data needed to populate the Status dashboard at space scope. operationId: dashboards_spaceStatus security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/StatusDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/summary: description: 'Return the data needed to populate the SUMMARY dashboard at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Get the data needed to populate the SUMMARY dashboard at space scope description: Return the data needed to populate the SUMMARY dashboard at space scope. operationId: dashboards_spaceSummary security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/SummaryDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/consumption: description: 'Return the data needed to populate the Consumption dashboard at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Get the data needed to populate the Consumption dashboard at space scope description: Return the data needed to populate the Consumption dashboard at space scope. operationId: dashboards_spaceConsumption security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/daily_limit_optional' - $ref: '#/components/parameters/daily_offset_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/ConsumptionResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/data: description: 'Return the data needed to populate the Data dashboard at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Get the data needed to populate the Data dashboard at space scope description: Return the data needed to populate the Data dashboard at space scope. operationId: dashboards_spaceData security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/DataDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/ai: description: 'Return the data needed to populate the AI LLM dashboard at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Get the data needed to populate the AI LLM dashboard at space scope description: Return the data needed to populate the AI LLM dashboard at space scope. operationId: dashboards_spaceAi security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/daily_limit_optional' - $ref: '#/components/parameters/daily_offset_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/mcp_method_name_optional' - $ref: '#/components/parameters/mcp_operation_name_optional' - $ref: '#/components/parameters/mcp_prompt_name_optional' - $ref: '#/components/parameters/mcp_resource_uri_optional' - $ref: '#/components/parameters/mcp_server_id_optional' - $ref: '#/components/parameters/mcp_server_name_optional' - $ref: '#/components/parameters/mcp_server_title_optional' - $ref: '#/components/parameters/mcp_server_version_optional' - $ref: '#/components/parameters/mcp_session_id_optional' - $ref: '#/components/parameters/jsonrpc_request_id_optional' - $ref: '#/components/parameters/mcp_tool_call_arguments_optional' - $ref: '#/components/parameters/mcp_tool_call_result_optional' - $ref: '#/components/parameters/mcp_tool_name_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/protocol_version_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rpc_status_code_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/AiDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/api-backend: description: 'Return the data needed to populate the Backend dashboard at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/space' get: summary: Get the data needed to populate the Backend dashboard at space scope description: Return the data needed to populate the Backend dashboard at space scope. operationId: dashboards_spaceBackend security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/ai_insights_optional' responses: '200': $ref: '#/components/responses/BackendDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/status-code-mismatch: description: 'Return the paginated list of status code mismatch events at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/space' get: summary: Get the paginated list of status code mismatch events at space scope description: Return the paginated list of status code mismatch events at space scope. operationId: statusCodeMismatch_space security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/timeframe_optional' responses: '200': $ref: '#/components/responses/StatusCodeMismatchResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/policy-errors: description: 'Return the paginated list of policy error events at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/space' get: summary: Get the paginated list of policy error events at space scope description: Return the paginated list of policy error events at space scope. operationId: policyErrors_space security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/timeframe_optional' responses: '200': $ref: '#/components/responses/PolicyErrorsResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/filterparameters: description: 'Return the list of filter parameters supported at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: List of filter parameters supported at cloud scope description: Return the list of filter parameters supported at cloud scope. operationId: filterparams_cloudList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/FilterParamListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/filterparameters: description: 'Return the list of filter parameters supported at provider organization scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: List of filter parameters supported at provider organization scope description: Return the list of filter parameters supported at provider organization scope. operationId: filterparams_orgList security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/FilterParamListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/filterparameters: description: 'Return the list of filter parameters supported at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: List of filter parameters supported at catalog scope description: Return the list of filter parameters supported at catalog scope. operationId: filterparams_catalogList security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/FilterParamListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/filterparameters: description: 'Return the list of filter parameters supported at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: List of filter parameters supported at space scope description: Return the list of filter parameters supported at space scope. operationId: filterparams_spaceList security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/FilterParamListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/runtime-metrics: description: 'Return the runtime metrics at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Runtime metrics at cloud scope description: Runtime metrics at cloud scope. operationId: runtimemetrics_cloudGet parameters: - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/timeframe_optional' security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/RuntimeMetricsGetResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/runtime-metrics: description: 'Runtime metrics at provider organization scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Runtime metrics at provider organization scope description: Runtime metrics at provider organization scope. operationId: runtimemetrics_orgGet parameters: - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/timeframe_optional' security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/RuntimeMetricsGetResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/runtime-metrics: description: 'Runtime metrics at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Runtime metrics at catalog scope description: Runtime metrics at catalog scope. operationId: runtimemetrics_catalogGet parameters: - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/timeframe_optional' security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/RuntimeMetricsGetResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/queries: description: 'The root of the ''queries'' resource at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: List saved queries at cloud scope description: List saved queries owned by the user making the request, at cloud scope. operationId: queries_cloudList parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/saved_query_search_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/QueryListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics post: summary: Create a query at cloud scope description: Save a query scoped to the cloud. operationId: queries_cloudCreate parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' security: - oauth: - api-analytics:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryRequest' application/yaml: schema: $ref: '#/components/schemas/QueryRequest' responses: '201': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/queries/shared: description: 'Return a list of saved queries shared by others at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: List shared queries at cloud scope description: Return a list of saved queries shared by others at cloud scope. operationId: queries_cloudListShared parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/saved_query_search_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/QueryListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/queries/current-default: description: 'Returns the current default query shared by others at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: List current default query at cloud scope description: Returns the current default query shared by others at cloud scope. operationId: queries_cloudListCurrentDefault parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/saved_query_search_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/QueryListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/queries/{query-id}: description: 'Return a single saved query by name or ID scoped to the cloud. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/query-id' get: summary: Get a specific query at cloud scope description: Return a query by name or ID scoped to the cloud. operationId: queries_cloudGet security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics put: summary: Update a specific query at cloud scope description: Replace a query with contents of the request body. operationId: queries_cloudUpdate security: - oauth: - api-analytics:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryUpdateRequest' application/yaml: schema: $ref: '#/components/schemas/QueryUpdateRequest' responses: '200': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics delete: summary: Deletes the specified query at cloud scope description: Deletes the saved query. If it was shared, it will no longer be available. operationId: queries_cloudDelete security: - oauth: - api-analytics:manage responses: '204': $ref: '#/components/responses/NoContentResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/queries/{query-id}/transfer-owner: description: 'Transfer ownership of a specified query to a different user. You must be the owner of this query to do this. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/query-id' post: summary: Transfer ownership of a saved query to a different user description: 'Provide a body with new_owner_user_url: `/api/user-registries/{org}/{user-registry}/users/{user}` to transfer this query to a new owner.' operationId: queries_cloudTransferOwner requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/QueryTransferOwnerRequest' application/yaml: schema: $ref: '#/components/schemas/QueryTransferOwnerRequest' security: - oauth: - api-analytics:manage parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/queries/{query-id}/share: description: 'Share a query with others users at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/query-id' post: summary: Share a saved query description: Share a saved query. operationId: queries_cloudShare security: - oauth: - api-analytics:manage parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/queries/{query-id}/unshare: description: 'Unshare a query at cloud scope. Other users at this scope will no longer be able to view or clone this query. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/query-id' post: summary: Unshare a saved query description: Unshare a saved query. operationId: queries_cloudUnshare security: - oauth: - api-analytics:manage parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/queries/{query-id}/clone: description: 'Make a copy of a shared query at cloud scope. The user comitting this action will be the owner of the cloned query. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/query-id' post: summary: Make a personal copy of a shared query description: Make a personal copy of a shared query. operationId: queries_cloudClone security: - oauth: - api-analytics:manage parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/queries/{query-id}/default: description: 'Set a query as default at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/query-id' post: summary: Set a shared query as the default query operationId: queries_cloudDefault security: - oauth: - api-analytics:manage parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/queries: description: 'The root of the ''queries'' resource at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: List saved queries at org scope description: List saved queries owned by the user making the request, at org scope. operationId: queries_orgList parameters: - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/saved_query_search_optional' security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/QueryListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics post: summary: Create a query at org scope description: Return a single query by name or ID scoped to the org. operationId: queries_orgCreate security: - oauth: - api-analytics:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryRequest' application/yaml: schema: $ref: '#/components/schemas/QueryRequest' responses: '201': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/queries/shared: description: 'Return a list of saved queries shared by others at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: List shared queries at org scope description: Return a list of saved queries shared by others at org scope. operationId: queries_orgListShared parameters: - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/saved_query_search_optional' security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/QueryListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/queries/current-default: description: 'Return the current default query shared by others at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: List current default query at org scope description: Return the current default query shared by others at org scope. operationId: queries_orgListCurrentDefault parameters: - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/saved_query_search_optional' security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/QueryListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/queries/{query-id}: description: 'Return a single saved query by name or ID scoped to the org. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/query-id' get: summary: Get a specific query at org scope description: Return a query by name or ID scoped to the org. operationId: queries_orgGet security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics put: summary: Update a specific query at org scope description: Replace a query with contents of the request body. operationId: queries_orgUpdate security: - oauth: - api-analytics:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryUpdateRequest' application/yaml: schema: $ref: '#/components/schemas/QueryUpdateRequest' responses: '200': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics delete: summary: Deletes the specified query at org scope description: Deletes the saved query. If it was shared, it will no longer be available. operationId: queries_orgDelete security: - oauth: - api-analytics:manage responses: '204': $ref: '#/components/responses/NoContentResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/queries/{query-id}/transfer-owner: description: 'Transfer ownership of a specified query to a different user. You must be the owner of this query to do this. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/query-id' post: summary: Transfer ownership of a saved query to a different user description: 'Provide a body with new_owner_user_url: `/api/user-registries/{org}/{user-registry}/users/{user}` to transfer this query to a new owner.' operationId: queries_orgTransferOwner requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/QueryTransferOwnerRequest' application/yaml: schema: $ref: '#/components/schemas/QueryTransferOwnerRequest' security: - oauth: - api-analytics:manage responses: '200': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/queries/{query-id}/share: description: 'Share a query with others users at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/query-id' post: summary: Share a saved query description: Share a saved query. operationId: queries_orgShare security: - oauth: - api-analytics:manage responses: '200': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/queries/{query-id}/unshare: description: 'Unshare a query at org scope. Other users at this scope will no longer be able to view or clone this query. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/query-id' post: summary: Unshare a saved query description: Unshare a saved query. operationId: queries_orgUnshare security: - oauth: - api-analytics:manage responses: '200': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/queries/{query-id}/clone: description: 'Make a copy of a shared query at org scope. The user comitting this action will be the owner of the cloned query. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/query-id' post: summary: Make a personal copy of a shared query description: Make a personal copy of a shared query. operationId: queries_orgClone security: - oauth: - api-analytics:manage responses: '200': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/queries/{query-id}/default: description: 'Set a query as default at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/query-id' post: summary: Set a shared query as the default query operationId: queries_orgDefault security: - oauth: - api-analytics:manage responses: '200': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/queries: description: 'The root of the ''queries'' resource at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' get: summary: List saved queries at catalog scope description: List saved queries owned by the user making the request, at catalog scope. operationId: queries_catalogList parameters: - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/saved_query_search_optional' security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/QueryListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics post: summary: Create a query at catalog scope description: Return a single query by name or ID scoped to the catalog. operationId: queries_catalogCreate security: - oauth: - api-analytics:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryRequest' application/yaml: schema: $ref: '#/components/schemas/QueryRequest' responses: '201': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/queries/shared: description: 'Return a list of saved queries shared by others at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: List shared queries at catalog scope description: Return a list of saved queries shared by others at catalog scope. operationId: queries_catalogListShared parameters: - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/saved_query_search_optional' security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/QueryListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/queries/current-default: description: 'Return the current default query shared by others at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: List current default query at catalog scope description: Return the current default query shared by others at catalog scope. operationId: queries_catalogListCurrentDefault parameters: - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/saved_query_search_optional' security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/QueryListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/queries/{query-id}: description: 'Return a single saved query by name or ID scoped to the catalog. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/query-id' get: summary: Get a specific query at catalog scope description: Return a query by name or ID scoped to the catalog. operationId: queries_catalogGet security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics put: summary: Update a specific query at catalog scope description: Replace a query with contents of the request body. operationId: queries_catalogUpdate security: - oauth: - api-analytics:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryUpdateRequest' application/yaml: schema: $ref: '#/components/schemas/QueryUpdateRequest' responses: '200': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics delete: summary: Deletes the specified query at catalog scope description: Deletes the saved query. If it was shared, it will no longer be available. operationId: queries_catalogDelete security: - oauth: - api-analytics:manage responses: '204': $ref: '#/components/responses/NoContentResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/queries/{query-id}/transfer-owner: description: 'Transfer ownership of a specified query to a different user. You must be the owner of this query to do this. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/query-id' post: summary: Transfer ownership of a saved query to a different user description: 'Provide a body with new_owner_user_url: `/api/user-registries/{org}/{user-registry}/users/{user}` to transfer this query to a new owner.' operationId: queries_catalogTransferOwner requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/QueryTransferOwnerRequest' application/yaml: schema: $ref: '#/components/schemas/QueryTransferOwnerRequest' security: - oauth: - api-analytics:manage responses: '200': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/queries/{query-id}/share: description: 'Share a query with others users at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/query-id' post: summary: Share a saved query description: Share a saved query. operationId: queries_catalogShare security: - oauth: - api-analytics:manage responses: '200': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/queries/{query-id}/unshare: description: 'Unshare a query at catalog scope. Other users at this scope will no longer be able to view or clone this query. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/query-id' post: summary: Unshare a saved query description: Unshare a saved query. operationId: queries_catalogUnshare security: - oauth: - api-analytics:manage responses: '200': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/queries/{query-id}/clone: description: 'Make a copy of a shared query at catalog scope. The user comitting this action will be the owner of the cloned query. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/query-id' post: summary: Make a personal copy of a shared query description: Make a personal copy of a shared query. operationId: queries_catalogClone security: - oauth: - api-analytics:manage responses: '200': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/queries/{query-id}/default: description: 'Set a query as default at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/query-id' post: summary: Set a shared query as the default query operationId: queries_catalogDefault security: - oauth: - api-analytics:manage responses: '200': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/queries: description: 'The root of the ''queries'' resource at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/space' get: summary: List saved queries at space scope description: List saved queries owned by the user making the request, at space scope. operationId: queries_spaceList parameters: - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/saved_query_search_optional' security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/QueryListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics post: summary: Create a query at space scope description: Return a single query by name or ID scoped to the space. operationId: queries_spaceCreate security: - oauth: - api-analytics:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryRequest' application/yaml: schema: $ref: '#/components/schemas/QueryRequest' responses: '201': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/queries/shared: description: 'Return a list of saved queries shared by others at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: List shared queries at space scope description: Return a list of saved queries shared by others at space scope. operationId: queries_spaceListShared parameters: - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/saved_query_search_optional' security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/QueryListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/queries/current-default: description: 'Return the current default query shared by others at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: List current default query at space scope description: Return the current default query shared by others at space scope. operationId: queries_spaceListsCurrentDefault parameters: - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/saved_query_search_optional' security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/QueryListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/queries/{query-id}: description: 'Return a single saved query by name or ID scoped to the space. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/query-id' get: summary: Get a specific query at space scope description: Return a query by name or ID scoped to the space. operationId: queries_spaceGet security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics put: summary: Update a specific query at space scope description: Replace a query with contents of the request body. operationId: queries_spaceUpdate security: - oauth: - api-analytics:manage requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryUpdateRequest' application/yaml: schema: $ref: '#/components/schemas/QueryUpdateRequest' responses: '200': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics delete: summary: Deletes the specified query at space scope description: Deletes the saved query. If it was shared, it will no longer be available. operationId: queries_spaceDelete security: - oauth: - api-analytics:manage responses: '204': $ref: '#/components/responses/NoContentResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/queries/{query-id}/transfer-owner: description: 'Transfer ownership of a specified query to a different user. You must be the owner of this query to do this. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/query-id' post: summary: Transfer ownership of a saved query to a different user description: 'Provide a body with new_owner_user_url: `/api/user-registries/{org}/{user-registry}/users/{user}` to transfer this query to a new owner.' operationId: queries_spaceTransferOwner requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/QueryTransferOwnerRequest' application/yaml: schema: $ref: '#/components/schemas/QueryTransferOwnerRequest' security: - oauth: - api-analytics:manage responses: '200': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/queries/{query-id}/share: description: 'Share a query with others users at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/query-id' post: summary: Share a saved query description: Share a saved query. operationId: queries_spaceShare security: - oauth: - api-analytics:manage responses: '200': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/queries/{query-id}/unshare: description: 'Unshare a query at space scope. Other users at this scope will no longer be able to view or clone this query. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/query-id' post: summary: Unshare a saved query description: Unshare a saved query. operationId: queries_spaceUnshare security: - oauth: - api-analytics:manage responses: '200': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/queries/{query-id}/clone: description: 'Make a copy of a shared query at space scope. The user comitting this action will be the owner of the cloned query. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/query-id' post: summary: Make a personal copy of a shared query description: Make a personal copy of a shared query. operationId: queries_spaceClone security: - oauth: - api-analytics:manage responses: '200': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/queries/{query-id}/default: description: 'Set a query as default at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/query-id' post: summary: Set a shared query as the default query description: Set a shared query as the default query. operationId: queries_spaceDefault security: - oauth: - api-analytics:manage responses: '200': $ref: '#/components/responses/QueryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/service-status: description: 'Used by the UI to get the analytics service status ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Used by the UI to get the analytics service status description: Used by the UI to get the analytics service status. operationId: service_cloudServicestatus parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ServiceStatusResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/service-status: description: 'Used by the UI to get the analytics service status ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Used by the UI to get the analytics service status description: Used by the UI to get the analytics service status. operationId: service_orgServicestatus security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ServiceStatusResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/service-status: description: 'Used by the UI to get the analytics service status ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' get: summary: Used by the UI to get the analytics service status description: Used by the UI to get the analytics service status. operationId: service_catalogServicestatus security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ServiceStatusResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/service-status: description: 'Used by the UI to get the analytics service status ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/space' get: summary: Used by the UI to get the analytics service status description: Used by the UI to get the analytics service status. operationId: service_spaceServicestatus security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ServiceStatusResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/config-sync-data: parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' post: summary: Send data to analytics on the usage of config-sync description: For obtaining billing information, we send data from config-sync to analytics operationId: configsync_uploadData security: - oauth: - api-analytics:view requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigSyncRequest' application/yaml: schema: $ref: '#/components/schemas/ConfigSyncRequest' responses: '200': $ref: '#/components/responses/ConfigSyncResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/corgs/{corg}/dashboard: description: 'Get data to populate the consumer analytics dashboard for a specific consumer organization. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/corg' - $ref: '#/components/parameters/org' get: summary: Get data needed to populate the consumer analytics dashboard description: Get data to populate the consumer analytics dashboard for a specific consumer organization. This endpoint requires provider level authentication. operationId: providerconsumeranalytics_catalogGet security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/timeframe_optional' responses: '200': $ref: '#/components/responses/ProviderConsumerAnalyticsResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/corgs/{corg}/apps/{app}/dashboard: description: 'Get data to populate the consumer analytics dashboard for a specific application ID. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/corg' - $ref: '#/components/parameters/app' get: summary: Get data to populate the consumer analytics dashboard by app id description: Get data to populate the consumer analytics dashboard for a specific application ID. This endpoint requires provider level authentication. operationId: providerconsumeranalytics_catalogGetByApp security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/timeframe_optional' responses: '200': $ref: '#/components/responses/ProviderConsumerAnalyticsResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/apiusage: description: 'Return the data needed to populate the API usage report at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: API usage report description: Return the data needed to populate the API usage report at cloud scope. operationId: reports_cloudApiusage security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/ApiUsageReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/apiusage/mini-leaderboards/apis: description: 'Return the data needed to populate the API leaderboard for the API usage report at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: API usage report API leaderboard description: Return the data needed to populate the API leaderboard for the API usage report at cloud scope. operationId: reports_cloudApiusageApisLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/ApiUsageLeaderboardReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/apiusage/mini-leaderboards/products: description: 'Return the data needed to populate the product leaderboard for the API usage report at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: API usage report product leaderboard description: Return the data needed to populate the product leaderboard for the API usage report at cloud scope. operationId: reports_cloudApiusageProductsLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/ApiUsageLeaderboardReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/apiusage/mini-leaderboards/plans: description: 'Return the data needed to populate the plan leaderboard for the API usage report at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: API usage report plan leaderboard description: Return the data needed to populate the plan leaderboard for the API usage report at cloud scope. operationId: reports_cloudApiusagePlansLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/ApiUsageLeaderboardReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/apis/{apiref}: description: 'Return the data needed to populate an API for the leaderboard for the API usage report at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/apiref' get: summary: API detail report description: Return the data needed to populate an API for the leaderboard for the API usage report at cloud scope. operationId: reports_cloudApiDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/app_limit_optional' - $ref: '#/components/parameters/app_offset_optional' - $ref: '#/components/parameters/corg_limit_optional' - $ref: '#/components/parameters/corg_offset_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/ApiUsageLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/products/{productref}: description: 'Return the data needed to populate a product for the leaderboard for the API usage report at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/productref' get: summary: Product detail report description: Return the data needed to populate a product for the leaderboard for the API usage report at cloud scope. operationId: reports_cloudProductDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/app_limit_optional' - $ref: '#/components/parameters/app_offset_optional' - $ref: '#/components/parameters/corg_limit_optional' - $ref: '#/components/parameters/corg_offset_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/ApiUsageLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/mcpservers/{mcpserverref}: description: 'Return the data needed to populate an MCP server for the leaderboard for the AI Platform report at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/mcpserverref' get: summary: MCP Server detail report description: Return the data needed to populate an MCP server for the leaderboard for the AI Platform report at cloud scope. operationId: reports_cloudMCPServerDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/app_limit_optional' - $ref: '#/components/parameters/app_offset_optional' - $ref: '#/components/parameters/corg_limit_optional' - $ref: '#/components/parameters/corg_offset_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/ApiUsageLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/plans/{planref}: description: 'Return the data needed to populate a plan for the leaderboard for the API usage report at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/planref' get: summary: Plan detail report description: Return the data needed to populate a plan for the leaderboard for the API usage report at cloud scope. operationId: reports_cloudPlanDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/app_limit_optional' - $ref: '#/components/parameters/app_offset_optional' - $ref: '#/components/parameters/corg_limit_optional' - $ref: '#/components/parameters/corg_offset_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/ApiUsageLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/leaderboards/apis: description: 'Return the data needed to populate the API leaderboard at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: API leaderboard description: Return the data needed to populate the API leaderboard at cloud scope. operationId: reports_cloudApisLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/leaderboards/products: description: 'Return the data needed to populate the Products leaderboard at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: Get the data needed to populate the Products leaderboard description: Return the data needed to populate the Products leaderboard at cloud scope. operationId: reports_cloudProductsLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/leaderboards/aiplatform-providers: description: 'Return the data needed to populate the AI platform providers leaderboard at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: AI platform providers leaderboard description: Return the data needed to populate the AI platform providers leaderboard at cloud scope. operationId: reports_cloudAiplatformprovidersLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/leaderboards/plans: description: 'Return the data needed to populate the Plans leaderboard at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: Get the data needed to populate the Plans leaderboard description: Return the data needed to populate the Plans leaderboard at cloud scope. operationId: reports_cloudPlanLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/leaderboards/applications: description: 'Return the data needed to populate the Applications leaderboard at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: Application leaderboard description: Return the data needed to populate the Applications leaderboard at cloud scope. operationId: reports_cloudApplicationsLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/leaderboards/consumerorgs: description: 'Return the data needed to populate the Consumer Organization leaderboard at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: Consumer organization leaderboard description: Return the data needed to populate the Consumer Organization leaderboard at cloud scope. operationId: reports_cloudConsumerorgsLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/leaderboards/aiplatform-consumers: description: 'Return the data needed to populate the AI platform consumers leaderboard at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: AI platform consumers leaderboard description: Return the data needed to populate the AI platform consumers leaderboard at cloud scope. operationId: reports_cloudAiplatformconsumersLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/leaderboards/breakdown: description: 'Return the data needed to populate the Breakdown leaderboard at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: Breakdown leaderboard description: Return the data needed to populate the Breakdown leaderboard at cloud scope. operationId: reports_cloudBreakdownLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/leaderboards/gateway-services: description: 'Return the data needed to populate the gateway services leaderboard at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: Gateway services leaderboard description: Return the data needed to populate the gateway services leaderboard at cloud scope. operationId: reports_cloudGatewayServicesLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/leaderboards/config-sync: description: 'Return the data needed to populate the config sync leaderboard at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: Config sync leaderboard description: Return the data needed to populate the config sync leaderboard at cloud scope. operationId: reports_cloudConfigSyncLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/gateway-services/{gateway-service-name}: description: 'Return the data needed to populate the gateway service leaderboard detail report at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/gateway-service-name' get: summary: Gateway service detail report description: Return the data needed to populate the gateway service leaderboard detail report at cloud scope. operationId: reports_cloudGatewayServiceDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_limit_optional' - $ref: '#/components/parameters/api_offset_optional' - $ref: '#/components/parameters/product_limit_optional' - $ref: '#/components/parameters/product_offset_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/GatewayServiceLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/config-sync/{catalog-name}: description: 'Return the data needed to populate the config sync leaderboard detail report at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog-name' get: summary: Config sync detail report description: Return the data needed to populate the config sync leaderboard detail report at cloud scope. operationId: reports_cloudConfigSyncDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/ConfigSyncLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/inactive/consumerorgs: description: 'Return the data needed to populate the Inactive consumer organizations report funnel at cloud scope. Asynchronous Report Generation: This endpoint uses asynchronous report generation. On the first request or when regenerating, the API returns a 202 (Accepted) status with a polling message. Poll the same endpoint every 30-60 seconds until you receive a 200 (OK) status with the complete report data. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Inactive consumer orgs report funnel description: 'Return the data needed to populate the Inactive consumer organizations report funnel at cloud scope. Asynchronous Report Generation: This is an asynchronous endpoint. The typical workflow is: 1. Initial Request: Make your first API call with the desired parameters (timeframe, start/end dates, etc.) 2. 202 Response: If the report is not yet generated, you''ll receive a 202 (Accepted) status with a message indicating the report is being generated 3. Polling: Poll the same endpoint every 30-60 seconds (do not poll more frequently to avoid unnecessary load) 4. 200 Response: Once the report is ready, you''ll receive a 200 (OK) status with the complete report data Regenerating Reports: - Cached reports are returned immediately with a 200 status - Use `regenerate=true` to force generation of a fresh report (this will return 202 and require polling) - Reports are cached based on the scope and time period parameters' operationId: reports_cloudInactiveCorgReportFunnel security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/regenerate_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/InactiveCorgFunnelResponse' '202': $ref: '#/components/responses/InactivePollingResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/inactive/consumerorgs/{inactive-consumer-report-type}: description: 'Return the data needed to populate the Inactive consumer organizations report table at cloud scope. Asynchronous report generation: This endpoint uses asynchronous report generation. On the first request or when regenerating, the API returns a 202 (Accepted) status with a polling message. Poll the same endpoint every 30-60 seconds until you receive a 200 (OK) status with the complete report data. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/inactive-consumer-report-type' get: summary: Inactive consumer orgs report table description: 'Return the data needed to populate the Inactive consumer organizations report table at cloud scope. Asynchronous report generation: This is an asynchronous endpoint. The typical workflow is: 1. Initial request: Make your first API call with the desired parameters (type, timeframe, start/end dates, etc.) 2. 202 response: If the report is not yet generated, you''ll receive a 202 (Accepted) status with a message indicating the report is being generated 3. Polling: Poll the same endpoint every 30-60 seconds (do not poll more frequently to avoid unnecessary load) 4. 200 response: Once the report is ready, you''ll receive a 200 (OK) status with the complete report data Regenerating reports: - Cached reports are returned immediately with a 200 status - Use `regenerate=true` to force generation of a fresh report (this will return 202 and require polling) - Reports are cached based on the scope, type, and time period parameters' operationId: reports_cloudInactiveCorgReportTable security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/regenerate_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/search_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/InactiveCorgTableResponse' '202': $ref: '#/components/responses/InactivePollingResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/inactive/products/{inactive-product-report-type}: description: 'Return the data needed to populate the Inactive product report at cloud scope ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/inactive-product-report-type' get: summary: Inactive product report table description: Return the data needed to populate the Inactive product report table at cloud scope operationId: reports_cloudInactiveProductReport security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/regenerate_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/search_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/InactiveProductResponse' '202': $ref: '#/components/responses/InactivePollingResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/deprecated/products: description: 'Return the data needed to populate the Deprecated product report at cloud scope ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Deprecated product report table description: Return the data needed to populate the Deprecated product report table at cloud scope operationId: reports_cloudDeprecatedProduct security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/regenerate_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/search_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/DeprecatedProductResponse' '202': $ref: '#/components/responses/DeprecatedPollingResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/consumertrend: description: 'Return the data needed to populate the consumer trend report, including trends and data of consumers, applications, and subscriptions, at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Consumer trend report description: Return the data needed to populate the consumer trend report, including trends and data of consumers, applications, and subscriptions, at cloud scope. operationId: reports_cloudConsumerTrend security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/ConsumerTrendReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/consumertrend/mini-leaderboards/applications: description: 'Return the data for the application leaderboard in the consumer trend report, including top_data and bottom_data along with other metrics over time at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Consumer trend report application leaderboard description: Return the data for the application leaderboard in the consumer trend report, including top_data and bottom_data along with other metrics over time at cloud scope. operationId: reports_cloudConsumerTrendApplicationsLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/ConsumerTrendLeaderboardReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/consumertrend/mini-leaderboards/consumerorgs: description: 'Return the data for the consumerorg leaderboard in the consumer trend report, including top_data and bottom_data along with other metrics over time at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Consumer trend report consumer org leaderboard description: Return the data for the consumerorg leaderboard in the consumer trend report, including top_data and bottom_data along with other metrics over time at cloud scope. operationId: reports_cloudConsumerTrendConsumerorgsLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/ConsumerTrendLeaderboardReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/applications/{app-name}: description: 'Return the data for the application leaderboard in the consumer trend report, including API call counts and other metrics over time at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/app-name' get: summary: Application detail report description: Return the data for the application leaderboard in the consumer trend report, including API call counts and other metrics over time at cloud scope. operationId: reports_cloudApplicationDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_limit_optional' - $ref: '#/components/parameters/api_offset_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/product_limit_optional' - $ref: '#/components/parameters/product_offset_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/ConsumerTrendLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/consumerorgs/{consumer-org-name}: description: 'Return the data for the consumerorg leaderboard in the consumer trend report, including API call counts and other metrics over time at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/consumer-org-name' get: summary: Consumer org detail report description: Return the data for the consumerorg leaderboard in the consumer trend report, including API call counts and other metrics over time at cloud scope. operationId: reports_cloudConsumerorgDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_limit_optional' - $ref: '#/components/parameters/api_offset_optional' - $ref: '#/components/parameters/app_limit_optional' - $ref: '#/components/parameters/app_offset_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/product_limit_optional' - $ref: '#/components/parameters/product_offset_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/ConsumerTrendLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/consumption: description: 'Return the data needed to populate the Consumption report at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Consumption report description: Return the data needed to populate the Consumption report at cloud scope. operationId: reports_cloudConsumption security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/daily_limit_optional' - $ref: '#/components/parameters/daily_offset_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/ConsumptionResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/usage-evolution/{usage-evolution-report-type}: description: 'Return the data needed to populate the Usage Evolution report at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/usage-evolution-report-type' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' get: summary: Usage Evolution report description: Return the data needed to populate the Usage Evolution report at cloud scope. operationId: reports_cloudUsageEvolution security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/UsageEvolutionReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/diskusage/{report-type}: description: 'Return the data needed to populate the Disk Usage report at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/report-type' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' get: summary: Disk Usage report description: Return the data needed to populate the Disk Usage report at cloud scope. operationId: reports_cloudDiskusage security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/DiskUsageReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/aiplatform: description: 'Return the data needed to populate the AI Platform report at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: AI Platform report description: Return the data needed to populate the AI Platform report at cloud scope. operationId: reports_cloudAiplatform security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/AiplatformReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/aiplatform/mini-leaderboards/aiplatform-providers: description: 'Return the data needed to populate the provider leaderboard for the AI Platforn report at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: AI Platform provider leaderboard description: Return the data needed to populate the provider leaderboard for the AI Platform report at cloud scope. operationId: reports_cloudAiplatformProviderLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/AiplatformLeaderboardReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/aiplatform/mini-leaderboards/aiplatform-consumers: description: 'Return the data needed to populate the consumer leaderboard for the AI platform report at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: AI Platform consumer leaderboard description: Return the data needed to populate the consumer leaderboard for the AI platform report at cloud scope. operationId: reports_cloudAiplatformConsumerLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/AiplatformLeaderboardReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/ilmt: description: 'Return ILMT (IBM License Metric Tool) metering data for license compliance tracking at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: ILMT metering report description: Return ILMT metering data with total API call count for license compliance tracking at cloud scope. This report is used by scheduled reports to send data to IBM License Metric Tool (ILMT) for on-premises license tracking. operationId: reports_cloudIlmt security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/schedule_optional' responses: '200': $ref: '#/components/responses/IlmtReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/iwhi-metering: description: 'Return IWHI (IBM webMethods Hybrid Integration) metering data for license compliance tracking at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: IWHI metering report description: Return IWHI metering data with total API call count for license compliance tracking at cloud scope. This report is used by scheduled reports to send data to IBM webMethods Hybrid Integration (IWHI) for on-premises license tracking. operationId: reports_cloudIwhiMetering security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/schedule_optional' - $ref: '#/components/parameters/iwhi_product_required' - $ref: '#/components/parameters/iwhi_version_required' - $ref: '#/components/parameters/iwhi_runtimeId_required' - $ref: '#/components/parameters/iwhi_tenant_required' - $ref: '#/components/parameters/iwhi_tenantId_required' - $ref: '#/components/parameters/iwhi_alias_optional' responses: '200': $ref: '#/components/responses/IwhiMeteringReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/ums: description: 'Return UMS (Usage Metering Service) metering data for license compliance tracking at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: UMS metering report description: Return UMS metering data with total API call count for license compliance tracking at cloud scope. This report is used by scheduled reports to send data to IBM Usage Metering Service (UMS) for on-premises container-based license tracking. operationId: reports_cloudUms security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/schedule_optional' responses: '200': $ref: '#/components/responses/UmsReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/reports/ratelimit/status: description: 'Return applications approaching their rate limits with pagination support at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Rate limit status report description: Return applications approaching their rate limits with pagination support at cloud scope. This report identifies applications that are consuming their rate limit quotas and provides comprehensive details for notification purposes including application, product, plan, API, consumer organization, and rate limit quota information. operationId: reports_cloudRateLimitStatus security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' - $ref: '#/components/parameters/sort_optional' - $ref: '#/components/parameters/rate_limit_status' - $ref: '#/components/parameters/provider_org_name_optional' responses: '200': $ref: '#/components/responses/RateLimitStatusResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/apiusage: description: 'Return the data needed to populate the API usage report at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: API usage report description: Return the data needed to populate the API usage report at org scope. operationId: reports_orgApiusage security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ApiUsageReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/apiusage/mini-leaderboards/apis: description: 'Return the data needed to populate the API leaderboard for the API usage report at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: API usage report API leaderboard description: Return the data needed to populate the API leaderboard for the API usage report at org scope. operationId: reports_orgApiusageApisLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ApiUsageLeaderboardReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/apiusage/mini-leaderboards/products: description: 'Return the data needed to populate the product leaderboard for the API usage report at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: API usage report product leaderboard description: Return the data needed to populate the product leaderboard for the API usage report at org scope. operationId: reports_orgApiusageProductsLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ApiUsageLeaderboardReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/apiusage/mini-leaderboards/plans: description: 'Return the data needed to populate the plan leaderboard for the API usage report at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: API usage report plan leaderboard description: Return the data needed to populate the plan leaderboard for the API usage report at org scope. operationId: reports_orgApiusagePlansLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ApiUsageLeaderboardReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/apis/{apiref}: description: 'Return the data needed to populate an API for the leaderboard for the API usage report at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/apiref' get: summary: API detail report description: Return the data needed to populate an API for the leaderboard for the API usage report at org scope. operationId: reports_orgApiDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/app_limit_optional' - $ref: '#/components/parameters/app_offset_optional' - $ref: '#/components/parameters/corg_limit_optional' - $ref: '#/components/parameters/corg_offset_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ApiUsageLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/products/{productref}: description: 'Return the data needed to populate a product for the leaderboard for the API usage report at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/productref' get: summary: Product detail report description: Return the data needed to populate a product for the leaderboard for the API usage report at org scope. operationId: reports_orgProductDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/app_limit_optional' - $ref: '#/components/parameters/app_offset_optional' - $ref: '#/components/parameters/corg_limit_optional' - $ref: '#/components/parameters/corg_offset_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ApiUsageLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/mcpservers/{mcpserverref}: description: 'Return the data needed to populate an MCP server for the leaderboard for the AI Platform report at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/mcpserverref' get: summary: MCP Server detail report description: Return the data needed to populate an MCP server for the leaderboard for the AI Platform report at org scope. operationId: reports_orgMCPServerDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/app_limit_optional' - $ref: '#/components/parameters/app_offset_optional' - $ref: '#/components/parameters/corg_limit_optional' - $ref: '#/components/parameters/corg_offset_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ApiUsageLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/plans/{planref}: description: 'Return the data needed to populate a plan for the leaderboard for the API usage report at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/planref' get: summary: Plan detail report description: Return the data needed to populate a plan for the leaderboard for the API usage report at org scope. operationId: reports_orgPlanDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/app_limit_optional' - $ref: '#/components/parameters/app_offset_optional' - $ref: '#/components/parameters/corg_limit_optional' - $ref: '#/components/parameters/corg_offset_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ApiUsageLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/leaderboards/apis: description: 'Return the data needed to populate the API leaderboard at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: API leaderboard description: Return the data needed to populate the API leaderboard at org scope. operationId: reports_orgApisLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/leaderboards/products: description: 'Return the data needed to populate the Product leaderboard at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: Product leaderboard description: Return the data needed to populate the Product leaderboard a at org scope. operationId: reports_orgProductsLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/leaderboards/aiplatform-providers: description: 'Return the data needed to populate the AI platform providers leaderboard at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: AI platform providers leaderboard description: Return the data needed to populate the AI platform providers leaderboard at org scope. operationId: reports_orgAiplatformprovidersLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/leaderboards/plans: description: 'Return the data needed to populate the Plans leaderboard at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: Get the data needed to populate the Plans leaderboard description: Return the data needed to populate the Plans leaderboard at org scope. operationId: reports_orgPlanLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/leaderboards/applications: description: 'Return the data needed to populate the Applications leaderboard at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: Application leaderboard description: Return the data needed to populate the Applications leaderboard at org scope. operationId: reports_orgApplicationsLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/leaderboards/consumerorgs: description: 'Return the data needed to populate the Consumer Organization leaderboard at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: Consumer organization leaderboard description: Return the data needed to populate the Consumer Organization leaderboard at org scope. operationId: reports_orgConsumerorgsLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/leaderboards/aiplatform-consumers: description: 'Return the data needed to populate the AI platform consumers leaderboard at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: AI platform consumers leaderboard description: Return the data needed to populate the AI platform consumers leaderboard at org scope. operationId: reports_orgAiplatformconsumersLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/leaderboards/breakdown: description: 'Return the data needed to populate the Breakdown leaderboard at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: Breakdown leaderboard description: Return the data needed to populate the Breakdown leaderboard at org scope. operationId: reports_orgBreakdownLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/leaderboards/gateway-services: description: 'Return the data needed to populate the gateway services leaderboard at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: Gateway services leaderboard description: Return the data needed to populate the gateway services leaderboard at org scope. operationId: reports_orgGatewayServicesLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/leaderboards/config-sync: description: 'Return the data needed to populate the config sync leaderboard at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: Config sync leaderboard description: Return the data needed to populate the config sync leaderboard at org scope. operationId: reports_orgConfigSyncLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/gateway-services/{gateway-service-name}: description: 'Return the data needed to populate the gateway service leaderboard detail report at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/gateway-service-name' get: summary: Gateway service detail report description: Return the data needed to populate the gateway service leaderboard detail report at org scope. operationId: reports_orgGatewayServiceDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_limit_optional' - $ref: '#/components/parameters/api_offset_optional' - $ref: '#/components/parameters/product_limit_optional' - $ref: '#/components/parameters/product_offset_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/GatewayServiceLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/config-sync/{catalog-name}: description: 'Return the data needed to populate the config sync leaderboard detail report at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog-name' get: summary: Config sync detail report description: Return the data needed to populate the config sync leaderboard detail report at org scope. operationId: reports_orgConfigSyncDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ConfigSyncLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/inactive/consumerorgs: description: 'Return the data needed to populate the Inactive consumer organizations report funnel at org scope. Asynchronous report generation: This endpoint uses asynchronous report generation. On the first request or when regenerating, the API returns a 202 (Accepted) status with a polling message. Poll the same endpoint every 30-60 seconds until you receive a 200 (OK) status with the complete report data. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Inactive consumer orgs report funnel description: 'Return the data needed to populate the Inactive consumer organizations report funnel at org scope. Asynchronous report generation: This is an asynchronous endpoint. The typical workflow is: 1. Initial request: Make your first API call with the desired parameters (timeframe, start/end dates, etc.) 2. 202 response: If the report is not yet generated, you''ll receive a 202 (Accepted) status with a message indicating the report is being generated 3. Polling: Poll the same endpoint every 30-60 seconds (do not poll more frequently to avoid unnecessary load) 4. 200 response: Once the report is ready, you''ll receive a 200 (OK) status with the complete report data Regenerating reports: - Cached reports are returned immediately with a 200 status - Use `regenerate=true` to force generation of a fresh report (this will return 202 and require polling) - Reports are cached based on the scope and time period parameters' operationId: reports_orgInactiveCorgReportFunnel security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/regenerate_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/InactiveCorgFunnelResponse' '202': $ref: '#/components/responses/InactivePollingResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/inactive/consumerorgs/{inactive-consumer-report-type}: description: 'Return the data needed to populate the Inactive consumer organizations report table at org scope. Asynchronous report generation: This endpoint uses asynchronous report generation. On the first request or when regenerating, the API returns a 202 (Accepted) status with a polling message. Poll the same endpoint every 30-60 seconds until you receive a 200 (OK) status with the complete report data. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/inactive-consumer-report-type' - $ref: '#/components/parameters/org' get: summary: Inactive consumer orgs report table description: 'Return the data needed to populate the Inactive consumer organizations report table at org scope. Asynchronous report generation: This is an asynchronous endpoint. The typical workflow is: 1. Initial request: Make your first API call with the desired parameters (type, timeframe, start/end dates, etc.) 2. 202 response: If the report is not yet generated, you''ll receive a 202 (Accepted) status with a message indicating the report is being generated 3. Polling: Poll the same endpoint every 30-60 seconds (do not poll more frequently to avoid unnecessary load) 4. 200 response: Once the report is ready, you''ll receive a 200 (OK) status with the complete report data Regenerating reports: - Cached reports are returned immediately with a 200 status - Use `regenerate=true` to force generation of a fresh report (this will return 202 and require polling) - Reports are cached based on the scope, type, and time period parameters' operationId: reports_orgInactiveCorgReportTable security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/regenerate_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/search_optional' responses: '200': $ref: '#/components/responses/InactiveCorgTableResponse' '202': $ref: '#/components/responses/InactivePollingResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/inactive/products/{inactive-product-report-type}: description: 'Return the data needed to populate the Inactive product report at org scope ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/inactive-product-report-type' - $ref: '#/components/parameters/org' get: summary: Inactive product report table description: Return the data needed to populate the Inactive product report table at org scope operationId: reports_orgInactiveProductReport security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/regenerate_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/search_optional' responses: '200': $ref: '#/components/responses/InactiveProductResponse' '202': $ref: '#/components/responses/InactivePollingResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/deprecated/products: description: 'Return the data needed to populate the Deprecated product report at org scope ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Deprecated product report table description: Return the data needed to populate the Deprecated product report table at org scope operationId: reports_orgDeprecatedProduct security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/regenerate_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/search_optional' responses: '200': $ref: '#/components/responses/DeprecatedProductResponse' '202': $ref: '#/components/responses/DeprecatedPollingResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/consumertrend: description: 'Return the data needed to populate the consumer trend report, including trends and data of consumers, applications, and subscriptions, at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Consumer trend report description: Return the data needed to populate the consumer trend report, including trends and data of consumers, applications, and subscriptions, at org scope. operationId: reports_orgConsumerTrend security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ConsumerTrendReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/consumertrend/mini-leaderboards/applications: description: 'Return the data for the application leaderboard in the consumer trend report, including top_data and bottom_data along with other metrics over time at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Consumer trend report application leaderboard description: Return the data for the application leaderboard in the consumer trend report, including top_data and bottom_data along with other metrics over time at org scope. operationId: reports_orgConsumerTrendApplicationsLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ConsumerTrendLeaderboardReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/consumertrend/mini-leaderboards/consumerorgs: description: 'Return the data for the consumerorg leaderboard in the consumer trend report, including top_data and bottom_data along with other metrics over time at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Consumer trend report consumer org leaderboard description: Return the data for the consumerorg leaderboard in the consumer trend report, including top_data and bottom_data along with other metrics over time at org scope. operationId: reports_orgConsumerTrendConsumerorgsLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ConsumerTrendLeaderboardReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/applications/{app-name}: description: 'Return the data for the application leaderboard in the consumer trend report, including API call counts and other metrics over time at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/app-name' get: summary: Application detail report description: Return the data for the application leaderboard in the consumer trend report, including API call counts and other metrics over time at org scope. operationId: reports_orgApplicationDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_limit_optional' - $ref: '#/components/parameters/api_offset_optional' - $ref: '#/components/parameters/product_limit_optional' - $ref: '#/components/parameters/product_offset_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ConsumerTrendLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/consumerorgs/{consumer-org-name}: description: 'Return the data for the consumerorg leaderboard in the consumer trend report, including API call counts and other metrics over time at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/consumer-org-name' get: summary: Consumer org detail report description: Return the data for the consumerorg leaderboard in the consumer trend report, including API call counts and other metrics over time at org scope. operationId: reports_orgConsumerorgDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_limit_optional' - $ref: '#/components/parameters/api_offset_optional' - $ref: '#/components/parameters/app_limit_optional' - $ref: '#/components/parameters/app_offset_optional' - $ref: '#/components/parameters/product_limit_optional' - $ref: '#/components/parameters/product_offset_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ConsumerTrendLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/consumption: description: 'Return the data needed to populate the Consumption report at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Consumption report description: Return the data needed to populate the Consumption report at org scope. operationId: reports_orgConsumption security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/daily_limit_optional' - $ref: '#/components/parameters/daily_offset_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ConsumptionResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/usage-evolution/{usage-evolution-report-type}: description: 'Return the data needed to populate the Usage Evolution report at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/usage-evolution-report-type' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' get: summary: Usage Evolution report description: Return the data needed to populate the Usage Evolution report at org scope. operationId: reports_orgUsageEvolution security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/UsageEvolutionReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/diskusage/{report-type}: description: 'Return the data needed to populate the Disk Usage report at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/report-type' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' get: summary: Disk Usage report description: Return the data needed to populate the Disk Usage report at org scope. operationId: reports_orgDiskusage security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/DiskUsageReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/aiplatform: description: 'Return the data needed to populate the AI Platform report at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: AI Platform report description: Return the data needed to populate the AI Platform report at org scope. operationId: reports_orgAiplatform security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/AiplatformReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/aiplatform/mini-leaderboards/aiplatform-providers: description: 'Return the data needed to populate the provider leaderboard for the AI Platforn report at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: AI Platform provider leaderboard description: Return the data needed to populate the provider leaderboard for the AI Platform report at org scope. operationId: reports_orgAiplatformProviderLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/AiplatformLeaderboardReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/aiplatform/mini-leaderboards/aiplatform-consumers: description: 'Return the data needed to populate the consumer leaderboard for the AI platform report at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: AI Platform consumer leaderboard description: Return the data needed to populate the consumer leaderboard for the AI platform report at org scope. operationId: reports_orgAiplatformConsumerLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/AiplatformLeaderboardReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/ilmt: description: 'Return ILMT (IBM License Metric Tool) metering data for license compliance tracking at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: ILMT metering report description: Return ILMT metering data with total API call count for license compliance tracking at org scope. This report is used by scheduled reports to send data to IBM License Metric Tool (ILMT) for on-premises license tracking. operationId: reports_orgIlmt security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/schedule_optional' responses: '200': $ref: '#/components/responses/IlmtReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/iwhi-metering: description: 'Return IWHI (IBM webMethods Hybrid Integration) metering data for license compliance tracking at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: IWHI metering report description: Return IWHI metering data with total API call count for license compliance tracking at org scope. This report is used by scheduled reports to send data to IBM webMethods Hybrid Integration (IWHI) for on-premises license tracking. operationId: reports_orgIwhiMetering security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/schedule_optional' - $ref: '#/components/parameters/iwhi_product_required' - $ref: '#/components/parameters/iwhi_version_required' - $ref: '#/components/parameters/iwhi_runtimeId_required' - $ref: '#/components/parameters/iwhi_tenant_required' - $ref: '#/components/parameters/iwhi_tenantId_required' - $ref: '#/components/parameters/iwhi_alias_optional' responses: '200': $ref: '#/components/responses/IwhiMeteringReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/ums: description: 'Return UMS (Usage Metering Service) metering data for license compliance tracking at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: UMS metering report description: Return UMS metering data with total API call count for license compliance tracking at org scope. This report is used by scheduled reports to send data to IBM Usage Metering Service (UMS) for on-premises container-based license tracking. operationId: reports_orgUms security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/schedule_optional' responses: '200': $ref: '#/components/responses/UmsReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/reports/ratelimit/status: description: 'Return applications approaching their rate limits with pagination support at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Rate limit status report description: Return applications approaching their rate limits with pagination support at org scope. This report identifies applications that are consuming their rate limit quotas and provides comprehensive details for notification purposes including application, product, plan, API, consumer organization, and rate limit quota information. operationId: reports_orgRateLimitStatus security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' - $ref: '#/components/parameters/sort_optional' - $ref: '#/components/parameters/rate_limit_status' responses: '200': $ref: '#/components/responses/RateLimitStatusResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/apiusage: description: 'Return the data needed to populate the API usage report at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' get: summary: API usage report description: Return the data needed to populate the API usage report at catalog scope. operationId: reports_catalogApiusage security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ApiUsageReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/apiusage/mini-leaderboards/apis: description: 'Return the data needed to populate the API leaderboard for the API usage report at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: API usage report API mini-leaderboard description: Return the data needed to populate the API leaderboard for the API usage report at catalog scope. operationId: reports_catalogApiusageApisLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ApiUsageLeaderboardReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/apiusage/mini-leaderboards/products: description: 'Return the data needed to populate the product leaderboard for the API usage report at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: API usage report product mini-leaderboard description: Return the data needed to populate the product leaderboard for the API usage report at catalog scope. operationId: reports_catalogApiusageProductsLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ApiUsageLeaderboardReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/apiusage/mini-leaderboards/plans: description: 'Return the data needed to populate the plan leaderboard for the API usage report at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: API usage report plan mini-leaderboard description: Return the data needed to populate the plan leaderboard for the API usage report at catalog scope. operationId: reports_catalogApiusagePlansLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ApiUsageLeaderboardReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/apis/{apiref}: description: 'Return the data needed to populate an API for the leaderboard for the API usage report at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/apiref' get: summary: API detail report description: Return the data needed to populate an API for the leaderboard for the API usage report at catalog scope. operationId: reports_catalogApiDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/app_limit_optional' - $ref: '#/components/parameters/app_offset_optional' - $ref: '#/components/parameters/corg_limit_optional' - $ref: '#/components/parameters/corg_offset_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ApiUsageLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/products/{productref}: description: 'Return the data needed to populate a product for the leaderboard for the API usage report at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/productref' get: summary: Product detail report description: Return the data needed to populate a product for the leaderboard for the API usage report at catalog scope. operationId: reports_catalogProductDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/app_limit_optional' - $ref: '#/components/parameters/app_offset_optional' - $ref: '#/components/parameters/corg_limit_optional' - $ref: '#/components/parameters/corg_offset_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ApiUsageLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/mcpservers/{mcpserverref}: description: 'Return the data needed to populate an MCP server for the leaderboard for the AI Platform report at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/mcpserverref' get: summary: MCP Server detail report description: Return the data needed to populate an MCP server for the leaderboard for the AI Platform report at catalog scope. operationId: reports_catalogMCPServerDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/app_limit_optional' - $ref: '#/components/parameters/app_offset_optional' - $ref: '#/components/parameters/corg_limit_optional' - $ref: '#/components/parameters/corg_offset_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ApiUsageLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/plans/{planref}: description: 'Return the data needed to populate a plan for the leaderboard for the API usage report at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/planref' get: summary: Plan detail report description: Return the data needed to populate a plan for the leaderboard for the API usage report at catalog scope. operationId: reports_catalogPlanDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/app_limit_optional' - $ref: '#/components/parameters/app_offset_optional' - $ref: '#/components/parameters/corg_limit_optional' - $ref: '#/components/parameters/corg_offset_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ApiUsageLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/leaderboards/apis: description: 'Return the data needed to populate the API leaderboard at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: API leaderboard description: Return the data needed to populate the API leaderboard at catalog scope. operationId: reports_catalogApisLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/leaderboards/products: description: 'Return the data needed to populate the Product leaderboard at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: Product leaderboard description: Return the data needed to populate the Product leaderboard at catalog scope. operationId: reports_catalogProductsLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/leaderboards/aiplatform-providers: description: 'Return the data needed to populate the AI platform providers leaderboard at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: AI platform providers leaderboard description: Return the data needed to populate the AI platform providers leaderboard at catalog scope. operationId: reports_catalogAiplatformprovidersLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/leaderboards/plans: description: 'Return the data needed to populate the Plan leaderboard at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: Plan leaderboard description: Return the data needed to populate the Plan leaderboard at catalog scope. operationId: reports_catalogPlanLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/leaderboards/applications: description: 'Return the data needed to populate the Applications leaderboard at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: Application leaderboard description: Return the data needed to populate the Applications leaderboard at catalog scope. operationId: reports_catalogApplicationsLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/leaderboards/consumerorgs: description: 'Return the data needed to populate the Consumer Organization leaderboard at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: Consumer organization leaderboard description: Return the data needed to populate the Consumer Organization leaderboard at catalog scope. operationId: reports_catalogConsumerorgsLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/leaderboards/aiplatform-consumers: description: 'Return the data needed to populate the AI platform consumers leaderboard at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: AI platform consumers leaderboard description: Return the data needed to populate the AI platform consumers leaderboard at catalog scope. operationId: reports_catalogAiplatformconsumersLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/leaderboards/breakdown: description: 'Return the data needed to populate the Breakdown leaderboard at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: Breakdown leaderboard description: Return the data needed to populate the Breakdown leaderboard at catalog scope. operationId: reports_catalogBreakdownLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/leaderboards/gateway-services: description: 'Return the data needed to populate the gateway services leaderboard at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: Gateway services leaderboard description: Return the data needed to populate the gateway services leaderboard at catalog scope. operationId: reports_catalogGatewayServicesLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/gateway-services/{gateway-service-name}: description: 'Return the data needed to populate the gateway service leaderboard detail report at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/gateway-service-name' get: summary: Gateway service detail report description: Return the data needed to populate the gateway service leaderboard detail report at catalog scope. operationId: reports_catalogGatewayServiceDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_limit_optional' - $ref: '#/components/parameters/api_offset_optional' - $ref: '#/components/parameters/product_limit_optional' - $ref: '#/components/parameters/product_offset_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/GatewayServiceLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/inactive/consumerorgs: description: 'Return the data needed to populate the Inactive consumer organizations report funnel at catalog scope. Asynchronous report generation: This endpoint uses asynchronous report generation. On the first request or when regenerating, the API returns a 202 (Accepted) status with a polling message. Poll the same endpoint every 30-60 seconds until you receive a 200 (OK) status with the complete report data. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Inactive consumer orgs report funnel description: 'Return the data needed to populate the Inactive consumer organizations report funnel at catalog scope. Asynchronous report generation: This is an asynchronous endpoint. The typical workflow is: 1. Initial request: Make your first API call with the desired parameters (timeframe, start/end dates, etc.) 2. 202 response: If the report is not yet generated, you''ll receive a 202 (Accepted) status with a message indicating the report is being generated 3. Polling: Poll the same endpoint every 30-60 seconds (do not poll more frequently to avoid unnecessary load) 4. 200 response: Once the report is ready, you''ll receive a 200 (OK) status with the complete report data Regenerating reports: - Cached reports are returned immediately with a 200 status - Use `regenerate=true` to force generation of a fresh report (this will return 202 and require polling) - Reports are cached based on the scope and time period parameters' operationId: reports_catalogInactiveCorgReportFunnel security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/regenerate_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/InactiveCorgFunnelResponse' '202': $ref: '#/components/responses/InactivePollingResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/inactive/consumerorgs/{inactive-consumer-report-type}: description: 'Return the data needed to populate the Inactive consumer organizations report table at catalog scope. Asynchronous report generation: This endpoint uses asynchronous report generation. On the first request or when regenerating, the API returns a 202 (Accepted) status with a polling message. Poll the same endpoint every 30-60 seconds until you receive a 200 (OK) status with the complete report data. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/inactive-consumer-report-type' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Inactive consumer orgs report table description: 'Return the data needed to populate the Inactive consumer organizations report table at catalog scope. Asynchronous report generation: This is an asynchronous endpoint. The typical workflow is: 1. Initial request: Make your first API call with the desired parameters (type, timeframe, start/end dates, etc.) 2. 202 response: If the report is not yet generated, you''ll receive a 202 (Accepted) status with a message indicating the report is being generated 3. Polling: Poll the same endpoint every 30-60 seconds (do not poll more frequently to avoid unnecessary load) 4. 200 response: Once the report is ready, you''ll receive a 200 (OK) status with the complete report data Regenerating reports: - Cached reports are returned immediately with a 200 status - Use `regenerate=true` to force generation of a fresh report (this will return 202 and require polling) - Reports are cached based on the scope, type, and time period parameters' operationId: reports_catalogInactiveCorgReportTable security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/regenerate_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/search_optional' responses: '200': $ref: '#/components/responses/InactiveCorgTableResponse' '202': $ref: '#/components/responses/InactivePollingResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/inactive/products/{inactive-product-report-type}: description: 'Return the data needed to populate the Inactive product report at catalog scope ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/inactive-product-report-type' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Inactive product report table description: Return the data needed to populate the Inactive product report table at catalog scope operationId: reports_catalogInactiveProductReport security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/regenerate_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/search_optional' responses: '200': $ref: '#/components/responses/InactiveProductResponse' '202': $ref: '#/components/responses/InactivePollingResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/deprecated/products: description: 'Return the data needed to populate the deprecated product report at catalog scope ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Deprecated product report table description: Return the data needed to populate the Deprecated product report table at catalog scope operationId: reports_catalogDeprecatedProduct security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/regenerate_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/search_optional' responses: '200': $ref: '#/components/responses/DeprecatedProductResponse' '202': $ref: '#/components/responses/DeprecatedPollingResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/consumertrend: description: 'Return the data needed to populate the consumer trend report, including trends and data of consumers, applications, and subscriptions, at the catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Consumer trend report description: Return the data needed to populate the consumer trend report, including trends and data of consumers, applications, and subscriptions, at the catalog scope. operationId: reports_catalogConsumerTrend security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ConsumerTrendReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/consumertrend/mini-leaderboards/applications: description: 'Return the data for the application leaderboard in the consumer trend report, including top_data and bottom_data along with other metrics over time at the catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Consumer trend report application mini-leaderboard description: Return the data for the application leaderboard in the consumer trend report, including top_data and bottom_data along with other metrics over time at the catalog scope. operationId: reports_catalogConsumerTrendApplicationsLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ConsumerTrendLeaderboardReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/consumertrend/mini-leaderboards/consumerorgs: description: 'Return the data for the consumerorg leaderboard in the consumer trend report, including top_data and bottom_data along with other metrics over time at the catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Consumer trend report consumerorg mini-leaderboard description: Return the data for the consumerorg leaderboard in the consumer trend report, including top_data and bottom_data along with other metrics over time at the catalog scope. operationId: reports_catalogConsumerTrendConsumerorgsLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ConsumerTrendLeaderboardReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/applications/{app-name}: description: 'Return the data for the application leaderboard in the consumer trend report, including API call counts and other metrics over time at the catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/app-name' get: summary: Application detail report description: Return the data for the application leaderboard in the consumer trend report, including API call counts and other metrics over time at the catalog scope. operationId: reports_catalogApplicationDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_limit_optional' - $ref: '#/components/parameters/api_offset_optional' - $ref: '#/components/parameters/product_limit_optional' - $ref: '#/components/parameters/product_offset_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ConsumerTrendLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/consumerorgs/{consumer-org-name}: description: 'Return the data for the consumerorg leaderboard in the consumer trend report, including API call counts and other metrics over time at the catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/consumer-org-name' get: summary: Consumer org detail report description: Return the data for the consumerorg leaderboard in the consumer trend report, including API call counts and other metrics over time at the catalog scope. operationId: reports_catalogConsumerorgDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_limit_optional' - $ref: '#/components/parameters/api_offset_optional' - $ref: '#/components/parameters/app_limit_optional' - $ref: '#/components/parameters/app_offset_optional' - $ref: '#/components/parameters/product_limit_optional' - $ref: '#/components/parameters/product_offset_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ConsumerTrendLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/usage-evolution/{usage-evolution-report-type}: description: 'Return the data needed to populate the Usage Evolution report at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/usage-evolution-report-type' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' get: summary: Usage Evolution report description: Return the data needed to populate the Usage Evolution report at catalog scope. operationId: reports_catalogUsageEvolution security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/UsageEvolutionReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/consumption: description: 'Return the data needed to populate the Consumption report at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Consumption report description: Return the data needed to populate the Consumption report at catalog scope. operationId: reports_catalogConsumption security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/daily_limit_optional' - $ref: '#/components/parameters/daily_offset_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ConsumptionResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/diskusage/{report-type}: description: 'Return the data needed to populate the Disk Usage report at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/report-type' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' get: summary: Disk Usage report description: Return the data needed to populate the Disk Usage report at catalog scope. operationId: reports_catalogDiskusage security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/DiskUsageReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/ratelimit/status: description: 'Return applications approaching their rate limits with pagination support at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Rate limit status report description: Return applications approaching their rate limits with pagination support at catalog scope. This report identifies applications that are consuming their rate limit quotas and provides comprehensive details for notification purposes including application, product, plan, API, consumer organization, and rate limit quota information. operationId: reports_catalogRateLimitStatus security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' - $ref: '#/components/parameters/sort_optional' - $ref: '#/components/parameters/rate_limit_status' responses: '200': $ref: '#/components/responses/RateLimitStatusResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/aiplatform: description: 'Return the data needed to populate the AI Platform report at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: AI Platform report description: Return the data needed to populate the AI Platform report at catalog scope. operationId: reports_catalogAiplatform security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/AiplatformReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/aiplatform/mini-leaderboards/aiplatform-providers: description: 'Return the data needed to populate the provider leaderboard for the AI Platforn report at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: AI Platform provider leaderboard description: Return the data needed to populate the provider leaderboard for the AI Platform report at catalog scope. operationId: reports_catalogAiplatformProviderLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/AiplatformLeaderboardReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/reports/aiplatform/mini-leaderboards/aiplatform-consumers: description: 'Return the data needed to populate the consumer leaderboard for the AI platform report at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: AI Platform consumer leaderboard description: Return the data needed to populate the consumer leaderboard for the AI platform report at catalog scope. operationId: reports_catalogAiplatformConsumerLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/AiplatformLeaderboardReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/apiusage: description: 'Return the data needed to populate the API usage report at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/space' get: summary: API usage report description: Return the data needed to populate the API usage report at space scope. operationId: reports_spaceApiusage security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ApiUsageReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/apiusage/mini-leaderboards/apis: description: 'Return the data needed to populate the API leaderboard for the API usage report at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: API usage report API leaderboard description: Return the data needed to populate the API leaderboard for the API usage report at space scope. operationId: reports_spaceApiusageApisLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ApiUsageLeaderboardReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/apiusage/mini-leaderboards/products: description: 'Return the data needed to populate the product leaderboard for the API usage report at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: API usage report product leaderboard description: Return the data needed to populate the product leaderboard for the API usage report at space scope. operationId: reports_spaceApiusageProductsLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ApiUsageLeaderboardReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/apiusage/mini-leaderboards/plans: description: 'Return the data needed to populate the plan leaderboard for the API usage report at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: API usage report plan leaderboard description: Return the data needed to populate the plan leaderboard for the API usage report at space scope. operationId: reports_spaceApiusagePlansLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ApiUsageLeaderboardReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/apis/{apiref}: description: 'Return the data needed to populate an API for the leaderboard for the API usage report at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/apiref' get: summary: API detail report description: Return the data needed to populate an API for the leaderboard for the API usage report at space scope. operationId: reports_spaceApiDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/app_limit_optional' - $ref: '#/components/parameters/app_offset_optional' - $ref: '#/components/parameters/corg_limit_optional' - $ref: '#/components/parameters/corg_offset_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ApiUsageLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/products/{productref}: description: 'Return the data needed to populate a product for the leaderboard for the API usage report at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/productref' get: summary: Product detail report description: Return the data needed to populate a product for the leaderboard for the API usage report at space scope. operationId: reports_spaceProductDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/app_limit_optional' - $ref: '#/components/parameters/app_offset_optional' - $ref: '#/components/parameters/corg_limit_optional' - $ref: '#/components/parameters/corg_offset_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ApiUsageLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/mcpservers/{mcpserverref}: description: 'Return the data needed to populate an MCP server for the leaderboard for the AI Platform report at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/mcpserverref' get: summary: MCP Server detail report description: Return the data needed to populate an MCP server for the leaderboard for the AI Platform report at space scope. operationId: reports_spaceMCPServerDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/app_limit_optional' - $ref: '#/components/parameters/app_offset_optional' - $ref: '#/components/parameters/corg_limit_optional' - $ref: '#/components/parameters/corg_offset_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ApiUsageLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/plans/{planref}: description: 'Return the data needed to populate a plan for the leaderboard for the API usage report at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/planref' get: summary: Plan detail report description: Return the data needed to populate a plan for the leaderboard for the API usage report at space scope. operationId: reports_spacePlanDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/app_limit_optional' - $ref: '#/components/parameters/app_offset_optional' - $ref: '#/components/parameters/corg_limit_optional' - $ref: '#/components/parameters/corg_offset_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ApiUsageLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/leaderboards/apis: description: 'Return the data needed to populate the API leaderboard at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' get: summary: API leaderboard description: Return the data needed to populate the API leaderboard at space scope. operationId: reports_spaceApisLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/leaderboards/products: description: 'Return the data needed to populate the Product leaderboard at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' get: summary: Product leaderboard description: Return the data needed to populate the Product leaderboard at space scope. operationId: reports_spaceProductsLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/leaderboards/aiplatform-providers: description: 'Return the data needed to populate the AI platform providers leaderboard at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' get: summary: AI platform providers leaderboard description: Return the data needed to populate the AI platform providers leaderboard at space scope. operationId: reports_spaceAiplatformprovidersLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/leaderboards/plans: description: 'Return the data needed to populate the Plans leaderboard at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' get: summary: Get the data needed to populate the Plans leaderboard description: Return the data needed to populate the Plans leaderboard at space scope. operationId: reports_spacePlanLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/leaderboards/applications: description: 'Return the data needed to populate the Applications leaderboard at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' get: summary: Application leaderboard description: Return the data needed to populate the Applications leaderboard at space scope. operationId: reports_spaceApplicationsLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/leaderboards/consumerorgs: description: 'Return the data needed to populate the Consumer Organization leaderboard at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' get: summary: Consumer organization leaderboard description: Return the data needed to populate the Consumer Organization leaderboard at space scope. operationId: reports_spaceConsumerorgsLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/leaderboards/aiplatform-consumers: description: 'Return the data needed to populate the AI platform consumers leaderboard at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' get: summary: AI platform consumers leaderboard description: Return the data needed to populate the AI platform consumers leaderboard at space scope. operationId: reports_spaceAiplatformconsumersLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/leaderboards/gateway-services: description: 'Return the data needed to populate the gateway services leaderboard at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' get: summary: Gateway services leaderboard description: Return the data needed to populate the gateway services leaderboard at space scope. operationId: reports_spaceGatewayServicesLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/all_status_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/LeaderboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/gateway-services/{gateway-service-name}: description: 'Return the data needed to populate a product for the leaderboard for the API usage report at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/gateway-service-name' get: summary: Gateway service detail report description: Return the data needed to populate the gateway service leaderboard detail report at space scope. operationId: reports_spaceGatewayServiceDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_limit_optional' - $ref: '#/components/parameters/api_offset_optional' - $ref: '#/components/parameters/product_limit_optional' - $ref: '#/components/parameters/product_offset_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/GatewayServiceLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/inactive/consumerorgs: description: 'Return the data needed to populate the Inactive consumer organizations report funnel at space scope. Asynchronous report generation: This endpoint uses asynchronous report generation. On the first request or when regenerating, the API returns a 202 (Accepted) status with a polling message. Poll the same endpoint every 30-60 seconds until you receive a 200 (OK) status with the complete report data. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Inactive consumer orgs report funnel description: 'Return the data needed to populate the Inactive consumer organizations report funnel at space scope. Asynchronous report generation: This is an asynchronous endpoint. The typical workflow is: 1. Initial request: Make your first API call with the desired parameters (timeframe, start/end dates, etc.) 2. 202 response: If the report is not yet generated, you''ll receive a 202 (Accepted) status with a message indicating the report is being generated 3. Polling: Poll the same endpoint every 30-60 seconds (do not poll more frequently to avoid unnecessary load) 4. 200 response: Once the report is ready, you''ll receive a 200 (OK) status with the complete report data Regenerating reports: - Cached reports are returned immediately with a 200 status - Use `regenerate=true` to force generation of a fresh report (this will return 202 and require polling) - Reports are cached based on the scope and time period parameters' operationId: reports_spaceInactiveCorgReportFunnel security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/regenerate_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/InactiveCorgFunnelResponse' '202': $ref: '#/components/responses/InactivePollingResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/inactive/consumerorgs/{inactive-consumer-report-type}: description: 'Return the data needed to populate the Inactive consumer organizations report table at space scope. Asynchronous report generation: This endpoint uses asynchronous report generation. On the first request or when regenerating, the API returns a 202 (Accepted) status with a polling message. Poll the same endpoint every 30-60 seconds until you receive a 200 (OK) status with the complete report data. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/inactive-consumer-report-type' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Inactive consumer orgs report table description: 'Return the data needed to populate the Inactive consumer organizations report table at space scope. Asynchronous report generation: This is an asynchronous endpoint. The typical workflow is: 1. Initial request: Make your first API call with the desired parameters (type, timeframe, start/end dates, etc.) 2. 202 response: If the report is not yet generated, you''ll receive a 202 (Accepted) status with a message indicating the report is being generated 3. Polling: Poll the same endpoint every 30-60 seconds (do not poll more frequently to avoid unnecessary load) 4. 200 response: Once the report is ready, you''ll receive a 200 (OK) status with the complete report data Regenerating reports: - Cached reports are returned immediately with a 200 status - Use `regenerate=true` to force generation of a fresh report (this will return 202 and require polling) - Reports are cached based on the scope, type, and time period parameters' operationId: reports_spaceInactiveCorgReportTable security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/regenerate_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/search_optional' responses: '200': $ref: '#/components/responses/InactiveCorgTableResponse' '202': $ref: '#/components/responses/InactivePollingResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/inactive/products/{inactive-product-report-type}: description: 'Return the data needed to populate the Inactive product report at space scope ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/inactive-product-report-type' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Inactive product report table description: Return the data needed to populate the Inactive product report table at space scope operationId: reports_spaceInactiveProductReport security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/regenerate_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/search_optional' responses: '200': $ref: '#/components/responses/InactiveProductResponse' '202': $ref: '#/components/responses/InactivePollingResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/deprecated/products: description: 'Return the data needed to populate the deprecated product report at space scope ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Deprecated product report table description: Return the data needed to populate the Deprecated product report table at space scope operationId: reports_spaceDeprecatedProduct security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/regenerate_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/search_optional' responses: '200': $ref: '#/components/responses/DeprecatedProductResponse' '202': $ref: '#/components/responses/DeprecatedPollingResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/consumertrend: description: 'Return the data needed to populate the consumer trend report, including trends and data of consumers, applications, and subscriptions, at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Consumer trend report description: Return the data needed to populate the consumer trend report, including trends and data of consumers, applications, and subscriptions, at space scope. operationId: reports_spaceConsumerTrend security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ConsumerTrendReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/consumertrend/mini-leaderboards/applications: description: 'Return the data for the application leaderboard in the consumer trend report, including top_data and bottom_data along with other metrics over time at the space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Consumer trend report application leaderboard description: Return the data for the application leaderboard in the consumer trend report, including top_data and bottom_data along with other metrics over time at the space scope. operationId: reports_spaceConsumerTrendApplicationsLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ConsumerTrendLeaderboardReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/consumertrend/mini-leaderboards/consumerorgs: description: 'Return the data for the consumerorg leaderboard in the consumer trend report, including top_data and bottom_data along with other metrics over time at the space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Consumer trend report consumer org leaderboard description: Return the data for the consumerorg leaderboard in the consumer trend report, including top_data and bottom_data along with other metrics over time at the space scope. operationId: reports_spacespaceConsumerTrendConsumerorgsLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ConsumerTrendLeaderboardReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/applications/{app-name}: description: 'Return the data for the application leaderboard in the consumer trend report, including API call counts and other metrics over time at the space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/app-name' get: summary: Application detail report description: Return the data for the application leaderboard in the consumer trend report, including API call counts and other metrics over time at the space scope. operationId: reports_spaceApplicationDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_limit_optional' - $ref: '#/components/parameters/api_offset_optional' - $ref: '#/components/parameters/product_limit_optional' - $ref: '#/components/parameters/product_offset_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ConsumerTrendLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/consumerorgs/{consumer-org-name}: description: 'Return the data for the consumerorg leaderboard in the consumer trend report, including API call counts and other metrics over time at the space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/consumer-org-name' get: summary: Consumer org detail report description: Return the data for the consumerorg leaderboard in the consumer trend report, including API call counts and other metrics over time at the space scope. operationId: reports_spaceConsumerorgDetail security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_limit_optional' - $ref: '#/components/parameters/api_offset_optional' - $ref: '#/components/parameters/app_limit_optional' - $ref: '#/components/parameters/app_offset_optional' - $ref: '#/components/parameters/product_limit_optional' - $ref: '#/components/parameters/product_offset_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ConsumerTrendLeaderboardDetailReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/usage-evolution/{usage-evolution-report-type}: description: 'Return the data needed to populate the Usage Evolution report at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/usage-evolution-report-type' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' get: summary: Usage Evolution report description: Return the data needed to populate the Usage Evolution report at space scope. operationId: reports_spaceUsageEvolution security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/UsageEvolutionReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/consumption: description: 'Return the data needed to populate the Consumption report at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Consumption report description: Return the data needed to populate the Consumption report at space scope. operationId: reports_spaceConsumption security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/daily_limit_optional' - $ref: '#/components/parameters/daily_offset_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' responses: '200': $ref: '#/components/responses/ConsumptionResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/diskusage/{report-type}: description: 'Return the data needed to populate the Disk Usage report at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/report-type' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' get: summary: Disk Usage report description: Return the data needed to populate the Disk Usage report at space scope. operationId: reports_spaceDiskusage security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' - $ref: '#/components/parameters/sort_optional' responses: '200': $ref: '#/components/responses/DiskUsageReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/ratelimit/status: description: 'Return applications approaching their rate limits with pagination support at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Rate limit status report description: Return applications approaching their rate limits with pagination support at space scope. This report identifies applications that are consuming their rate limit quotas and provides comprehensive details for notification purposes including application, product, plan, API, consumer organization, and rate limit quota information. operationId: reports_spaceRateLimitStatus security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/search_optional' - $ref: '#/components/parameters/sort_optional' - $ref: '#/components/parameters/rate_limit_status' responses: '200': $ref: '#/components/responses/RateLimitStatusResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/aiplatform: description: 'Return the data needed to populate the AI Platform report at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: AI Platform report description: Return the data needed to populate the AI Platform report at space scope. operationId: reports_spaceAiplatform security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/AiplatformReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/aiplatform/mini-leaderboards/aiplatform-providers: description: 'Return the data needed to populate the provider leaderboard for the AI Platforn report at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: AI Platform provider leaderboard description: Return the data needed to populate the provider leaderboard for the AI Platform report at space scope. operationId: reports_spaceAiplatformProviderLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/AiplatformLeaderboardReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/reports/aiplatform/mini-leaderboards/aiplatform-consumers: description: 'Return the data needed to populate the consumer leaderboard for the AI platform report at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: AI Platform consumer leaderboard description: Return the data needed to populate the consumer leaderboard for the AI platform report at space scope. operationId: reports_spaceAiplatformConsumerLeaderboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/report_ai_insights_optional' - $ref: '#/components/parameters/report_end_date_optional' - $ref: '#/components/parameters/report_forecast_optional' - $ref: '#/components/parameters/report_start_date_optional' - $ref: '#/components/parameters/report_timeframe_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' responses: '200': $ref: '#/components/responses/AiplatformLeaderboardReportResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/summary: description: 'Return a result set of analytics summary events scoped to the cloud. The items in the result set are determined by the passed in request query to this API. The order of the result set is sorted from newest to oldest events by specified ''datetime''. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: List summary events at cloud scope description: Returns a result set of analytics summary events scoped to the cloud. The items in the result set are determined by the passed in request query to this API. The order of the result set is sorted from newest to oldest events by specified 'datetime'. operationId: summary_cloudList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_ref_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/event_count_optional' - $ref: '#/components/parameters/event_fields_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/product_ref_optional' - $ref: '#/components/parameters/mcp_server_ref_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/sort_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/summary_event_id_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/timezone_optional' responses: '200': $ref: '#/components/responses/SummaryListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/summary/scroll: description: 'You can use the scroll operation to retrieve a large number of results. You can request an unlimited number of results in batches. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' post: summary: Scroll through summary results in batches description: Returns an initial batch of results following the requested size or a default of 1000 as well as a 'scroll_id'. Pass this scroll ID to the next scroll operation to get back the next batch of results. Typically, the scroll ID does not change between requests, but it can change, so make sure to always use the latest scroll ID. operationId: summary_cloudScroll security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_ref_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/event_count_optional' - $ref: '#/components/parameters/event_fields_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/product_ref_optional' - $ref: '#/components/parameters/mcp_server_ref_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/summary_event_id_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/timezone_optional' requestBody: content: application/json: schema: $ref: '#/components/schemas/ScrollRequest' application/yaml: schema: $ref: '#/components/schemas/ScrollRequest' responses: '200': $ref: '#/components/responses/ScrollResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/summary/scroll/delete: description: Clears the search context and results for a scrolling search. parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' post: summary: Clears the scroll search context description: Clears the scroll search context and results for a scrolling search. Should be used when the scroll context is not needed since otherwise it will stay open until it times out. operationId: summary_cloudScrollDelete security: - oauth: - api-analytics:view requestBody: content: application/json: schema: $ref: '#/components/schemas/ScrollDeleteRequest' application/yaml: schema: $ref: '#/components/schemas/ScrollDeleteRequest' responses: '200': $ref: '#/components/responses/ScrollDeleteResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/summary/{summary-event-id}: description: 'Return a single analytics summary event by ID scoped to the cloud. The item in the result set is determined by the passed in request query to this API. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/summary-event-id' - $ref: '#/components/parameters/event_count_optional' - $ref: '#/components/parameters/event_fields_optional' - $ref: '#/components/parameters/timezone_optional' get: summary: Get specific summary event at cloud scope description: Return a single analytics summary event by ID scoped to the cloud. The item in the result set is determined by the passed in request query to this API. operationId: summary_cloudGet security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/SummaryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/summary/count: description: 'Return a count of analytics summary events scoped to the cloud. The count in the result is the number of summary API events that match the passed in request query. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Count API calls for summary events at cloud scope description: Return the count of total API calls in analytics summary events scoped to the cloud that match the passed in request query. operationId: summary_cloudCount security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_ref_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/event_count_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/product_ref_optional' - $ref: '#/components/parameters/mcp_server_ref_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/summary_event_id_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' responses: '200': $ref: '#/components/responses/SummaryCountResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/summary: description: 'Return a result set of analytics summary events scoped to the organization. The items in the result set are determined by the passed in request query to this API. The order of the result set is sorted from newest to oldest events by specified ''datetime''. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: List summary events at provider organization scope description: Returns a result set of analytics summary events scoped to the organization. The items in the result set are determined by the passed in request query to this API. The order of the result set is sorted from newest to oldest events by specified 'datetime'. operationId: summary_orgList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_ref_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/event_count_optional' - $ref: '#/components/parameters/event_fields_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/product_ref_optional' - $ref: '#/components/parameters/mcp_server_ref_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/sort_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/summary_event_id_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/timezone_optional' responses: '200': $ref: '#/components/responses/SummaryListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/summary/scroll: description: 'You can use the scroll operation to retrieve a large number of results. You can request an unlimited number of results in batches. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' post: summary: Scroll through summary results in batches description: Returns an initial batch of results following the requested size or a default of 1000 as well as a 'scroll_id'. Pass this scroll ID to the next scroll operation to get back the next batch of results. Typically, the scroll ID does not change between requests, but it can change, so make sure to always use the latest scroll ID. operationId: summary_orgScroll security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_ref_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/event_count_optional' - $ref: '#/components/parameters/event_fields_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/product_ref_optional' - $ref: '#/components/parameters/mcp_server_ref_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/summary_event_id_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/timezone_optional' requestBody: content: application/json: schema: $ref: '#/components/schemas/ScrollRequest' application/yaml: schema: $ref: '#/components/schemas/ScrollRequest' responses: '200': $ref: '#/components/responses/ScrollResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/summary/scroll/delete: description: Clears the search context and results for a scrolling search. parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' post: summary: Clears the scroll search context description: Clears the scroll search context and results for a scrolling search. Should be used when the scroll context is not needed since otherwise it will stay open until it times out. operationId: summary_orgScrollDelete security: - oauth: - api-analytics:view requestBody: content: application/json: schema: $ref: '#/components/schemas/ScrollDeleteRequest' application/yaml: schema: $ref: '#/components/schemas/ScrollDeleteRequest' responses: '200': $ref: '#/components/responses/ScrollDeleteResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/summary/{summary-event-id}: description: 'Return a single analytics summary event by ID scoped to the organization. The item in the result set is determined by the passed in request query to this API. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/summary-event-id' - $ref: '#/components/parameters/event_count_optional' - $ref: '#/components/parameters/event_fields_optional' - $ref: '#/components/parameters/timezone_optional' get: summary: Get specific summary event at org scope description: Return a single analytics summary event by ID scoped to the org. The item in the result set is determined by the passed in request query to this API. operationId: summary_orgGet security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/SummaryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/summary/count: description: 'Return a count of analytics summary events scoped to the organization. The count in the result is the number of summary API events that match the passed in request query. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Count API calls for summary events at org scope description: Return the count of total API calls in analytics summary events scoped to the organization that match the passed in request query. operationId: summary_orgCount security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_ref_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/event_count_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/product_ref_optional' - $ref: '#/components/parameters/mcp_server_ref_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/summary_event_id_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' responses: '200': $ref: '#/components/responses/SummaryCountResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/summary: description: 'Return a result set of analytics summary events scoped to the catalog. The items in the result set are determined by the passed in request query to this API. The order of the result set is sorted from newest to oldest events by specified ''datetime''. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: List summary events at catalog scope description: Returns a result set of analytics summary events scoped to the catalog. The items in the result set are determined by the passed in request query to this API. The order of the result set is sorted from newest to oldest events by specified 'datetime'. operationId: summary_catalogList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_ref_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/event_count_optional' - $ref: '#/components/parameters/event_fields_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/product_ref_optional' - $ref: '#/components/parameters/mcp_server_ref_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/sort_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/summary_event_id_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/timezone_optional' responses: '200': $ref: '#/components/responses/SummaryListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/summary/{summary-event-id}: description: 'Return a single analytics summary event by ID scoped to the catalog. The item in the result set is determined by the passed in request query to this API. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/summary-event-id' - $ref: '#/components/parameters/event_count_optional' - $ref: '#/components/parameters/event_fields_optional' - $ref: '#/components/parameters/timezone_optional' get: summary: Get specific summary event at catalog scope description: Return a single analytics summary event by ID scoped to the catalog. The item in the result set is determined by the passed in request query to this API. operationId: summary_catalogGet security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/SummaryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/summary/count: description: 'Return a count of analytics summary events scoped to the catalog. The count in the result is the number of summary API events that match the passed in request query. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Count API calls for summary events at catalog scope description: Return the count of total API calls in analytics summary events scoped to the catalog that match the passed in request query. operationId: summary_catalogCount security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_ref_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/event_count_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/product_ref_optional' - $ref: '#/components/parameters/mcp_server_ref_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/summary_event_id_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' responses: '200': $ref: '#/components/responses/SummaryCountResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/summary: description: 'Return a result set of analytics summary events scoped to the space. The items in the result set are determined by the passed in request query to this API. The order of the result set is sorted from newest to oldest events by specified ''datetime''. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: List summary events at space scope description: Returns a result set of analytics summary events scoped to the space. The items in the result set are determined by the passed in request query to this API. The order of the result set is sorted from newest to oldest events by specified 'datetime'. operationId: summary_spaceList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_ref_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/event_count_optional' - $ref: '#/components/parameters/event_fields_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/product_ref_optional' - $ref: '#/components/parameters/mcp_server_ref_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/sort_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/summary_event_id_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/timezone_optional' responses: '200': $ref: '#/components/responses/SummaryListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/summary/{summary-event-id}: description: 'Return a single analytics summary event by ID scoped to the space. The item in the result set is determined by the passed in request query to this API. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' - $ref: '#/components/parameters/summary-event-id' - $ref: '#/components/parameters/event_count_optional' - $ref: '#/components/parameters/event_fields_optional' - $ref: '#/components/parameters/timezone_optional' get: summary: Get specific summary event at space scope description: Return a single analytics summary event by ID scoped to the space. The item in the result set is determined by the passed in request query to this API. operationId: summary_spaceGet security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/SummaryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/summary/count: description: 'Return a count of analytics summary events scoped to the space. The count in the result is the number of summary API events that match the passed in request query. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Count API calls for summary events at space scope description: Return the count of total API calls in analytics summary events scoped to the space that match the passed in request query. operationId: summary_spaceCount security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/api_ref_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/catalog_name_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/event_count_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/product_ref_optional' - $ref: '#/components/parameters/mcp_server_ref_optional' - $ref: '#/components/parameters/provider_org_name_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/summary_event_id_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' responses: '200': $ref: '#/components/responses/SummaryCountResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/cat/allocation: description: 'Provides a snapshot of the number of shards allocated to each data node and their disk space. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/bytes_optional' - $ref: '#/components/parameters/return_format_optional' - $ref: '#/components/parameters/local_optional' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/h_optional' - $ref: '#/components/parameters/help_optional' - $ref: '#/components/parameters/s_optional' - $ref: '#/components/parameters/v_columns_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Snapshot of the number of shards allocated to each data node and their disk… description: Provides a snapshot of the number of shards allocated to each data node and their disk space. operationId: clustermgmt_cat_getAllocation security: - oauth: - api-analytics:view responses: '200': description: Successful output of the _cat/allocation command content: text/plain: schema: $ref: '#/components/schemas/ClusterMgmtTextResponse' application/json: schema: $ref: '#/components/schemas/ClusterMgmtCatResponse' application/yaml: schema: $ref: '#/components/schemas/ClusterMgmtCatResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/cat/indices: description: 'Returns high-level information about indices in a cluster, including backing indices for data streams. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/bytes_optional' - $ref: '#/components/parameters/return_format_optional' - $ref: '#/components/parameters/h_optional' - $ref: '#/components/parameters/health_optional' - $ref: '#/components/parameters/help_optional' - $ref: '#/components/parameters/include_unloaded_segments_optional' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/pri_optional' - $ref: '#/components/parameters/s_optional' - $ref: '#/components/parameters/time_optional' - $ref: '#/components/parameters/v_columns_optional' - $ref: '#/components/parameters/expand_wildcards_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns high-level information about indices in a cluster description: Returns high-level information about indices in a cluster, including backing indices for data streams. operationId: clustermgmt_cat_getIndices security: - oauth: - api-analytics:view responses: '200': description: Successful output of the _cat/indices command content: text/plain: schema: $ref: '#/components/schemas/ClusterMgmtTextResponse' application/json: schema: $ref: '#/components/schemas/ClusterMgmtCatResponse' application/yaml: schema: $ref: '#/components/schemas/ClusterMgmtCatResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/cat/nodes: description: 'Returns information about a cluster''s nodes. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/bytes_optional' - $ref: '#/components/parameters/return_format_optional' - $ref: '#/components/parameters/full_id_optional' - $ref: '#/components/parameters/h_optional' - $ref: '#/components/parameters/help_optional' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/s_optional' - $ref: '#/components/parameters/time_optional' - $ref: '#/components/parameters/v_columns_optional' - $ref: '#/components/parameters/include_unloaded_segments_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Information about a cluster's nodes description: Returns information about a cluster's nodes. operationId: clustermgmt_cat_getNodes security: - oauth: - api-analytics:view responses: '200': description: Successful output of the _cat/nodes command content: text/plain: schema: $ref: '#/components/schemas/ClusterMgmtTextResponse' application/json: schema: $ref: '#/components/schemas/ClusterMgmtCatResponse' application/yaml: schema: $ref: '#/components/schemas/ClusterMgmtCatResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/cat/recovery: description: 'Returns information about ongoing and completed shard recoveries, similar to the index recovery API. For data streams, the API returns information about the stream''s backing indices. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/bytes_optional' - $ref: '#/components/parameters/detailed_optional' - $ref: '#/components/parameters/return_format_optional' - $ref: '#/components/parameters/h_optional' - $ref: '#/components/parameters/help_optional' - $ref: '#/components/parameters/index_optional' - $ref: '#/components/parameters/s_optional' - $ref: '#/components/parameters/time_optional' - $ref: '#/components/parameters/v_columns_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns information about ongoing and completed shard recoveries description: Returns information about ongoing and completed shard recoveries, similar to the index recovery API. For data streams, the API returns information about the stream's backing indices. operationId: clustermgmt_cat_getRecovery security: - oauth: - api-analytics:view responses: '200': description: Successful output of the _cat/recovery command content: text/plain: schema: $ref: '#/components/schemas/ClusterMgmtTextResponse' application/json: schema: $ref: '#/components/schemas/ClusterMgmtCatResponse' application/yaml: schema: $ref: '#/components/schemas/ClusterMgmtCatResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/cat/shards: description: 'The shards command is the detailed view of what nodes contain which shards. It will tell you if it''s a primary or replica, the number of docs, the bytes it takes on disk, and the node where it''s located. For data streams, the API returns information about the stream''s backing indices. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/bytes_optional' - $ref: '#/components/parameters/return_format_optional' - $ref: '#/components/parameters/h_optional' - $ref: '#/components/parameters/help_optional' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/s_optional' - $ref: '#/components/parameters/time_optional' - $ref: '#/components/parameters/v_columns_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Detailed view of what nodes contain which shards description: The shards command is the detailed view of what nodes contain which shards. It will tell you if it's a primary or replica, the number of docs, the bytes it takes on disk, and the node where it's located. For data streams, the API returns information about the stream's backing indices. operationId: clustermgmt_cat_getShards security: - oauth: - api-analytics:view responses: '200': description: Successful output of the _cat/shards command content: text/plain: schema: $ref: '#/components/schemas/ClusterMgmtTextResponse' application/json: schema: $ref: '#/components/schemas/ClusterMgmtCatResponse' application/yaml: schema: $ref: '#/components/schemas/ClusterMgmtCatResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/cat/aliases: description: 'Retrieves the cluster''s index aliases, including filter and routing information. The API does not return data stream aliases. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/return_format_optional' - $ref: '#/components/parameters/h_optional' - $ref: '#/components/parameters/help_optional' - $ref: '#/components/parameters/s_optional' - $ref: '#/components/parameters/v_columns_optional' - $ref: '#/components/parameters/expand_wildcards_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Retrieves the cluster's index aliases, including filter and routing information description: Retrieves the cluster's index aliases, including filter and routing information. The API does not return data stream aliases. operationId: clustermgmt_cat_getAliases security: - oauth: - api-analytics:view responses: '200': description: Successful output of the _cat/aliases command content: text/plain: schema: $ref: '#/components/schemas/ClusterMgmtTextResponse' application/json: schema: $ref: '#/components/schemas/ClusterMgmtCatResponse' application/yaml: schema: $ref: '#/components/schemas/ClusterMgmtCatResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/cat/tasks: description: 'Returns information about tasks currently executing on the cluster. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/return_format_optional' - $ref: '#/components/parameters/detailed_optional' - $ref: '#/components/parameters/actions_optional' - $ref: '#/components/parameters/nodes_optional' - $ref: '#/components/parameters/parent_task_id_optional' - $ref: '#/components/parameters/h_optional' - $ref: '#/components/parameters/help_optional' - $ref: '#/components/parameters/s_optional' - $ref: '#/components/parameters/time_optional' - $ref: '#/components/parameters/v_columns_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns information about tasks currently executing on the cluster description: Returns information about tasks currently executing on the cluster. operationId: clustermgmt_cat_getTasks security: - oauth: - api-analytics:view responses: '200': description: Successful output of the _cat/tasks command content: text/plain: schema: $ref: '#/components/schemas/ClusterMgmtTextResponse' application/json: schema: $ref: '#/components/schemas/ClusterMgmtCatResponse' application/yaml: schema: $ref: '#/components/schemas/ClusterMgmtCatResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/cat/thread-pool: description: 'Returns thread pool statistics for each node in the cluster. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/return_format_optional' - $ref: '#/components/parameters/h_optional' - $ref: '#/components/parameters/help_optional' - $ref: '#/components/parameters/local_optional' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/s_optional' - $ref: '#/components/parameters/v_columns_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns thread pool statistics for each node in the cluster description: Returns thread pool statistics for each node in the cluster. operationId: clustermgmt_cat_getThreadPool security: - oauth: - api-analytics:view responses: '200': description: Successful output of the _cat/thread_pool command content: text/plain: schema: $ref: '#/components/schemas/ClusterMgmtTextResponse' application/json: schema: $ref: '#/components/schemas/ClusterMgmtCatResponse' application/yaml: schema: $ref: '#/components/schemas/ClusterMgmtCatResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/cat/thread-pool/{thread-pool-patterns}: description: 'Returns thread pool statistics for matching thread pool patterns for each node in the cluster. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/thread-pool-patterns' - $ref: '#/components/parameters/return_format_optional' - $ref: '#/components/parameters/h_optional' - $ref: '#/components/parameters/help_optional' - $ref: '#/components/parameters/local_optional' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/s_optional' - $ref: '#/components/parameters/v_columns_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns thread pool statistics for matching thread pool patterns description: Returns thread pool statistics for matching thread pool patterns for each node in the cluster. operationId: clustermgmt_cat_getThreadPoolByPatterns security: - oauth: - api-analytics:view responses: '200': description: Successful output of the _cat/thread_pool command content: text/plain: schema: $ref: '#/components/schemas/ClusterMgmtTextResponse' application/json: schema: $ref: '#/components/schemas/ClusterMgmtCatResponse' application/yaml: schema: $ref: '#/components/schemas/ClusterMgmtCatResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/cat/plugins: description: 'Returns information about installed OpenSearch plugins on each node. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/return_format_optional' - $ref: '#/components/parameters/h_optional' - $ref: '#/components/parameters/help_optional' - $ref: '#/components/parameters/local_optional' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/s_optional' - $ref: '#/components/parameters/time_optional' - $ref: '#/components/parameters/v_columns_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns information about installed OpenSearch plugins description: Returns information about installed OpenSearch plugins on each node. operationId: clustermgmt_cat_getPlugins security: - oauth: - api-analytics:view responses: '200': description: Successful output of the _cat/plugins command content: text/plain: schema: $ref: '#/components/schemas/ClusterMgmtTextResponse' application/json: schema: $ref: '#/components/schemas/ClusterMgmtCatResponse' application/yaml: schema: $ref: '#/components/schemas/ClusterMgmtCatResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/cat/segments: description: 'Returns low-level information about the Lucene segments in index shards. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/bytes_optional' - $ref: '#/components/parameters/return_format_optional' - $ref: '#/components/parameters/h_optional' - $ref: '#/components/parameters/help_optional' - $ref: '#/components/parameters/s_optional' - $ref: '#/components/parameters/v_columns_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns Lucene segment information description: Returns low-level information about the Lucene segments in index shards. operationId: clustermgmt_cat_getSegments security: - oauth: - api-analytics:view responses: '200': description: Successful output of the _cat/segments command content: text/plain: schema: $ref: '#/components/schemas/ClusterMgmtTextResponse' application/json: schema: $ref: '#/components/schemas/ClusterMgmtCatResponse' application/yaml: schema: $ref: '#/components/schemas/ClusterMgmtCatResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/cat/segments/{index}: description: 'Returns low-level information about the Lucene segments in index shards for a specific index. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/bytes_optional' - $ref: '#/components/parameters/return_format_optional' - $ref: '#/components/parameters/h_optional' - $ref: '#/components/parameters/help_optional' - $ref: '#/components/parameters/s_optional' - $ref: '#/components/parameters/v_columns_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns Lucene segment information for a specific index description: Returns low-level information about the Lucene segments in index shards for a specific index. operationId: clustermgmt_cat_getSegmentsByIndex security: - oauth: - api-analytics:view responses: '200': description: Successful output of the _cat/segments command content: text/plain: schema: $ref: '#/components/schemas/ClusterMgmtTextResponse' application/json: schema: $ref: '#/components/schemas/ClusterMgmtCatResponse' application/yaml: schema: $ref: '#/components/schemas/ClusterMgmtCatResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/cat/fielddata: description: 'Returns the amount of memory used by fielddata on every node. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/bytes_optional' - $ref: '#/components/parameters/return_format_optional' - $ref: '#/components/parameters/h_optional' - $ref: '#/components/parameters/help_optional' - $ref: '#/components/parameters/s_optional' - $ref: '#/components/parameters/v_columns_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns fielddata memory usage description: Returns the amount of memory used by fielddata on every node. operationId: clustermgmt_cat_getFielddata security: - oauth: - api-analytics:view responses: '200': description: Successful output of the _cat/fielddata command content: text/plain: schema: $ref: '#/components/schemas/ClusterMgmtTextResponse' application/json: schema: $ref: '#/components/schemas/ClusterMgmtCatResponse' application/yaml: schema: $ref: '#/components/schemas/ClusterMgmtCatResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/cat/fielddata/{fields}: description: 'Returns the amount of memory used by fielddata for specific fields on every node. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/bytes_optional' - $ref: '#/components/parameters/return_format_optional' - $ref: '#/components/parameters/h_optional' - $ref: '#/components/parameters/help_optional' - $ref: '#/components/parameters/s_optional' - $ref: '#/components/parameters/v_columns_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns fielddata memory usage for specific fields description: Returns the amount of memory used by fielddata for specific fields on every node. operationId: clustermgmt_cat_getFielddataByFields security: - oauth: - api-analytics:view responses: '200': description: Successful output of the _cat/fielddata command content: text/plain: schema: $ref: '#/components/schemas/ClusterMgmtTextResponse' application/json: schema: $ref: '#/components/schemas/ClusterMgmtCatResponse' application/yaml: schema: $ref: '#/components/schemas/ClusterMgmtCatResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/nodes: description: 'The cluster nodes info API allows to retrieve one or more (or all) of the cluster nodes information. All the nodes selective options are explained here. By default, it returns all attributes and core settings for a node. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/flat_settings_optional' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/timeout_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns cluster nodes information description: The cluster nodes info API allows to retrieve one or more (or all) of the cluster nodes information. All the nodes selective options are explained here. By default, it returns all attributes and core settings for a node. operationId: clustermgmt_nodes_getNodes security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/nodes/hot-threads: description: 'This API yields a breakdown of the hot threads on each selected node in the cluster. The output is plain text with a breakdown of each node''s top hot threads. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/ignore_idle_threads_optional' - $ref: '#/components/parameters/interval_optional' - $ref: '#/components/parameters/snapshots_optional' - $ref: '#/components/parameters/threads_optional' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/timeout_optional' - $ref: '#/components/parameters/type_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns the hot threads on each selected node in the cluster description: This API yields a breakdown of the hot threads on each selected node in the cluster. The output is plain text with a breakdown of each node's top hot threads. operationId: clustermgmt_nodes_getNodesHotThreads security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/nodes/stats: description: 'You can use the cluster nodes stats API to retrieve statistics for nodes in a cluster. All the nodes selective options are explained here. By default, all stats are returned. You can limit the returned information by using metrics. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/completion_fields_optional' - $ref: '#/components/parameters/fielddata_fields_optional' - $ref: '#/components/parameters/fields_optional' - $ref: '#/components/parameters/groups_optional' - $ref: '#/components/parameters/level_optional' - $ref: '#/components/parameters/types_optional' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/timeout_optional' - $ref: '#/components/parameters/include_segment_file_sizes_optional' - $ref: '#/components/parameters/include_unloaded_segments_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns cluster nodes statistics description: You can use the cluster nodes stats API to retrieve statistics for nodes in a cluster. All the nodes selective options are explained here. By default, all stats are returned. You can limit the returned information by using metrics. operationId: clustermgmt_nodes_getNodesStats security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/nodes/usage: description: 'The cluster nodes usage API allows you to retrieve information on the usage of features for each node. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/timeout_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns information on the usage of features description: The cluster nodes usage API allows you to retrieve information on the usage of features for each node. operationId: clustermgmt_nodes_getNodesUsage security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/nodes/stats/{metric}: description: 'You can use the cluster nodes stats API to retrieve statistics for nodes in a cluster. All the nodes selective options are explained here. By default, all stats are returned. You can limit the returned information by using metrics. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/metric' - $ref: '#/components/parameters/completion_fields_optional' - $ref: '#/components/parameters/fielddata_fields_optional' - $ref: '#/components/parameters/groups_optional' - $ref: '#/components/parameters/level_optional' - $ref: '#/components/parameters/types_optional' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/timeout_optional' - $ref: '#/components/parameters/include_segment_file_sizes_optional' - $ref: '#/components/parameters/include_unloaded_segments_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns cluster nodes statistics description: You can use the cluster nodes stats API to retrieve statistics for nodes in a cluster. All the nodes selective options are explained here. By default, all stats are returned. You can limit the returned information by using metrics. operationId: clustermgmt_nodes_getStatsMetric security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/nodes/usage/{metric}: description: 'The cluster nodes usage API allows you to retrieve information on the usage of features for each node. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/metric' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/timeout_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns information on the usage of features description: The cluster nodes usage API allows you to retrieve information on the usage of features for each node. operationId: clustermgmt_nodes_getUsageMetric security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/nodes/{node-id-or-metric}: description: 'The cluster nodes info API allows to retrieve one or more (or all) of the cluster nodes information. By default, it returns all attributes and core settings for a node. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/node-id-or-metric' - $ref: '#/components/parameters/flat_settings_optional' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/timeout_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns cluster nodes information description: The cluster nodes info API allows to retrieve one or more (or all) of the cluster nodes information. By default, it returns all attributes and core settings for a node. operationId: clustermgmt_nodes_getNodesByIdOrMetric security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/nodes/{node-id}/hot-threads: description: 'This API yields a breakdown of the hot threads on each selected node in the cluster. The output is plain text with a breakdown of each node''s top hot threads. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/node-id' - $ref: '#/components/parameters/ignore_idle_threads_optional' - $ref: '#/components/parameters/interval_optional' - $ref: '#/components/parameters/snapshots_optional' - $ref: '#/components/parameters/threads_optional' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/timeout_optional' - $ref: '#/components/parameters/type_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns the hot threads on each selected node in the cluster description: This API yields a breakdown of the hot threads on each selected node in the cluster. The output is plain text with a breakdown of each node's top hot threads. operationId: clustermgmt_nodes_getNodesHotThreadsById security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/nodes/{node-id}/stats: description: 'You can use the cluster nodes stats API to retrieve statistics for nodes in a cluster. All the nodes selective options are explained here. By default, all stats are returned. You can limit the returned information by using metrics. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/node-id' - $ref: '#/components/parameters/completion_fields_optional' - $ref: '#/components/parameters/fielddata_fields_optional' - $ref: '#/components/parameters/fields_optional' - $ref: '#/components/parameters/groups_optional' - $ref: '#/components/parameters/level_optional' - $ref: '#/components/parameters/types_optional' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/timeout_optional' - $ref: '#/components/parameters/include_segment_file_sizes_optional' - $ref: '#/components/parameters/include_unloaded_segments_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns cluster nodes statistics description: You can use the cluster nodes stats API to retrieve statistics for nodes in a cluster. All the nodes selective options are explained here. By default, all stats are returned. You can limit the returned information by using metrics. operationId: clustermgmt_nodes_getNodesStatsById security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/nodes/{node-id}/usage: description: 'The cluster nodes usage API allows you to retrieve information on the usage of features for each node. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/node-id' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/timeout_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns information on the usage of features description: The cluster nodes usage API allows you to retrieve information on the usage of features for each node. operationId: clustermgmt_nodes_getNodesUsageById security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/nodes/{node-id}/{metric}: description: 'The cluster nodes info API allows to retrieve one or more (or all) of the cluster nodes information. By default, it returns all attributes and core settings for a node. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/node-id' - $ref: '#/components/parameters/metric' - $ref: '#/components/parameters/flat_settings_optional' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/timeout_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns cluster nodes information description: The cluster nodes info API allows to retrieve one or more (or all) of the cluster nodes information. By default, it returns all attributes and core settings for a node. operationId: clustermgmt_nodes_getNodeMetricById security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/nodes/{node-id}/stats/{metric}: description: 'You can use the cluster nodes stats API to retrieve statistics for nodes in a cluster. All the nodes selective options are explained here. By default, all stats are returned. You can limit the returned information by using metrics. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/node-id' - $ref: '#/components/parameters/metric' - $ref: '#/components/parameters/completion_fields_optional' - $ref: '#/components/parameters/fielddata_fields_optional' - $ref: '#/components/parameters/fields_optional' - $ref: '#/components/parameters/groups_optional' - $ref: '#/components/parameters/level_optional' - $ref: '#/components/parameters/types_optional' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/timeout_optional' - $ref: '#/components/parameters/include_segment_file_sizes_optional' - $ref: '#/components/parameters/include_unloaded_segments_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns cluster nodes statistics description: You can use the cluster nodes stats API to retrieve statistics for nodes in a cluster. All the nodes selective options are explained here. By default, all stats are returned. You can limit the returned information by using metrics. operationId: clustermgmt_nodes_getNodesStatsByIdMetric security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/nodes/{node-id}/stats/{metric}/{index-metric}: description: 'You can use the cluster nodes stats API to retrieve statistics for nodes in a cluster. All the nodes selective options are explained here. By default, all stats are returned. You can limit the returned information by using metrics. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/node-id' - $ref: '#/components/parameters/metric' - $ref: '#/components/parameters/index-metric' - $ref: '#/components/parameters/completion_fields_optional' - $ref: '#/components/parameters/fielddata_fields_optional' - $ref: '#/components/parameters/fields_optional' - $ref: '#/components/parameters/groups_optional' - $ref: '#/components/parameters/level_optional' - $ref: '#/components/parameters/types_optional' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/timeout_optional' - $ref: '#/components/parameters/include_segment_file_sizes_optional' - $ref: '#/components/parameters/include_unloaded_segments_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Result of _nodes/:nodeId description: Returns the result of nodes/:nodeId on OpenSearch operationId: clustermgmt_nodes_getNodeMetricByIdMetricIndex security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/nodes/{node-id}/usage/{metric}: description: 'The cluster nodes usage API allows you to retrieve information on the usage of features for each node. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/node-id' - $ref: '#/components/parameters/metric' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/timeout_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns information on the usage of features description: The cluster nodes usage API allows you to retrieve information on the usage of features for each node. operationId: clustermgmt_nodes_getNodesUsageByIdMetric security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/nodes/reload-secure-settings: description: 'Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. That is, you can change them on disk and reload them without restarting any nodes in the cluster. When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' post: summary: Reloads the keystore on nodes in the cluster description: Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. That is, you can change them on disk and reload them without restarting any nodes in the cluster. When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node. operationId: clustermgmt_nodes_postReloadSecureSettings security: - oauth: - api-analytics:view requestBody: content: application/json: schema: $ref: '#/components/schemas/SecureSettingsPassword' application/yaml: schema: $ref: '#/components/schemas/SecureSettingsPassword' responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/nodes/{node-id}/reload-secure-settings: description: 'Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. That is, you can change them on disk and reload them without restarting any nodes in the cluster. When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/node-id' post: summary: Reloads the keystore on nodes in the cluster description: Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. That is, you can change them on disk and reload them without restarting any nodes in the cluster. When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node. operationId: clustermgmt_nodes_postReloadSecureSettingsById security: - oauth: - api-analytics:view requestBody: content: application/json: schema: $ref: '#/components/schemas/SecureSettingsPassword' application/yaml: schema: $ref: '#/components/schemas/SecureSettingsPassword' responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/cluster/allocation/explain: description: 'The purpose of the cluster allocation explain API is to provide explanations for shard allocations in the cluster. For unassigned shards, the explain API provides an explanation for why the shard is unassigned. For assigned shards, the explain API provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/include_disk_info_optional' - $ref: '#/components/parameters/include_yes_decisions_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Result of _cluster/allocation/explain description: The purpose of the cluster allocation explain API is to provide explanations for shard allocations in the cluster. For unassigned shards, the explain API provides an explanation for why the shard is unassigned. For assigned shards, the explain API provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node. operationId: clustermgmt_cluster_getAllocationExplain security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/cluster/voting-config-exclusions: description: 'By default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks. If you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, you must use this API to remove departed nodes from the voting configuration manually. It adds an entry for that node in the voting configuration exclusions list. The cluster then tries to reconfigure the voting configuration to remove that node and to prevent it from returning. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/master_timeout_optional' delete: summary: Removes master-eligible nodes from the voting configuration exclusion list description: Removes master-eligible nodes from the voting configuration exclusion list. parameters: - $ref: '#/components/parameters/wait_for_removal_optional' operationId: clustermgmt_cluster_deleteVotingConfigExclusions security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics post: summary: Adds master-eligible nodes from the voting configuration exclusion list description: Adds master-eligible nodes from the voting configuration exclusion list. parameters: - $ref: '#/components/parameters/node_ids_optional' - $ref: '#/components/parameters/node_names_optional' - $ref: '#/components/parameters/voting_timeout_optional' operationId: clustermgmt_cluster_postVotingConfigExclusions security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/cluster/health: description: 'The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream''s backing indices. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/level_optional' - $ref: '#/components/parameters/local_optional' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/timeout_optional' - $ref: '#/components/parameters/wait_for_active_shards_optional' - $ref: '#/components/parameters/wait_for_events_optional' - $ref: '#/components/parameters/wait_for_no_initializing_shards_optional' - $ref: '#/components/parameters/wait_for_no_relocating_shards_optional' - $ref: '#/components/parameters/wait_for_nodes_optional' - $ref: '#/components/parameters/wait_for_status_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns the health status of a cluster description: The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream's backing indices. operationId: clustermgmt_cluster_getHealth security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/cluster/pending-tasks: description: 'The pending cluster tasks API returns a list of any cluster-level changes (e.g. create index, update mapping, allocate or fail shard) which have not yet been executed. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/local_optional' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns cluster-level changes that have not yet been executed description: The pending cluster tasks API returns a list of any cluster-level changes (e.g. create index, update mapping, allocate or fail shard) which have not yet been executed. operationId: clustermgmt_cluster_getPendingTasks security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/cluster/settings: description: 'Manages cluster-wide settings. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/flat_settings_optional' - $ref: '#/components/parameters/include_defaults_optional' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/timeout_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns cluster-wide settings description: By default, this API call only returns settings that have been explicitly defined, but can also include the default settings by calling the include_defaults parameter. operationId: clustermgmt_cluster_getSettings security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics put: summary: Configures dynamic cluster settings description: You can configure and update dynamic settings on a running cluster using the cluster update settings API. Updates made using the cluster update settings API can be persistent, which apply across cluster restarts, or transient, which reset after a cluster restart. You can also reset transient or persistent settings by assigning them a null value using the API. operationId: clustermgmt_cluster_putSettings security: - oauth: - api-analytics:view requestBody: content: application/json: schema: $ref: '#/components/schemas/Settings' application/yaml: schema: $ref: '#/components/schemas/Settings' responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/cluster/state: description: 'The cluster state is an internal data structure which keeps track of a variety of information needed by every node. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/allow_no_indices_optional' - $ref: '#/components/parameters/expand_wildcards_optional' - $ref: '#/components/parameters/flat_settings_optional' - $ref: '#/components/parameters/ignore_unavailable_optional' - $ref: '#/components/parameters/local_optional' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/wait_for_metadata_version_optional' - $ref: '#/components/parameters/wait_for_timeout_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns an internal representation of the cluster state for debugging or… description: The cluster state is an internal data structure which keeps track of a variety of information needed by every node. operationId: clustermgmt_cluster_getState security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/cluster/state/{metrics}: description: 'The cluster state is an internal data structure which keeps track of a variety of information needed by every node. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/metrics' - $ref: '#/components/parameters/allow_no_indices_optional' - $ref: '#/components/parameters/expand_wildcards_optional' - $ref: '#/components/parameters/flat_settings_optional' - $ref: '#/components/parameters/ignore_unavailable_optional' - $ref: '#/components/parameters/local_optional' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/wait_for_metadata_version_optional' - $ref: '#/components/parameters/wait_for_timeout_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns an internal representation of the cluster state for debugging or… description: The cluster state is an internal data structure which keeps track of a variety of information needed by every node. operationId: clustermgmt_cluster_getStateByMetrics security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/cluster/state/{metrics}/{target}: description: 'The cluster state is an internal data structure which keeps track of a variety of information needed by every node. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/metrics' - $ref: '#/components/parameters/target' - $ref: '#/components/parameters/allow_no_indices_optional' - $ref: '#/components/parameters/expand_wildcards_optional' - $ref: '#/components/parameters/flat_settings_optional' - $ref: '#/components/parameters/ignore_unavailable_optional' - $ref: '#/components/parameters/local_optional' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/wait_for_metadata_version_optional' - $ref: '#/components/parameters/wait_for_timeout_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns an internal representation of the cluster state for debugging or… description: The cluster state is an internal data structure which keeps track of a variety of information needed by every node. operationId: clustermgmt_cluster_getStateByMetricsTarget security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/cluster/stats: description: 'The Cluster Stats API allows to retrieve statistics from a cluster wide perspective. The API returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/timeout_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns cluster statistics description: The Cluster Stats API allows to retrieve statistics from a cluster wide perspective. The API returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). operationId: clustermgmt_cluster_getStats security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/cluster/stats/nodes/{node-filter}: description: 'The Cluster Stats API allows to retrieve statistics from a cluster wide perspective. The API returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/node-filter' - $ref: '#/components/parameters/timeout_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Returns cluster statistics description: The Cluster Stats API allows to retrieve statistics from a cluster wide perspective. The API returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). operationId: clustermgmt_cluster_getStatsByNodeFilter security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/cluster/reroute: description: 'The reroute command allows for manual changes to the allocation of individual shards in the cluster. For example, a shard can be moved from one node to another explicitly, an allocation can be cancelled, and an unassigned shard can be explicitly allocated to a specific node. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/dry_run_optional' - $ref: '#/components/parameters/explain_optional' - $ref: '#/components/parameters/metric_optional' - $ref: '#/components/parameters/retry_failed_optional' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/timeout_optional' - $ref: '#/components/parameters/pretty_optional' post: summary: Changes the allocation of shards in a cluster description: The reroute command allows for manual changes to the allocation of individual shards in the cluster. For example, a shard can be moved from one node to another explicitly, an allocation can be cancelled, and an unassigned shard can be explicitly allocated to a specific node. operationId: clustermgmt_cluster_postReroute security: - oauth: - api-analytics:view requestBody: content: application/json: schema: $ref: '#/components/schemas/RerouteBody' application/yaml: schema: $ref: '#/components/schemas/RerouteBody' responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/ingestion/node/pipelines: description: 'Provides pipeline-specific information and settings for each pipeline. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/return_format_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Pipeline-specific information and settings for each pipeline description: Provides pipeline-specific information and settings for each pipeline. operationId: clustermgmt_ingestionNode_getIngestionPipelines security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtIngestionResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/ingestion/node/os: description: 'Provides node-level info about the OS. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/return_format_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Node-level info about the OS description: Provides node-level info about the OS. operationId: clustermgmt_ingestionNode_getIngestionOs security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtIngestionResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/ingestion/node/jvm: description: 'Provides node-level JVM info, including info about threads. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/return_format_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Node-level JVM info, including info about threads description: Provides node-level JVM info, including info about threads. operationId: clustermgmt_ingestionNode_getIngestionJvm security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtIngestionResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/ingestion/node/plugins: description: 'Provides information about all Logstash plugins that are currently installed. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/return_format_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Information about all Logstash plugins that are currently installed description: Provides information about all Logstash plugins that are currently installed. operationId: clustermgmt_ingestionNode_getIngestionPlugins security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtIngestionResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/ingestion/node/hot_threads: description: 'Provides information about the the current hot threads for Logstash. It contains a breakdown of the top hot threads. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/return_format_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Information about the the current hot threads for Logstash description: Provides information about the the current hot threads for Logstash. It contains a breakdown of the top hot threads. operationId: clustermgmt_ingestionNode_getIngestionHotThreads security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtIngestionResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/ingestion/node/stats/jvm: description: 'Provides JVM stats, including stats about threads, memory usage, garbage collectors, and uptime. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/return_format_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: JVM stats, including stats about threads, memory usage, garbage collectors, and… description: Provides JVM stats, including stats about threads, memory usage, garbage collectors, and uptime. operationId: clustermgmt_ingestionNode_getIngestionJvmNodeStats security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtIngestionResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/ingestion/node/stats/process: description: 'Provides process stats, including stats about file descriptors, memory consumption, and CPU usage. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/return_format_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Process stats, including stats about file descriptors, memory consumption, and… description: Provides process stats, including stats about file descriptors, memory consumption, and CPU usage. operationId: clustermgmt_ingestionNode_getIngestionProcessNodeStats security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtIngestionResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/ingestion/node/stats/events: description: 'Provides event-related statistics for the Logstash instance regardless of how many pipelines were created and destroyed. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/return_format_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Event-related statistics for the Logstash instance regardless of how many… description: Provides event-related statistics for the Logstash instance regardless of how many pipelines were created and destroyed. operationId: clustermgmt_ingestionNode_getIngestionEventsNodeStats security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtIngestionResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/ingestion/node/stats/flow: description: 'Provides flow-related statistics for the Logstash instance regardless of how many pipelines were created and destroyed. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/return_format_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Flow-related statistics for the Logstash instance regardless of how many… description: Provides flow-related statistics for the Logstash instance regardless of how many pipelines were created and destroyed. operationId: clustermgmt_ingestionNode_getIngestionFlowNodeStats security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtIngestionResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/ingestion/node/stats/pipelines: description: 'Provides runtime stats about each Logstash pipeline. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/return_format_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Runtime stats about each Logstash pipeline description: Provides runtime stats about each Logstash pipeline. operationId: clustermgmt_ingestionNode_getIngestionPipelinesNodeStats security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtIngestionResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/ingestion/node/stats/reloads: description: 'Provides runtime stats about config reload successes and failures. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/return_format_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Runtime stats about config reload successes and failures description: Provides runtime stats about config reload successes and failures. operationId: clustermgmt_ingestionNode_getIngestionReloadsNodeStats security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtIngestionResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/ingestion/node/stats/os: description: 'Provides runtime stats about cgroups when Logstash is running in a container. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/return_format_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Runtime stats about cgroups when Logstash is running in a container description: Provides runtime stats about cgroups when Logstash is running in a container. operationId: clustermgmt_ingestionNode_getIngestionOsNodeStats security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtIngestionResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/ingestion/node/stats/geoip_download_manager: description: 'Provides stats for databases used with the Geoip filter plugin. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/return_format_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Stats for databases used with the Geoip filter plugin description: Provides stats for databases used with the Geoip filter plugin. operationId: clustermgmt_ingestionNode_getIngestionGeoipDownloadManagerNodeStats security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtIngestionResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/ingestion/node: description: 'Provides cluster nodes information. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/return_format_optional' - $ref: '#/components/parameters/pretty_optional' get: summary: Cluster nodes information description: Provides cluster nodes information. operationId: clustermgmt_ingestionNode_getIngestionNodeInfo security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtIngestionResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/regenerate-passwords: description: 'Regenerates OpenSearch internal user passwords. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' post: summary: Generates new passwords for OpenSearch internal users description: Triggers password regeneration for OpenSearch internal users. Typically used to rotate credentials securely and update internal user authentication details. operationId: clustermgmt_regenerate_postRegeneratePasswords security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/remote/info: description: 'The cluster remote info API allows you to retrieve all of the configured remote cluster information. It returns connection and endpoint information keyed by the configured remote cluster alias. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Returns configured remote cluster information description: The cluster remote info API allows you to retrieve all of the configured remote cluster information. It returns connection and endpoint information keyed by the configured remote cluster alias. operationId: clustermgmt_cluster_getRemoteInfo security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/tasks: description: 'Returns information about tasks currently executing on the cluster. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/actions_optional' - $ref: '#/components/parameters/detailed_optional' - $ref: '#/components/parameters/group_by_tasks_optional' - $ref: '#/components/parameters/nodes_optional' - $ref: '#/components/parameters/parent_task_id_optional' - $ref: '#/components/parameters/wait_for_completion_optional' get: summary: Returns information about tasks currently executing on the cluster description: Returns information about tasks currently executing on the cluster. operationId: clustermgmt_tasks_listTasks security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/tasks/stuck: description: 'Identifies long-running and stuck tasks with detailed metadata and cancellable status. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/threshold_ms_optional' - $ref: '#/components/parameters/actions_optional' get: summary: Identify long-running and stuck tasks description: Identifies long-running and stuck tasks with detailed metadata and cancellable status. operationId: clustermgmt_tasks_getStuckTasks security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/tasks/{task-id}: description: 'Returns information about a specific task. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/task-id' - $ref: '#/components/parameters/wait_for_completion_optional' get: summary: Returns information about a specific task description: Returns information about a specific task. operationId: clustermgmt_tasks_getTask security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/tasks/cancel: description: 'Cancels tasks matching query criteria. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/actions_optional' - $ref: '#/components/parameters/nodes_optional' - $ref: '#/components/parameters/parent_task_id_optional' post: summary: Cancels tasks matching query criteria description: Cancels tasks matching query criteria. operationId: clustermgmt_tasks_cancelTasks security: - oauth: - api-analytics:manage responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/tasks/{task-id}/cancel: description: 'Cancels a specific task by ID. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/task-id' - $ref: '#/components/parameters/actions_optional' - $ref: '#/components/parameters/nodes_optional' - $ref: '#/components/parameters/parent_task_id_optional' post: summary: Cancels a specific task by ID description: Cancels a specific task by ID. operationId: clustermgmt_tasks_cancelTaskById security: - oauth: - api-analytics:manage responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/tasks/emergency-drain: description: 'Performs emergency draining: cancels cancellable tasks, optionally disables threat intel monitors, and clears search caches. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/actions_optional' - $ref: '#/components/parameters/disable_monitors_optional' post: summary: Emergency drain tasks and clear search caches description: 'Performs emergency draining: cancels cancellable tasks, optionally disables threat intel monitors, and clears search caches.' operationId: clustermgmt_tasks_emergencyDrain security: - oauth: - api-analytics:manage responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/threat-intel/monitors: description: 'Lists configured Threat Intelligence monitors. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: List Threat Intelligence monitors description: Lists configured Threat Intelligence monitors. operationId: clustermgmt_tasks_listThreatIntelMonitors security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/threat-intel/monitors/disable-all: description: 'Disables all active Threat Intelligence monitors. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' post: summary: Disable all Threat Intelligence monitors description: Disables all active Threat Intelligence monitors. operationId: clustermgmt_tasks_disableAllThreatIntelMonitors security: - oauth: - api-analytics:manage responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/threat-intel/monitors/{monitor-id}/disable: description: 'Disables a specific Threat Intelligence monitor by ID. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/monitor-id' post: summary: Disable a Threat Intelligence monitor by ID description: Disables a specific Threat Intelligence monitor by ID. operationId: clustermgmt_tasks_disableThreatIntelMonitor security: - oauth: - api-analytics:manage responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/threat-intel/monitors/{monitor-id}/enable: description: 'Enables a specific Threat Intelligence monitor by ID. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/monitor-id' post: summary: Enable a Threat Intelligence monitor by ID description: Enables a specific Threat Intelligence monitor by ID. operationId: clustermgmt_tasks_enableThreatIntelMonitor security: - oauth: - api-analytics:manage responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/cluster/search-backpressure: description: 'Returns Search Backpressure and Workload Management (WLM) statistics. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Returns Search Backpressure and WLM statistics description: Returns Search Backpressure and Workload Management (WLM) statistics. operationId: clustermgmt_tasks_getSearchBackpressureStats security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/cluster/search-backpressure/mode: description: 'Updates Search Backpressure operational mode (enforced, monitor_only, disabled). ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' put: summary: Update Search Backpressure mode description: Updates Search Backpressure operational mode (enforced, monitor_only, disabled). operationId: clustermgmt_tasks_putSearchBackpressureMode security: - oauth: - api-analytics:manage responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/plugins/anomaly-detection/stats: description: 'Returns statistics about the Anomaly Detection plugin. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Returns Anomaly Detection plugin statistics description: Returns statistics about the Anomaly Detection plugin. operationId: clustermgmt_plugins_getAnomalyDetectionStats security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/plugins/anomaly-detection/stats/{node-metric}: description: 'Returns statistics about the Anomaly Detection plugin filtered by node or metric. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/node-metric' get: summary: Returns filtered Anomaly Detection plugin statistics description: Returns statistics about the Anomaly Detection plugin filtered by node or metric. operationId: clustermgmt_plugins_getAnomalyDetectionStatsByNodeMetric security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/plugins/security-analytics/stats: description: 'Returns statistics about the Security Analytics plugin. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Returns Security Analytics plugin statistics description: Returns statistics about the Security Analytics plugin. operationId: clustermgmt_plugins_getSecurityAnalyticsStats security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/plugins/security-analytics/stats/{node-metric}: description: 'Returns statistics about the Security Analytics plugin filtered by node or metric. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/node-metric' get: summary: Returns filtered Security Analytics plugin statistics description: Returns statistics about the Security Analytics plugin filtered by node or metric. operationId: clustermgmt_plugins_getSecurityAnalyticsStatsByNodeMetric security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/plugins/alerting/stats: description: 'Returns statistics about the Alerting plugin. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Returns Alerting plugin statistics description: Returns statistics about the Alerting plugin. operationId: clustermgmt_plugins_getAlertingStats security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/plugins/alerting/stats/{node-metric}: description: 'Returns statistics about the Alerting plugin filtered by node or metric. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/node-metric' get: summary: Returns filtered Alerting plugin statistics description: Returns statistics about the Alerting plugin filtered by node or metric. operationId: clustermgmt_plugins_getAlertingStatsByNodeMetric security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/plugins/async-search/stats: description: 'Returns statistics about asynchronous search operations. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Returns asynchronous search statistics description: Returns statistics about asynchronous search operations. operationId: clustermgmt_plugins_getAsyncSearchStats security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/plugins/async-search/{id}: description: 'Retrieves or cancels an asynchronous search operation by ID. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/id' get: summary: Get asynchronous search by ID description: Retrieves the status and results of an asynchronous search operation. operationId: clustermgmt_plugins_getAsyncSearch security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics delete: summary: Delete or cancel asynchronous search by ID description: Deletes or cancels an asynchronous search operation. operationId: clustermgmt_plugins_deleteAsyncSearch security: - oauth: - api-analytics:manage responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/cluster/breakers: description: 'Returns circuit breaker statistics and current memory usage across cluster nodes. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Returns circuit breaker statistics description: Returns circuit breaker statistics and current memory usage across cluster nodes. operationId: clustermgmt_plugins_getCircuitBreakers security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/ism/explain: description: 'Explains the Index State Management (ISM) status for managed indices. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Explains ISM status for managed indices description: Explains the Index State Management (ISM) status for managed indices. operationId: clustermgmt_plugins_getIsmExplain security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/ism/explain/{index}: description: 'Explains the Index State Management (ISM) status for a specific index. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/index' get: summary: Explains ISM status for a specific index description: Explains the Index State Management (ISM) status for a specific index. operationId: clustermgmt_plugins_getIsmExplainByIndex security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/ism/policies: description: 'Returns configured Index State Management (ISM) lifecycle policies. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Returns ISM policies description: Returns configured Index State Management (ISM) lifecycle policies. operationId: clustermgmt_plugins_getIsmPolicies security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/ism/policies/{policy-id}: description: 'Returns a configured Index State Management (ISM) lifecycle policy by policy ID. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/policy-id' get: summary: Returns an ISM policy by ID description: Returns a configured Index State Management (ISM) lifecycle policy by policy ID. operationId: clustermgmt_plugins_getIsmPolicyById security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/ism/retry: description: 'Retries failed Index State Management (ISM) policy actions on managed indices. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' post: summary: Retry failed ISM actions description: Retries failed Index State Management (ISM) policy actions on managed indices. operationId: clustermgmt_plugins_retryIsm security: - oauth: - api-analytics:manage responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/ism/retry/{index}: description: 'Retries failed Index State Management (ISM) policy actions on a specific index. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/index' post: summary: Retry failed ISM actions on index description: Retries failed Index State Management (ISM) policy actions on a specific index. operationId: clustermgmt_plugins_retryIsmByIndex security: - oauth: - api-analytics:manage responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/settings: description: 'Manage opensearch settings. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Get opensearch settings description: Get opensearch settings. operationId: clustermgmt_settings_getStorageSettings security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/SettingsBodyResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics put: summary: Put opensearch settings description: Put opensearch settings. operationId: clustermgmt_settings_putStorageSettings requestBody: content: application/json: schema: $ref: '#/components/schemas/SettingsBody' application/yaml: schema: $ref: '#/components/schemas/SettingsBody' security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/SettingsBodyResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/recovery: description: 'Returns information about ongoing and completed shard recoveries for one or more indices. For data streams, the API returns information for the stream''s backing indices. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/active_only_optional' - $ref: '#/components/parameters/detailed_optional' get: summary: Use the index recovery API to get information about ongoing and completed shard… description: Returns information about ongoing and completed shard recoveries for one or more indices. For data streams, the API returns information for the stream's backing indices. operationId: clustermgmt_index_getRecovery security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/{index}/recovery: description: 'Returns information about ongoing and completed shard recoveries for one or more indices. For data streams, the API returns information for the stream''s backing indices. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/active_only_optional' - $ref: '#/components/parameters/detailed_optional' get: summary: Use the index recovery API to get information about ongoing and completed shard… description: Returns information about ongoing and completed shard recoveries for one or more indices. For data streams, the API returns information for the stream's backing indices. operationId: clustermgmt_index_getRecoveryByIndex security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/snapshot: parameters: - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/local_optional' - $ref: '#/components/parameters/cluster_manager_timeout_optional' get: summary: Get snapshot repositories description: Gets information about one or more registered snapshot repositories. operationId: clustermgmt_snapshot_getRepositories security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/snapshot/status: parameters: - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/ignore_unavailable_optional' get: summary: Get snapshot status description: Returns the status of all currently running snapshots in all repositories. operationId: clustermgmt_snapshot_getStatus security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/snapshot/{repository}: parameters: - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/repository' - $ref: '#/components/parameters/local_optional' - $ref: '#/components/parameters/cluster_manager_timeout_optional' get: summary: Get snapshot repository description: Gets information about one or more registered snapshot repositories by name. operationId: clustermgmt_snapshot_getRepository security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/snapshot/{repository}/status: parameters: - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/repository' - $ref: '#/components/parameters/ignore_unavailable_optional' get: summary: Get snapshot status by repository description: Returns the status of all currently running snapshots in a repository. operationId: clustermgmt_snapshot_getStatusByRepository security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/snapshot/{repository}/{snapshot}: parameters: - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/snapshot' - $ref: '#/components/parameters/repository' get: summary: Get snapshot description: Retrieves information about one or more snapshots. operationId: clustermgmt_snapshot_getSnapshot parameters: - $ref: '#/components/parameters/ignore_unavailable_optional' - $ref: '#/components/parameters/verbose_optional' security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics delete: summary: Delete snapshot description: Deletes one or more snapshots operationId: clustermgmt_snapshot_deleteSnapshot security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/snapshot/{repository}/{snapshot}/status: parameters: - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/snapshot' - $ref: '#/components/parameters/repository' - $ref: '#/components/parameters/ignore_unavailable_optional' get: summary: Get snapshot status by repository and snapshot description: Returns the status of a snapshot in a repository. operationId: clustermgmt_snapshot_getStatusByRepositorySnapshot security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/snapshot/{repository}/verify: parameters: - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/repository' - $ref: '#/components/parameters/cluster_manager_timeout_optional' - $ref: '#/components/parameters/timeout_optional' post: summary: Verify snapshot repository description: Verifies that a snapshot repository is functional. operationId: clustermgmt_snapshot_verifyRepository security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/{index}: description: 'Index APIs are used to manage individual indices, index settings, aliases, mappings, and index templates. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/index' get: summary: Returns indices information description: Returns information about one or more indices. For data streams, the API returns information about the stream's backing indices. operationId: clustermgmt_index_getIndex parameters: - $ref: '#/components/parameters/allow_no_indices_optional' - $ref: '#/components/parameters/expand_wildcards_optional' - $ref: '#/components/parameters/features_optional' - $ref: '#/components/parameters/flat_settings_optional' - $ref: '#/components/parameters/include_defaults_optional' - $ref: '#/components/parameters/ignore_unavailable_optional' - $ref: '#/components/parameters/local_optional' - $ref: '#/components/parameters/master_timeout_optional' security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics delete: summary: Deletes one or more indices description: Deleting an index deletes its documents, shards, and metadata. operationId: clustermgmt_index_deleteIndex parameters: - $ref: '#/components/parameters/allow_no_indices_optional' - $ref: '#/components/parameters/expand_wildcards_optional' - $ref: '#/components/parameters/force_delete_optional' - $ref: '#/components/parameters/ignore_unavailable_optional' security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics put: summary: Creates a new index description: You can use the create index API to add a new index to a cluster. operationId: clustermgmt_index_createIndex parameters: - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/timeout_optional' - $ref: '#/components/parameters/wait_for_active_shards_optional' security: - oauth: - api-analytics:view requestBody: content: application/json: schema: $ref: '#/components/schemas/IndexBody' application/yaml: schema: $ref: '#/components/schemas/IndexBody' responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/{index}/close: description: 'You use the close index API to close open indices. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/allow_no_indices_optional' - $ref: '#/components/parameters/expand_wildcards_optional' - $ref: '#/components/parameters/ignore_unavailable_optional' - $ref: '#/components/parameters/wait_for_active_shards_optional' - $ref: '#/components/parameters/timeout_optional' - $ref: '#/components/parameters/master_timeout_optional' post: summary: Closes an index description: You use the close index API to close open indices. operationId: clustermgmt_index_closeIndex security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/{index}/open: description: 'You can use the open index API to re-open closed indices. If the request targets a data stream, the request re-opens any of the stream''s closed backing indices. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/allow_no_indices_optional' - $ref: '#/components/parameters/expand_wildcards_optional' - $ref: '#/components/parameters/ignore_unavailable_optional' - $ref: '#/components/parameters/wait_for_active_shards_optional' - $ref: '#/components/parameters/timeout_optional' - $ref: '#/components/parameters/master_timeout_optional' post: summary: Opens a closed index. For data streams, the API opens any closed backing indices description: You can use the open index API to re-open closed indices. If the request targets a data stream, the request re-opens any of the stream's closed backing indices. operationId: clustermgmt_index_openIndex security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/{index}/shrink/{target}: description: 'The shrink index API allows you to shrink an existing index into a new index with fewer primary shards. The requested number of primary shards in the target index must be a factor of the number of shards in the source index. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/target' - $ref: '#/components/parameters/wait_for_active_shards_optional' - $ref: '#/components/parameters/timeout_optional' - $ref: '#/components/parameters/master_timeout_optional' post: summary: Shrinks an existing index into a new index with fewer primary shards description: The shrink index API allows you to shrink an existing index into a new index with fewer primary shards. The requested number of primary shards in the target index must be a factor of the number of shards in the source index. operationId: clustermgmt_index_shrinkIndex security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/{index}/split/{target}: description: 'The split index API allows you to split an existing index into a new index, where each original primary shard is split into two or more primary shards in the new index. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/target' - $ref: '#/components/parameters/wait_for_active_shards_optional' - $ref: '#/components/parameters/timeout_optional' - $ref: '#/components/parameters/master_timeout_optional' post: summary: Splits an existing index into a new index with more primary shards description: The split index API allows you to split an existing index into a new index, where each original primary shard is split into two or more primary shards in the new index. operationId: clustermgmt_index_splitIndex security: - oauth: - api-analytics:view requestBody: content: application/json: schema: $ref: '#/components/schemas/SplitBody' application/yaml: schema: $ref: '#/components/schemas/SplitBody' responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/{index}/clone/{target}: description: 'Use the clone index API to clone an existing index into a new index, where each original primary shard is cloned into a new primary shard in the new index. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/target' - $ref: '#/components/parameters/wait_for_active_shards_optional' - $ref: '#/components/parameters/timeout_optional' - $ref: '#/components/parameters/master_timeout_optional' post: summary: Clones an existing index description: Use the clone index API to clone an existing index into a new index, where each original primary shard is cloned into a new primary shard in the new index. operationId: clustermgmt_index_cloneIndex security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/{index}/rollover: description: 'The rollover API creates a new index for a data stream or index alias. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/dry_run_optional' - $ref: '#/components/parameters/wait_for_active_shards_optional' - $ref: '#/components/parameters/timeout_optional' - $ref: '#/components/parameters/master_timeout_optional' post: summary: Creates a new index for a data stream or index alias description: The rollover API creates a new index for a data stream or index alias. operationId: clustermgmt_index_rolloverIndex security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/{index}/rollover/{target}: description: 'The rollover API creates a new index for a data stream or index alias. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/target' - $ref: '#/components/parameters/dry_run_optional' - $ref: '#/components/parameters/wait_for_active_shards_optional' - $ref: '#/components/parameters/timeout_optional' - $ref: '#/components/parameters/master_timeout_optional' post: summary: Creates a new index for a data stream or index alias description: The rollover API creates a new index for a data stream or index alias. operationId: clustermgmt_index_rolloverToTarget security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/resolve/index/{index-name}: description: 'Resolves the specified name(s) and/or index patterns for indices, aliases and data streams. Multiple patterns and remote clusters are supported. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/index-name' - $ref: '#/components/parameters/expand_wildcards_optional' get: summary: Resolve name and index patterns for indices, aliases and data streams description: Resolves the specified name(s) and/or index patterns for indices, aliases and data streams. Multiple patterns and remote clusters are supported. operationId: clustermgmt_index_resolveIndex security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/{index}/flush: description: 'Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/index' - $ref: '#/components/parameters/allow_no_indices_optional' - $ref: '#/components/parameters/expand_wildcards_optional' - $ref: '#/components/parameters/force_optional' - $ref: '#/components/parameters/ignore_unavailable_optional' - $ref: '#/components/parameters/wait_if_ongoing_optional' get: summary: Flushes one or more data streams or indices description: Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. operationId: clustermgmt_index_getFlushByIndex security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics post: summary: Flushes one or more data streams or indices description: Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. operationId: clustermgmt_index_postFlushByIndex security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/flush: description: 'Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/allow_no_indices_optional' - $ref: '#/components/parameters/expand_wildcards_optional' - $ref: '#/components/parameters/force_optional' - $ref: '#/components/parameters/ignore_unavailable_optional' - $ref: '#/components/parameters/wait_if_ongoing_optional' get: summary: Flushes one or more data streams or indices description: Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. operationId: clustermgmt_index_getFlush security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics post: summary: Flushes one or more data streams or indices description: Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. operationId: clustermgmt_index_postFlush security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/{target}/alias/{alias}: description: 'Performs an action for one or more aliases. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/target' - $ref: '#/components/parameters/alias' get: summary: Retrieves information for one or more aliases description: Retrieves information for one or more aliases. operationId: clustermgmt_index_getAliasByIndexAlias parameters: - $ref: '#/components/parameters/allow_no_indices_optional' - $ref: '#/components/parameters/expand_wildcards_optional' - $ref: '#/components/parameters/ignore_unavailable_optional' - $ref: '#/components/parameters/local_optional' security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics put: summary: Adds a data stream or index to an alias description: Adds a data stream or index to an alias. operationId: clustermgmt_index_putAliasByIndexAlias parameters: - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/timeout_optional' security: - oauth: - api-analytics:view requestBody: content: application/json: schema: $ref: '#/components/schemas/AliasBody' application/yaml: schema: $ref: '#/components/schemas/AliasBody' responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics post: summary: Adds a data stream or index to an alias description: Adds a data stream or index to an alias. operationId: clustermgmt_index_postAliasByIndexAlias parameters: - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/timeout_optional' security: - oauth: - api-analytics:view requestBody: content: application/json: schema: $ref: '#/components/schemas/AliasBody' application/yaml: schema: $ref: '#/components/schemas/AliasBody' responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics delete: summary: Removes a data stream or index from an alias description: Removes a data stream or index from an alias. operationId: clustermgmt_index_deleteAliasByIndexAlias parameters: - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/timeout_optional' security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/alias: description: 'Retrieves information for one or more aliases. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/allow_no_indices_optional' - $ref: '#/components/parameters/expand_wildcards_optional' - $ref: '#/components/parameters/ignore_unavailable_optional' - $ref: '#/components/parameters/local_optional' get: summary: Retrieves information for one or more aliases description: Retrieves information for one or more aliases. operationId: clustermgmt_index_getAlias security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/alias/{alias}: description: 'Retrieves information for one or more aliases. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/alias' - $ref: '#/components/parameters/allow_no_indices_optional' - $ref: '#/components/parameters/expand_wildcards_optional' - $ref: '#/components/parameters/ignore_unavailable_optional' - $ref: '#/components/parameters/local_optional' get: summary: Retrieves information for one or more aliases description: Retrieves information for one or more aliases. operationId: clustermgmt_index_getAliasbyName security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/storage/aliases: description: 'Performs one or more alias actions in a single atomic operation. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/master_timeout_optional' - $ref: '#/components/parameters/timeout_optional' post: summary: Performs one or more alias actions in a single atomic operation description: Performs one or more alias actions in a single atomic operation. operationId: clustermgmt_index_postAliases requestBody: content: application/json: schema: $ref: '#/components/schemas/AliasesBody' application/yaml: schema: $ref: '#/components/schemas/AliasesBody' security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/ClusterMgmtObjectResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/audit/filterparameters: description: 'Return the list of audit filter parameters supported at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: description: Return the list of audit filter parameters supported at cloud scope. summary: List audit filter parameters at cloud scope operationId: audit_cloudGetFilterParameters security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/AuditFilterParamListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/audit: description: 'Return a result set of audit records scoped to the cloud. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: List audits at cloud scope description: Returns a list of audit records from the cloud scope. operationId: audit_cloudList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/action_optional' - $ref: '#/components/parameters/audit_api_optional' - $ref: '#/components/parameters/audit_mcp_server_optional' - $ref: '#/components/parameters/audit_product_optional' - $ref: '#/components/parameters/audit_actor_optional' - $ref: '#/components/parameters/audit_area_optional' - $ref: '#/components/parameters/audit_changes_only_optional' - $ref: '#/components/parameters/attachments_optional' - $ref: '#/components/parameters/auditId_optional' - $ref: '#/components/parameters/audit_entity_optional' - $ref: '#/components/parameters/catalogId_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/eventGenerator_optional' - $ref: '#/components/parameters/initiator_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/logSourceCRN_optional' - $ref: '#/components/parameters/logSourceType_optional' - $ref: '#/components/parameters/observer_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/outcome_optional' - $ref: '#/components/parameters/providerOrgId_optional' - $ref: '#/components/parameters/reason_optional' - $ref: '#/components/parameters/requestData_optional' - $ref: '#/components/parameters/requestPath_optional' - $ref: '#/components/parameters/responseData_optional' - $ref: '#/components/parameters/sort_optional' - $ref: '#/components/parameters/spaceId_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/tags_optional' - $ref: '#/components/parameters/target_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/timezone_optional' - $ref: '#/components/parameters/typeURI_optional' responses: '200': $ref: '#/components/responses/AuditListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/audit/{audit-id}: description: 'Return a single audit record by ID from cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/audit-id' - $ref: '#/components/parameters/timezone_optional' get: summary: Get audit record at cloud scope description: Returns a specific audit record by ID. operationId: audit_cloudGet security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/AuditResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/audit/dashboards/{audit-dashboard}: description: 'Return the data for an audit dashboard, aggregated from the audit records for the cloud. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/audit-dashboard' get: summary: Get an audit dashboard at cloud scope description: Returns counts, time series and recent audit records for the requested audit dashboard. Accepts the same filters as the audit list. operationId: audit_cloudDashboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/action_optional' - $ref: '#/components/parameters/audit_api_optional' - $ref: '#/components/parameters/audit_mcp_server_optional' - $ref: '#/components/parameters/audit_product_optional' - $ref: '#/components/parameters/audit_actor_optional' - $ref: '#/components/parameters/audit_area_optional' - $ref: '#/components/parameters/audit_changes_only_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/attachments_optional' - $ref: '#/components/parameters/auditId_optional' - $ref: '#/components/parameters/audit_entity_optional' - $ref: '#/components/parameters/catalogId_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/eventGenerator_optional' - $ref: '#/components/parameters/initiator_optional' - $ref: '#/components/parameters/logSourceCRN_optional' - $ref: '#/components/parameters/logSourceType_optional' - $ref: '#/components/parameters/observer_optional' - $ref: '#/components/parameters/outcome_optional' - $ref: '#/components/parameters/providerOrgId_optional' - $ref: '#/components/parameters/reason_optional' - $ref: '#/components/parameters/requestData_optional' - $ref: '#/components/parameters/requestPath_optional' - $ref: '#/components/parameters/responseData_optional' - $ref: '#/components/parameters/spaceId_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/tags_optional' - $ref: '#/components/parameters/target_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/timezone_optional' - $ref: '#/components/parameters/typeURI_optional' responses: '200': $ref: '#/components/responses/AuditDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/audit/entities/{audit-entity-type}/{audit-entity-name}: description: 'Return the audit history of a product, API or MCP server across all organizations. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/audit-entity-name' - $ref: '#/components/parameters/audit-entity-type' get: summary: Get the audit history of a product, API or MCP server at cloud scope description: Returns a summary (first and last change, versions, actions, users and catalogs) and the audit records about the product, API or MCP server, including changes to its drafts, publishing and lifecycle changes. Accepts the same filters as the audit list. operationId: audit_cloudEntityHistory security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/action_optional' - $ref: '#/components/parameters/audit_actor_optional' - $ref: '#/components/parameters/audit_area_optional' - $ref: '#/components/parameters/audit_changes_only_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/attachments_optional' - $ref: '#/components/parameters/auditId_optional' - $ref: '#/components/parameters/catalogId_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/eventGenerator_optional' - $ref: '#/components/parameters/initiator_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/logSourceCRN_optional' - $ref: '#/components/parameters/logSourceType_optional' - $ref: '#/components/parameters/observer_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/outcome_optional' - $ref: '#/components/parameters/providerOrgId_optional' - $ref: '#/components/parameters/reason_optional' - $ref: '#/components/parameters/requestData_optional' - $ref: '#/components/parameters/requestPath_optional' - $ref: '#/components/parameters/responseData_optional' - $ref: '#/components/parameters/audit_entity_sort_optional' - $ref: '#/components/parameters/spaceId_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/tags_optional' - $ref: '#/components/parameters/target_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/timezone_optional' - $ref: '#/components/parameters/typeURI_optional' - $ref: '#/components/parameters/audit_entity_version_optional' responses: '200': $ref: '#/components/responses/AuditEntityHistoryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/audit/filterparameters: description: 'Return the list of audit filter parameters supported at organization scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: description: Return the list of audit filter parameters supported at organization scope. summary: List audit filter parameters at organization scope operationId: audit_orgGetFilterParameters security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/AuditFilterParamListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/audit: description: 'Return a result set of audit records scoped to the organization. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: List audits at organization scope description: Returns a list of audit records for the specified organization. operationId: audit_orgList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/action_optional' - $ref: '#/components/parameters/audit_api_optional' - $ref: '#/components/parameters/audit_mcp_server_optional' - $ref: '#/components/parameters/audit_product_optional' - $ref: '#/components/parameters/audit_actor_optional' - $ref: '#/components/parameters/audit_area_optional' - $ref: '#/components/parameters/audit_changes_only_optional' - $ref: '#/components/parameters/attachments_optional' - $ref: '#/components/parameters/auditId_optional' - $ref: '#/components/parameters/audit_entity_optional' - $ref: '#/components/parameters/catalogId_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/eventGenerator_optional' - $ref: '#/components/parameters/initiator_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/logSourceCRN_optional' - $ref: '#/components/parameters/logSourceType_optional' - $ref: '#/components/parameters/observer_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/outcome_optional' - $ref: '#/components/parameters/reason_optional' - $ref: '#/components/parameters/requestData_optional' - $ref: '#/components/parameters/requestPath_optional' - $ref: '#/components/parameters/responseData_optional' - $ref: '#/components/parameters/sort_optional' - $ref: '#/components/parameters/spaceId_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/tags_optional' - $ref: '#/components/parameters/target_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/timezone_optional' - $ref: '#/components/parameters/typeURI_optional' responses: '200': $ref: '#/components/responses/AuditListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/audit/{audit-id}: description: 'Return a single audit record by ID for the specified organization. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/audit-id' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/timezone_optional' get: summary: Get audit record at organization scope description: Returns a specific audit record by ID for the given organization. operationId: audit_orgGet security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/AuditResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/audit/dashboards/{audit-dashboard}: description: 'Return the data for an audit dashboard, aggregated from the audit records for the provider organization. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/audit-dashboard' - $ref: '#/components/parameters/org' get: summary: Get an audit dashboard at organization scope description: Returns counts, time series and recent audit records for the requested audit dashboard. Accepts the same filters as the audit list. operationId: audit_orgDashboard security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/action_optional' - $ref: '#/components/parameters/audit_api_optional' - $ref: '#/components/parameters/audit_mcp_server_optional' - $ref: '#/components/parameters/audit_product_optional' - $ref: '#/components/parameters/audit_actor_optional' - $ref: '#/components/parameters/audit_area_optional' - $ref: '#/components/parameters/audit_changes_only_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/attachments_optional' - $ref: '#/components/parameters/auditId_optional' - $ref: '#/components/parameters/audit_entity_optional' - $ref: '#/components/parameters/catalogId_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/eventGenerator_optional' - $ref: '#/components/parameters/initiator_optional' - $ref: '#/components/parameters/logSourceCRN_optional' - $ref: '#/components/parameters/logSourceType_optional' - $ref: '#/components/parameters/observer_optional' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/outcome_optional' - $ref: '#/components/parameters/reason_optional' - $ref: '#/components/parameters/requestData_optional' - $ref: '#/components/parameters/requestPath_optional' - $ref: '#/components/parameters/responseData_optional' - $ref: '#/components/parameters/spaceId_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/tags_optional' - $ref: '#/components/parameters/target_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/timezone_optional' - $ref: '#/components/parameters/typeURI_optional' responses: '200': $ref: '#/components/responses/AuditDashboardResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/audit/entities/{audit-entity-type}/{audit-entity-name}: description: 'Return the audit history of a product, API or MCP server in the provider organization. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/audit-entity-name' - $ref: '#/components/parameters/audit-entity-type' - $ref: '#/components/parameters/org' get: summary: Get the audit history of a product, API or MCP server at organization scope description: Returns a summary (first and last change, versions, actions, users and catalogs) and the audit records about the product, API or MCP server, including changes to its drafts, publishing and lifecycle changes. Accepts the same filters as the audit list. operationId: audit_orgEntityHistory security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/action_optional' - $ref: '#/components/parameters/audit_actor_optional' - $ref: '#/components/parameters/audit_area_optional' - $ref: '#/components/parameters/audit_changes_only_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/attachments_optional' - $ref: '#/components/parameters/auditId_optional' - $ref: '#/components/parameters/catalogId_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/eventGenerator_optional' - $ref: '#/components/parameters/initiator_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/logSourceCRN_optional' - $ref: '#/components/parameters/logSourceType_optional' - $ref: '#/components/parameters/observer_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/outcome_optional' - $ref: '#/components/parameters/reason_optional' - $ref: '#/components/parameters/requestData_optional' - $ref: '#/components/parameters/requestPath_optional' - $ref: '#/components/parameters/responseData_optional' - $ref: '#/components/parameters/audit_entity_sort_optional' - $ref: '#/components/parameters/spaceId_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/tags_optional' - $ref: '#/components/parameters/target_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/timezone_optional' - $ref: '#/components/parameters/typeURI_optional' - $ref: '#/components/parameters/audit_entity_version_optional' responses: '200': $ref: '#/components/responses/AuditEntityHistoryResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/apis: description: 'Return the list of APIs and their count at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Get the list of APIs and their count at cloud scope description: Return the list of APIs and their count at cloud scope. operationId: listattributes_cloudApiList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/ApiListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/applications: description: 'Return the list of applications and their count at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Get the list of applications and their count at cloud scope description: Return the list of applications and their count at cloud scope. operationId: listattributes_cloudApplicationList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/ApplicationListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/products: description: 'Return the list of products and their count at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Get the list of products and their count at cloud scope description: Return the list of products and their count at cloud scope. operationId: listattributes_cloudProductList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/ProductListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/plans: description: 'Return the list of plans and their count at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Get the list of plans and their count at cloud scope description: Return the list of plans and their count at cloud scope. operationId: listattributes_cloudPlanList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/PlanListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/consumerorgs: description: 'Return the list of consumer organizations and their count at cloud scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' get: summary: Get the list of consumer organizations and their count at cloud scope description: Return the list of consumer organizations and their count at cloud scope. operationId: listattributes_cloudConsumerorgList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/use_gateway_validation_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/ConsumerOrgListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/apis: description: 'Return the list of APIs and their count at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Get the list of APIs and their count at org scope description: Return the list of APIs and their count at org scope. operationId: listattributes_orgApiList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/ApiListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/applications: description: 'Return the list of applications and their count at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Get the list of applications and their count at org scope description: Return the list of applications and their count at org scope. operationId: listattributes_orgApplicationList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/ApplicationListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/products: description: 'Return the list of products and their count at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Get the list of products and their count at org scope description: Return the list of products and their count at org scope. operationId: listattributes_orgProductList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/ProductListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/plans: description: 'Return the list of plans and their count at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Get the list of plans and their count at org scope description: Return the list of plans and their count at org scope. operationId: listattributes_orgPlanList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/PlanListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/consumerorgs: description: 'Return the list of consumer organizations and their count at org scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' get: summary: Get the list of consumer organizations and their count at org scope description: Return the list of consumer organizations and their count at org scope. operationId: listattributes_orgConsumerorgList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/ConsumerOrgListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/apis: description: 'Return the list of APIs and their count at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' get: summary: Get the list of APIs and their count at catalog scope description: Return the list of APIs and their count at catalog scope. operationId: listattributes_catalogApiList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/ApiListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/applications: description: 'Return the list of applications and their count at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' get: summary: Get the list of applications and their count at catalog scope description: Return the list of applications and their count at catalog scope. operationId: listattributes_catalogApplicationList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/ApplicationListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/products: description: 'Return the list of products and their count at catalog scope.. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' get: summary: Get the list of products and their count at catalog scope description: Return the list of products and their count at catalog scope. operationId: listattributes_catalogProductList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/ProductListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/plans: description: 'Return the list of plans and their count at catalog scope.. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' get: summary: Get the list of plans and their count at catalog scope description: Return the list of plans and their count at catalog scope.. operationId: listattributes_catalogPlanList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/PlanListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/catalogs/{org}/{catalog}/consumerorgs: description: 'Return the list of consumer organizations and their count at catalog scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' get: summary: Get the list of consumer organizations and their count at catalog scope description: Return the list of consumer organizations and their count at catalog scope. operationId: listattributes_catalogConsumerorgList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/ConsumerOrgListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/apis: description: 'Return the list of APIs and their count at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Get the list of APIs and their count at space scope description: Return the list of APIs and their count at space scope. operationId: listattributes_spaceApiList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/ApiListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/applications: description: 'Return the list of applications and their count at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Get the list of applications and their count at space scope description: Return the list of applications and their count at space scope. operationId: listattributes_spaceApplicationList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/ApplicationListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/products: description: 'Return the list of products and their count at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Get the list of products and their count at space scope description: Return the list of products and their count at space scope. operationId: listattributes_spaceProductList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/ProductListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/plans: description: 'Return the list of plans and their count at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Get the list of plans and their count at space scope description: Return the list of plans and their count at space scope. operationId: listattributes_spacePlanList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/PlanListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/spaces/{org}/{catalog}/{space}/consumerorgs: description: 'Return the list of consumer organizations and their count at space scope. ' parameters: - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/space' get: summary: Get the list of consumer organizations and their count at space scope description: Return the list of consumer organizations and their count at space scope. operationId: listattributes_spaceConsumerorgList security: - oauth: - api-analytics:view parameters: - $ref: '#/components/parameters/ai_cache_hit_optional' - $ref: '#/components/parameters/ai_model_optional' - $ref: '#/components/parameters/ai_request_tokens_optional' - $ref: '#/components/parameters/ai_response_tokens_optional' - $ref: '#/components/parameters/ai_total_tokens_optional' - $ref: '#/components/parameters/alert_action_optional' - $ref: '#/components/parameters/alert_description_optional' - $ref: '#/components/parameters/alert_type_optional' - $ref: '#/components/parameters/alert_source_optional' - $ref: '#/components/parameters/api_id_optional' - $ref: '#/components/parameters/api_name_optional' - $ref: '#/components/parameters/api_resource_id_optional' - $ref: '#/components/parameters/api_type_optional' - $ref: '#/components/parameters/api_version_optional' - $ref: '#/components/parameters/app_id_optional' - $ref: '#/components/parameters/app_lifecycle_state_optional' - $ref: '#/components/parameters/app_name_optional' - $ref: '#/components/parameters/backend_method_optional' - $ref: '#/components/parameters/backend_request_body_optional' - $ref: '#/components/parameters/backend_request_headers_optional' - $ref: '#/components/parameters/backend_response_body_optional' - $ref: '#/components/parameters/backend_response_headers_optional' - $ref: '#/components/parameters/backend_status_code_optional' - $ref: '#/components/parameters/backend_time_to_serve_request_optional' - $ref: '#/components/parameters/backend_url_optional' - $ref: '#/components/parameters/bucket_interval_optional' - $ref: '#/components/parameters/bytes_received_optional' - $ref: '#/components/parameters/bytes_sent_optional' - $ref: '#/components/parameters/cached_response_optional' - $ref: '#/components/parameters/callback_request_optional' - $ref: '#/components/parameters/client_geoip_optional' - $ref: '#/components/parameters/client_id_optional' - $ref: '#/components/parameters/client_ip_optional' - $ref: '#/components/parameters/consumer_org_id_optional' - $ref: '#/components/parameters/consumer_org_name_optional' - $ref: '#/components/parameters/consumer_org_title_optional' - $ref: '#/components/parameters/custom_data_optional' - $ref: '#/components/parameters/document_size_optional' - $ref: '#/components/parameters/end_time_optional' - $ref: '#/components/parameters/endpoint_url_optional' - $ref: '#/components/parameters/event_id_optional' - $ref: '#/components/parameters/error_description_optional' - $ref: '#/components/parameters/error_message_optional' - $ref: '#/components/parameters/event_type_optional' - $ref: '#/components/parameters/filter_name_optional' - $ref: '#/components/parameters/gateway_host_optional' - $ref: '#/components/parameters/gateway_ip_optional' - $ref: '#/components/parameters/gateway_port_optional' - $ref: '#/components/parameters/gateway_service_name_optional' - $ref: '#/components/parameters/gateway_time_to_serve_request_optional' - $ref: '#/components/parameters/gateway_type_optional' - $ref: '#/components/parameters/global_transaction_id_optional' - $ref: '#/components/parameters/graphql_document_hash_optional' - $ref: '#/components/parameters/graphql_error_count_optional' - $ref: '#/components/parameters/graphql_operation_name_optional' - $ref: '#/components/parameters/graphql_operation_type_optional' - $ref: '#/components/parameters/graphql_request_field_cost_optional' - $ref: '#/components/parameters/graphql_request_type_cost_optional' - $ref: '#/components/parameters/graphql_response_type_cost_optional' - $ref: '#/components/parameters/http_user_agent_optional' - $ref: '#/components/parameters/immediate_client_ip_optional' - $ref: '#/components/parameters/include_others_optional' - $ref: '#/components/parameters/limit_optional' - $ref: '#/components/parameters/log_policy_optional' - $ref: '#/components/parameters/method_optional' - $ref: '#/components/parameters/monitor_attribute_optional' - $ref: '#/components/parameters/offset_optional' - $ref: '#/components/parameters/opentracing_info_optional' - $ref: '#/components/parameters/operation_path_optional' - $ref: '#/components/parameters/path_optional' - $ref: '#/components/parameters/path_id_optional' - $ref: '#/components/parameters/plan_id_optional' - $ref: '#/components/parameters/plan_name_optional' - $ref: '#/components/parameters/plan_version_optional' - $ref: '#/components/parameters/product_id_optional' - $ref: '#/components/parameters/product_name_optional' - $ref: '#/components/parameters/product_title_optional' - $ref: '#/components/parameters/product_version_optional' - $ref: '#/components/parameters/query_string_optional' - $ref: '#/components/parameters/rate_limit_optional' - $ref: '#/components/parameters/request_body_optional' - $ref: '#/components/parameters/request_http_headers_optional' - $ref: '#/components/parameters/resource_id_optional' - $ref: '#/components/parameters/response_body_optional' - $ref: '#/components/parameters/response_http_headers_optional' - $ref: '#/components/parameters/rule_name_optional' - $ref: '#/components/parameters/scope_optional' - $ref: '#/components/parameters/space_id_optional' - $ref: '#/components/parameters/space_name_optional' - $ref: '#/components/parameters/start_time_optional' - $ref: '#/components/parameters/status_code_optional' - $ref: '#/components/parameters/time_to_serve_request_optional' - $ref: '#/components/parameters/timeframe_optional' - $ref: '#/components/parameters/transaction_id_optional' - $ref: '#/components/parameters/user_agent_optional' - $ref: '#/components/parameters/websocket_message_type_optional' - $ref: '#/components/parameters/websocket_origin_optional' responses: '200': $ref: '#/components/responses/ConsumerOrgListResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/purge/{deploymentmode}: description: 'Purge indices API to delete indices of disabled modes ' parameters: - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/accept_language_optional' - $ref: '#/components/parameters/deploymentmode' post: summary: Deletes indices associated with a mode description: The user can delete indices associated with a mode no longer required if they have it disabled operationId: clustermgmt_purge_post security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/PurgeIndicesResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/wmapigw-migrate: description: 'API to initiate WMAPIGW migration for an analytics service ' parameters: - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/accept_language_optional' post: summary: Initiates WMAPIGW migration for an analytics service description: Initiates the migration of WMAPIGW data for the specified analytics service operationId: clustermgmt_migration_post security: - oauth: - api-analytics:view requestBody: content: application/json: schema: $ref: '#/components/schemas/WmMigrationRequest' application/yaml: schema: $ref: '#/components/schemas/WmMigrationRequest' responses: '200': $ref: '#/components/responses/WmapigwMigrationResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/wmapigw-migrate/status: description: 'API to get the status of WMAPIGW migration for an analytics service ' parameters: - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/accept_language_optional' get: summary: Gets the status of WMAPIGW migration for an analytics service description: Returns the current status of the WMAPIGW migration process for the specified analytics service operationId: clustermgmt_migration_getStatus security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/WmapigwMigrationStatusResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/wmapigw-migrate/retry: description: 'API to retry a failed WMAPIGW migration for an analytics service ' parameters: - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/accept_language_optional' post: summary: Retries a failed WMAPIGW migration for an analytics service description: Attempts to retry a previously failed WMAPIGW migration process for the specified analytics service operationId: clustermgmt_migration_retry security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/WmapigwMigrationResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/cloud/clustermgmt/wmapigw-migrate/stop: description: 'API to stop WMAPIGW migration for an analytics service ' parameters: - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/accept_language_optional' post: summary: Stops WMAPIGW migration for an analytics service description: Attempts to stop a WMAPIGW migration process for the specified analytics service operationId: clustermgmt_migration_stop security: - oauth: - api-analytics:view responses: '200': $ref: '#/components/responses/WmapigwStopMigrationResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics /{analytics-service}/orgs/{org}/catalogs/{catalog}/seed-trial-data: parameters: - $ref: '#/components/parameters/analytics-service' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/org' post: summary: Initiate trial data seeding description: Creates sample analytics data for a trial provider organization. Generates realistic API events and fires them to the ingestion API. operationId: seedtrialdata_createseedtask parameters: - $ref: '#/components/parameters/accept_language_optional' security: - oauth: - api-analytics:manage responses: '200': $ref: '#/components/responses/SeedTrialDataResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Analytics components: schemas: LeaderboardRankedWithErrorRate: type: array description: An array of ranked data items: type: object properties: rank: description: This items rank position, e.g. 1 equals first type: number ref: description: The reference field for this artifact, e.g. apiname:version or productname:version or productname:version:plan type: string example: apiname:1.0.0 gateway_type: description: The gateway type associated with each gateway service type: string catalogs: $ref: '#/components/schemas/CatalogBreakdown' total: type: number errors: type: number success: type: number error_rate: type: number type: description: The type of entity this ranked item represents (products for LLM APIs, mcpservers for MCP APIs) type: - string - 'null' enum: - products - mcpservers usage_over_time: type: array items: $ref: '#/components/schemas/DateValueItem' ai_insights: description: Provides an AI generated color indicator and 2-3 words description on the trend of API calls type: - object - 'null' properties: status: type: - string - 'null' trend: description: optional attribute containing 2-3 words description on the trend of API calls type: - string - 'null' AuditTimelineResponse: type: object description: Discover timeline response. properties: total: $ref: '#/components/schemas/NonNegativeInteger' search_time: $ref: '#/components/schemas/NonNegativeInteger' api_calls_in_timeframe: $ref: '#/components/schemas/GroupKeyValueDataList' ConsumptionDataItemList: type: array items: $ref: '#/components/schemas/ConsumptionDataItem' WorldmapDashboardResponse: type: object description: Data to display on the WORLD MAP Dashboard. properties: geo_hash: type: object description: Geo hash data for the world map properties: data: type: array items: type: object properties: key: type: string description: It is geo hash count: type: number description: Number of API calls in the geo hash location: type: object properties: lat: type: number description: Latitude of the geo hash location lon: type: number description: Longitude of the geo hash location AuditDashboard: type: object description: 'Data for an audit dashboard. Every dashboard has search_time, total and totals; the other properties depend on the dashboard. Time series are lists of { group, date, value }, counts are lists of { group, key?, value } and tables are lists of audit event rows whose id identifies the audit record. ' properties: search_time: $ref: '#/components/schemas/NonNegativeInteger' total: description: Number of audit events in the timeframe after filters. $ref: '#/components/schemas/NonNegativeInteger' totals: type: object description: Headline counts for the dashboard. additionalProperties: type: integer additionalProperties: true AuditListResponse: type: object description: Response for a list of audit records. properties: total: type: integer description: Total number of audit records. took: type: integer description: Time in milliseconds taken for the query. offset: type: integer description: Query offset. limit: type: integer description: Query limit. first: $ref: '#/components/schemas/PaginationLink' next: $ref: '#/components/schemas/PaginationLink' previous: $ref: '#/components/schemas/PaginationLink' last: $ref: '#/components/schemas/PaginationLink' audits: type: array items: $ref: '#/components/schemas/AuditResponse' FilterParamListLevel4: type: array description: Array of filter params for nested fields. items: $ref: '#/components/schemas/FilterParamLevel4' DateValueItem: type: object properties: date: type: string format: date-time value: type: number StatusDashboardResponse: type: object description: Data to display on the STATUS Dashboard. properties: search_time: $ref: '#/components/schemas/NonNegativeInteger' status_codes: $ref: '#/components/schemas/GroupValueDataList' total_api_calls: $ref: '#/components/schemas/DataItem' errors: $ref: '#/components/schemas/GroupDateValueItemData' success_rate: $ref: '#/components/schemas/GroupDateValueItemData' total_errors: $ref: '#/components/schemas/DataItem' ai_insights: description: AI-generated insights about the Status dashboard, including success rate trends, error patterns, and recommendations type: - object - 'null' ai_insights_metadata: description: Metadata about the AI insights generation process type: - object - 'null' ai_insights_error: description: optional attribute representing whether AI insights call resulted in error type: - boolean - 'null' IlmtReportResponse: type: object description: ILMT (IBM License Metric Tool) metering data for license compliance tracking properties: cloudpakId: type: string description: Cloud Pak ID (empty for non-CP4I environments) cloudpakMetric: type: string description: Cloud Pak metric (empty for non-CP4I environments) cloudpakName: type: string description: Cloud Pak name (empty for non-CP4I environments) productCloudpakRatio: type: string description: Product to Cloud Pak ratio (empty for non-CP4I environments) productID: type: string description: Product ID from license annotations productMetric: type: string description: Product metric from license annotations productName: type: string description: Product name from license annotations metricValue: type: integer description: Total API call count (API + AI calls combined) logDate: type: string format: date description: Report date in YYYY-MM-DD format groupName: type: string description: Grouping identifier for the report aggregationPolicy: type: string enum: - ADD - MAX description: Aggregation policy for metric values ApiUsageReportResponse: type: object description: Data to display on the API usage report. properties: org_name: type: string catalog_name: type: string space_name: type: string start: type: string format: date-time end: type: string format: date-time trends: type: object description: Trends section with description properties: description: type: string description: Description of the trends data api_calls: $ref: '#/components/schemas/ReportTrendComponent' success_rate: $ref: '#/components/schemas/ReportTrendComponent' errors: $ref: '#/components/schemas/ReportTrendComponent' avg_response_time: $ref: '#/components/schemas/ReportTrendComponent' api_call_volume: $ref: '#/components/schemas/GroupDataValueForecastItemData' bytes_received: $ref: '#/components/schemas/GroupDateValueItemData' bytes_sent: $ref: '#/components/schemas/GroupDateValueItemData' total_apis: $ref: '#/components/schemas/GroupDateValueItemData' total_products: $ref: '#/components/schemas/GroupDateValueItemData' breakdown: $ref: '#/components/schemas/BreakDownData' status_codes_count: $ref: '#/components/schemas/StatusCodesCount' response_times: $ref: '#/components/schemas/GroupDateValueItemData' api_usage_per_product: $ref: '#/components/schemas/sankeyChartData' ai_insights: description: AI-generated insights about API usage patterns, trends, anomalies, and recommendations type: - object - 'null' ai_insights_metadata: description: Metadata about the AI insights generation process type: - object - 'null' ai_insights_error: description: optional attribute representing whether AI insights call resulted in error type: - boolean - 'null' LeaderboardReportResponse: type: object description: Leaderboard for the API Usage dashboard properties: org_name: type: string catalog_name: type: string space_name: type: string catalogs: description: Semicolon separated list of org/catalog names example: custom-org/custom-cat;other-org/other-cat type: string start: type: string format: date-time end: type: string format: date-time leaderboard: type: object description: Leaderboard with description properties: description: type: string description: Description of the leaderboard type: type: string enum: - api - product - plan - application - consumerorg - gatewayService - mcpserver - aiplatform-providers - aiplatform-consumers top_data: type: array items: type: object properties: rank: type: integer ref: type: string value: type: number type: type: string bottom_data: type: array items: type: object properties: rank: type: integer ref: type: string value: type: number type: type: string ProviderLeaderboardDetailReportResponse: type: object description: Leaderboard detail for the API Usage report properties: org_name: type: string catalog_name: type: string space_name: type: string catalogs: description: Semicolon separated list of org/catalog names example: custom-org/custom-cat;other-org/other-cat type: string gateway_service_names: $ref: '#/components/schemas/GatewayServiceNamesByScopes' start: type: string format: date-time end: type: string format: date-time lifecycle_state: type: string enum: - published - deprecated type: type: string enum: - api - product - plan - mcpserver ref: type: string example: customapi:1.0.0 is_deleted: type: boolean default: false trends: type: object description: Trends section with description properties: description: type: string description: Description of the trends data api_calls: $ref: '#/components/schemas/ReportTrendComponent' success_rate: $ref: '#/components/schemas/ReportTrendComponent' errors: $ref: '#/components/schemas/ReportTrendComponent' avg_response_time: $ref: '#/components/schemas/ReportTrendComponent' api_call_volume: $ref: '#/components/schemas/GroupDataValueForecastItemData' data_usage: $ref: '#/components/schemas/GroupDateValueItemData' breakdown: $ref: '#/components/schemas/BreakDownData' status_codes_count: $ref: '#/components/schemas/StatusCodesCount' response_times: $ref: '#/components/schemas/GroupDateValueItemData' corg_leaderboard: type: object description: Consumer organization leaderboard with description properties: description: type: string description: Description of the consumer organization leaderboard total: type: integer description: Total number of items offset: type: integer description: Current offset limit: type: integer description: Items per page data: type: array items: $ref: '#/components/schemas/LeaderboardRankedItem' application_leaderboard: type: object description: Application leaderboard with description properties: description: type: string description: Description of the application leaderboard total: type: integer description: Total number of items offset: type: integer description: Current offset limit: type: integer description: Items per page data: type: array items: $ref: '#/components/schemas/LeaderboardRankedItem' ai_insights: description: AI-generated insights about API usage patterns, trends, anomalies, and recommendations type: - object - 'null' ai_insights_metadata: description: Metadata about the AI insights generation process type: - object - 'null' ai_insights_error: description: optional attribute representing whether AI insights call resulted in error type: - boolean - 'null' GroupDateValueForecastItem: type: object properties: group: type: string date: type: string value: type: number min: type: number max: type: number ScrollResponse: type: object properties: total: type: number description: Total number of events stored. scroll_id: type: string description: Pass this scroll ID of the current scroll operation. data: type: array items: $ref: '#/components/schemas/Event' InactiveCorgs: type: array description: Array of inactive items items: type: object properties: name: type: string description: Name of the inactive item catalogs: type: string description: Comma-separated list of org/catalog FilterParamLevel5: type: object description: Filter parameter for nested fields. properties: key: type: string name: type: string text: type: string type: type: string Query: type: object description: Query properties: id: type: string title: type: string description: type: string created: type: string format: date-time updated: type: string format: date-time owner: type: string query_string: type: string shared: type: boolean default: false default: type: boolean default: false org_id: type: string org_name: type: string catalog_id: type: string catalog_name: type: string space_id: type: string space_name: type: string settings: type: object additionalProperties: true owner_first_name: type: string owner_last_name: type: string owner_username: type: string EventContextRelated: type: object properties: global_transaction: type: object properties: id: type: string events: type: array items: $ref: '#/components/schemas/EventContextRelatedEvent' same_client: type: object properties: client_id: type: string app_name: type: string window_seconds: $ref: '#/components/schemas/NonNegativeInteger' events: type: array items: $ref: '#/components/schemas/EventContextRelatedEvent' trace: type: object properties: trace_id: type: string span_id: type: string url: type: string description: Link to the trace in the configured tracing UI, if one is configured. backend_name: type: string OpentracingInfoItem: type: object description: An optional object containing opentracing information if in use. additionalProperties: true properties: span_id: type: string description: The opentracing span ID trace_id: type: string description: The opentracing trace ID QueryList: type: array description: Array of queries. items: $ref: '#/components/schemas/Query' InactivePollingResponse: type: object description: Inactive report polling response properties: report_url: type: string description: Partial URL to query for the report generation example: /cloud/reports/inactive/consumerorg message: type: string description: Information message about the response example: Report processing GroupKeyValueItem: type: object properties: group: type: string value: type: number key: type: string DeprecatedProducts: type: array description: Array of deprecated items items: type: object properties: ref: type: string description: Name of the deprecated item catalogs: type: string description: Comma-separated list of org/catalog total: type: number description: Total number of API calls made using the deprecated products errors: type: number success: type: number BackendPolicyErrorItem: type: object properties: id: type: string date: type: string error_message: type: string error_description: type: string api_name: type: string backend_url: type: string status_code: type: string backend_status_code: type: string RateLimitApplication: type: object description: Application rate limit status details properties: app_name: type: string description: Application name example: my-mobile-app app_id: type: string description: Application ID example: 4d98ed08-0f11-42ad-a0e5-93093a5bc2d0 app_lifecycle_state: type: string description: Application lifecycle state example: production product_name: type: string description: Product name example: weather-product product_id: type: string description: Product ID example: d3fcc626-bf11-4318-8045-8d8502608c88 product_title: type: string description: Product title example: Weather API Product product_version: type: string description: Product version example: 1.0.0 plan_id: type: string description: Plan ID example: weather-product:1.0.0:gold plan_name: type: string description: Plan name example: gold plan_version: type: string description: Plan version example: 1.0.0 api_name: type: string description: API name example: weather-api api_id: type: string description: API ID example: dd371dba-035c-476b-acf5-6c81376b2311 api_version: type: string description: API version example: 1.0.0 developer_org_name: type: string description: Developer organization name example: acme-developers developer_org_id: type: string description: Developer organization ID example: ddcaf2b9-0460-4783-a743-f773dd3c7e64 developer_org_title: type: string description: Developer organization title example: ACME Developers catalog_name: type: string description: Catalog name example: production catalog_id: type: string description: Catalog ID example: 6c592723-b2b7-49dc-b956-14596b6cc8f3 space_name: type: string description: Space name example: default org_name: type: string description: Provider organization name example: my-provider-org org_id: type: string description: Provider organization ID example: dc299ac1-223d-4f53-94ce-2f264ea32d81 quota_name: type: string description: Rate limit quota name example: default limit: type: integer description: Rate limit quota limit example: 1000 remaining_count: type: integer description: Remaining quota count example: 50 used_count: type: integer description: Used quota count example: 950 usage_percentage: type: integer description: Usage percentage (0-100) example: 95 unit: type: string description: Rate limit unit example: minute interval: type: integer description: Rate limit interval example: 1 period: type: string description: Rate limit period example: 1m reject: type: boolean description: Whether requests are rejected when limit is exceeded example: true last_updated: type: string format: date-time description: Timestamp of the last update example: '2024-03-13T14:30:00Z' ApplicationListResponse: type: object description: Data to get the list of plans and their count. properties: start: type: string format: date-time end: type: string format: date-time applications: type: object properties: total: $ref: '#/components/schemas/NonNegativeInteger' data: $ref: '#/components/schemas/AttributeListArray' AuditEntityCount: type: object properties: name: type: string events: type: integer QueryTransferOwnerRequest: type: object required: - new_owner_user_url properties: new_owner_user_url: type: string example: /api/user-registries/9fae1d20-3d20-4418-8c09-d3409b303b7e/d4654412-f96f-4989-895e-dca377ac9fa4/users/7982df1f-1a86-4077-8131-7ce583385d7d EventCountResponse: type: object description: Number of matching events at the requested scope. properties: total: $ref: '#/components/schemas/NonNegativeInteger' UsageEvolutionReportResponse: type: object description: Usage Evolution report data for multi-stage Sankey/alluvial chart visualization showing progression across time periods (12m → 9m → 6m → 3m → Now) properties: type: type: string description: Entity type being compared enum: - apis - products - plans - applications - consumerorgs example: apis org_name: type: string description: Organization name (if applicable) catalog_name: type: string description: Catalog name (if applicable) space_name: type: string description: Space name (if applicable) current_period: type: object description: Current time period being analyzed properties: start: type: string format: date-time description: Start date of current period end: type: string format: date-time description: End date of current period periods: type: array description: Array of all time periods in the multi-stage chart (ordered from oldest to newest) items: type: object properties: id: type: string description: Period identifier enum: - 12m - 9m - 6m - 3m - 1m - now example: 12m start: type: string format: date-time description: Start date of this period end: type: string format: date-time description: End date of this period label: type: string description: Human-readable, translated label for this period example: 12 months ago chart_data: type: object description: Multi-stage Sankey chart data showing entity flows between consecutive periods (12m→9m, 9m→6m, 6m→3m, 3m→Now) properties: description: type: string description: Human-readable, translated description of the chart data data: type: array description: Flows between consecutive periods, one per entity per pair of periods items: type: object properties: source: type: string description: Source entity with period label example: 'payment-api: 1.0.0 (12 months ago)' target: type: string description: Target entity with period label example: 'payment-api: 1.0.0 (9 months ago)' value: type: number description: Flow value (API call count). The lower of the source and target period usage, or the usage in the only period the entity appears in when it is new or dropped. example: 15000 source_value: type: number description: API call count for the entity in the source period. 0 when the entity is not among the top entities for that period. example: 15000 target_value: type: number description: API call count for the entity in the target period. 0 when the entity is not among the top entities for that period. example: 18000 summary: type: object description: Summary statistics across all periods properties: total_entities: type: integer description: Total number of unique entities across all periods example: 25 entities_tracked_all_periods: type: integer description: Number of entities that appear in all time periods example: 15 entities_new_in_current: type: integer description: Number of entities that are new in the current period (not in first period) example: 5 entities_dropped_since_start: type: integer description: Number of entities that were in the first period but not in current example: 5 ai_insights: description: AI-generated insights about usage evolution patterns, trends, anomalies, and recommendations type: - object - 'null' ai_insights_metadata: description: Metadata about the AI insights generation process type: - object - 'null' ai_insights_error: description: optional attribute representing whether AI insights call resulted in error type: - boolean - 'null' ConfigSyncResponse: type: object description: Response body from config sync properties: took: $ref: '#/components/schemas/NonNegativeInteger' errors: type: boolean ClusterMgmtTextResponse: type: string description: ClusterMgmt text/plain response content example: 6 1.1mb 47.9gb 201.9gb 249.8gb 19 192.168.62.17 192.168.62.17 os-node EventContextBlastRadius: type: object description: Calls and errors around the event, grouped by related dimensions. required: - window_start - window_end - bucket_seconds - dimensions properties: window_start: type: string format: date-time window_end: type: string format: date-time bucket_seconds: $ref: '#/components/schemas/NonNegativeInteger' baseline_period: type: string description: 'How far before the window the baseline error rates for each dimension are measured, for example 6h. ' example: 6h error_onset: type: string format: date-time description: 'Start of the run of elevated error rates for the operation that includes the event, when it began inside the window. ' affected_applications: $ref: '#/components/schemas/NonNegativeInteger' affected_consumer_orgs: $ref: '#/components/schemas/NonNegativeInteger' dimensions: type: array items: $ref: '#/components/schemas/EventContextBlastDimension' EventContextBlastDimension: type: object required: - key - field - value - total - errors - error_rate_pct - baseline_error_rate_pct - series properties: key: type: string description: One of operation, api, backend, gateway or application. field: type: string description: API event field the dimension filters on. value: type: string description: Value of the field for this event. display_value: type: string discover_value: type: string description: 'Filter value to use when listing these events, when it differs from value (for example startswith:). ' total: $ref: '#/components/schemas/NonNegativeInteger' errors: $ref: '#/components/schemas/NonNegativeInteger' same_status: $ref: '#/components/schemas/NonNegativeInteger' error_rate_pct: type: number baseline_error_rate_pct: type: number series: type: array items: $ref: '#/components/schemas/EventContextTimeBucket' FilterParamLevel1: type: object description: Filter parameter for nested fields. properties: key: type: string name: type: string text: type: string type: type: string nestedFields: $ref: '#/components/schemas/FilterParamListLevel2' GroupDateValueItemData: type: object properties: description: type: string description: Description of what this chart data represents data: $ref: '#/components/schemas/GroupDateValueItemList' ConfigSyncRequest: type: object description: Request payload for config sync data properties: org_name: type: string description: The provider organization name org_id: type: string description: The provider organization ID catalog_name: type: string description: The catalog name catalog_id: type: string description: The catalog ID datetime: type: string format: date-time description: The completion date time of the sync consumer_orgs: type: number description: The number of consumer organizations members: type: number description: The number of members users: type: number description: The number of users applications: type: number description: The number of applications credentials: type: number description: The number of application credentials subscriptions: type: number description: The number of subscriptions apis: type: number description: The number of APIs products: type: number description: The number of products charged: type: number description: The billed amount for all the synced resources DiscoverTimelineResponse: type: object description: Discover timeline response. properties: total: $ref: '#/components/schemas/NonNegativeInteger' search_time: $ref: '#/components/schemas/NonNegativeInteger' api_calls_in_timeframe: $ref: '#/components/schemas/GroupKeyValueDataList' AiplatformReportResponse: type: object description: Data to display on the AI Platform report. properties: org_name: type: string catalog_name: type: string space_name: type: string start: type: string format: date-time end: type: string format: date-time trends: type: object description: Trends section with description properties: description: type: string description: Description of the trends data api_calls: $ref: '#/components/schemas/ReportTrendComponent' success_rate: $ref: '#/components/schemas/ReportTrendComponent' errors: $ref: '#/components/schemas/ReportTrendComponent' avg_response_time: $ref: '#/components/schemas/ReportTrendComponent' aiplatform_call_volume: $ref: '#/components/schemas/GroupDataValueForecastItemData' status_codes_count: $ref: '#/components/schemas/StatusCodesCount' response_times: $ref: '#/components/schemas/GroupDateValueItemData' aiplatform_providers_consumers: $ref: '#/components/schemas/sankeyChartData' ai_insights: description: AI-generated insights about API usage patterns, trends, anomalies, and recommendations type: - object - 'null' ai_insights_metadata: description: Metadata about the AI insights generation process type: - object - 'null' ai_insights_error: description: optional attribute representing whether AI insights call resulted in error type: - boolean - 'null' AuditFilterParam: type: object description: An audit filter parameter. properties: name: type: string description: The name of the audit filter parameter. text: type: string description: The localized text for the filter parameter. type: type: string description: 'The data type of the filter parameter: string, number, boolean, date, ipaddress, object, enum or entity. An enum filter has a fixed set of values; an entity filter takes a product, API or MCP server name, or name:version. ' values: type: array description: The values of an enum filter parameter, with localized text. items: type: object properties: value: type: string text: type: string operators: type: array items: type: object properties: text: type: string operator: type: string sankeyChartData: type: object description: Component represent data needed for sankey chart properties: description: type: string description: Description of what this sankey chart data represents data: type: array items: type: object properties: source: type: string target: type: string value: type: number Status: type: integer description: Status code of the error. minimum: 400 maximum: 599 example: 400 SplitBody: type: object properties: aliases: type: object additionalProperties: true settings: type: object additionalProperties: true ConsumerEventArray: type: array description: Array of Consumer API events items: $ref: '#/components/schemas/ConsumerEventBody' ConsumerTrendLeaderboardReportResponse: type: object description: Leaderboard for the consumer trends report properties: org_name: type: string catalog_name: type: string space_name: type: string start: type: string format: date-time end: type: string format: date-time leaderboard: type: object description: Leaderboard with description properties: description: type: string description: Description of the leaderboard type: type: string enum: - application - consumerorg top_data: $ref: '#/components/schemas/ConsumerTrendRankedData' bottom_data: $ref: '#/components/schemas/ConsumerTrendRankedData' EventResponse: type: object description: API event response. allOf: - $ref: '#/components/schemas/Event' - type: object properties: ai_insights: description: AI-generated insights about the API event, including error analysis, performance recommendations, and anomaly detection type: - object - 'null' ai_insights_metadata: description: Metadata about the AI insights generation process type: - object - 'null' ai_insights_error: description: optional attribute representing whether AI insights call resulted in error type: - boolean - 'null' RateLimitStatusResponse: type: object description: Paginated list of applications approaching their rate limits properties: start_date: type: string format: date-time description: Start date-time of the query period end_date: type: string format: date-time description: End date-time of the query period total: type: integer description: Total number of applications matching the criteria example: 150 offset: type: integer description: Current offset in the result set example: 0 limit: type: integer description: Maximum number of results returned in this response example: 100 applications: type: array description: List of applications with their rate limit status items: $ref: '#/components/schemas/RateLimitApplication' query_time_ms: type: integer description: Time taken to execute the query in milliseconds example: 245 FilterParamLevel2: type: object description: Filter parameter for nested fields. properties: key: type: string name: type: string text: type: string type: type: string nestedFields: $ref: '#/components/schemas/FilterParamListLevel3' QueryListResponse: type: object description: Query list response. required: - total - search_time - queries properties: total: $ref: '#/components/schemas/NonNegativeInteger' search_time: $ref: '#/components/schemas/NonNegativeInteger' offset: $ref: '#/components/schemas/NonNegativeInteger' limit: $ref: '#/components/schemas/NonNegativeInteger' first: $ref: '#/components/schemas/PaginationLink' next: $ref: '#/components/schemas/PaginationLink' previous: $ref: '#/components/schemas/PaginationLink' last: $ref: '#/components/schemas/PaginationLink' queries: $ref: '#/components/schemas/QueryList' ScrollDeleteResponse: type: object properties: succeeded: type: boolean description: If true, the request succeeded. This does not indicate whether any scrolling search requests were cleared. num_freed: type: number description: Number of scrolling search requests cleared. AuditResponse: type: object description: A single audit record. properties: id: type: string description: Unique identifier for the audit record. org_id: type: string description: Provider organization ID. catalog_id: type: string description: Catalog ID. space_id: type: string description: Space ID. event_time: type: string format: date-time description: Timestamp of the audit event. event_name: type: string description: Name of the audit event. type_uri: type: string description: The type URI. action: type: string description: Audit action. outcome: type: string description: Outcome of the event. event_type: type: string description: Type of the audit event. reason: type: object properties: reason_code: type: integer reason_type: type: string initiator: type: object properties: id: type: string name: type: string host: type: object properties: agent: type: string address: type: string type_uri: type: string target: type: object properties: id: type: string name: type: string type_uri: type: string event_generator: type: string request_data: type: object description: Request details. response_data: type: object description: Response details. attachments: type: array items: type: object properties: component: type: string eventGenerator: type: string scope: type: string method: type: string summary: type: string operation: type: string resource: type: string user: type: object properties: url: type: string context: type: string idp_name: type: string name: type: string registration: type: object properties: url: type: string type: type: string logSource_type: type: string description: Log source type of the audit event logSource_crn: type: string description: Log source CRN of the audit event QueryRequest: type: object description: Request body to create/update a query. properties: title: type: string description: type: string query_string: type: string shared: type: boolean default: false default: type: boolean default: false settings: type: object additionalProperties: true OperatorList: type: array description: Array of available operators items: $ref: '#/components/schemas/Operator' BreakDownData: type: object description: Data to display the breakdown of API calls per catalog/org properties: description: type: string description: Description of what this breakdown data represents total_api_calls: $ref: '#/components/schemas/GroupValueDataList' errors: $ref: '#/components/schemas/GroupValueDataList' successes: $ref: '#/components/schemas/GroupValueDataList' bytes_received: $ref: '#/components/schemas/GroupValueDataList' bytes_sent: $ref: '#/components/schemas/GroupValueDataList' EventContextRelatedEvent: type: object required: - event_id - datetime properties: event_id: $ref: '#/components/schemas/Id' datetime: type: string format: date-time offset_ms: type: integer description: Milliseconds from the event (negative is before). api_name: type: string api_version: type: string request_method: type: string uri_path: type: string status_code: type: string backend_status_code: type: string time_to_serve_request: type: number gateway_service_name: type: string request_fingerprint_match: type: boolean description: True when method, path, query string and body match this event. McpDashboardResponse: type: object description: Data to display on the MCP Dashboard. properties: search_time: $ref: '#/components/schemas/NonNegativeInteger' total_consumer_orgs: $ref: '#/components/schemas/DataItem' total_requests: $ref: '#/components/schemas/DataItem' total_mcp_servers: $ref: '#/components/schemas/DataItem' mcp_calls_over_time: $ref: '#/components/schemas/GroupDateValueItemData' top_mcp_servers_over_time: $ref: '#/components/schemas/GroupDateValueItemData' top_mcp_tool_names_over_time: $ref: '#/components/schemas/GroupDateValueItemData' top_consumers_over_time: $ref: '#/components/schemas/GroupDateValueItemData' ai_insights: description: AI-generated insights about the MCP dashboard, including server usage patterns, tool performance, and recommendations type: - object - 'null' ai_insights_metadata: description: Metadata about the AI insights generation process type: - object - 'null' ai_insights_error: description: optional attribute representing whether AI insights call resulted in error type: - boolean - 'null' GatewayObject: type: object properties: key: type: string description: Gateway IP gateway_service_name: type: string description: Gateway service name usage: type: array items: $ref: '#/components/schemas/GroupDateValueItem' latency: type: array items: $ref: '#/components/schemas/GroupDateValueItem' BackendDashboardResponse: type: object description: Data to display on the Backend Dashboard. properties: search_time: $ref: '#/components/schemas/NonNegativeInteger' top_backend_urls_for_4xx_errors_over_time: $ref: '#/components/schemas/GroupDateValueItemData' top_backend_urls_for_5xx_errors_over_time: $ref: '#/components/schemas/GroupDateValueItemData' backend_status_code: $ref: '#/components/schemas/GroupValueDataList' backend_time_to_serve_percentiles: $ref: '#/components/schemas/GroupDateValueItemData' top_slowest_backend_requests: $ref: '#/components/schemas/BackendSlowRequestsData' status_code_mismatch: $ref: '#/components/schemas/BackendStatusCodeMismatchData' policy_errors: $ref: '#/components/schemas/BackendPolicyErrorsData' PolicyErrorsResponse: type: object description: Paginated list of policy error events. properties: total: $ref: '#/components/schemas/NonNegativeInteger' search_time: $ref: '#/components/schemas/NonNegativeInteger' offset: $ref: '#/components/schemas/NonNegativeInteger' limit: $ref: '#/components/schemas/NonNegativeInteger' first: $ref: '#/components/schemas/PaginationLink' next: $ref: '#/components/schemas/PaginationLink' previous: $ref: '#/components/schemas/PaginationLink' last: $ref: '#/components/schemas/PaginationLink' data: type: array items: $ref: '#/components/schemas/BackendPolicyErrorItem' WmapigwMigrationResponse: type: object description: Response from the WMAPIGW migration API. properties: jobId: type: string description: Identifier for the migration job example: migration-job-wmapigw status: type: string description: Status of the migration operation example: INITIATED createdAt: type: string format: date-time description: Time when the migration job was created retryOf: type: string description: Original job ID if this is a retry operation example: migration-job-wmapigw MigrationRequest: type: object description: A migration is created properties: endpoint: type: string description: The endpoint URL of the remote OpenSearch instance username: type: string description: Username for basic authentication password: type: string description: Password for basic authentication endpoint_ca: type: string description: Base64 encoded CA certificate for SSL verification. Only used if disable_tls_validation is undefined or false. Should be provided together with endpoint_client_cert and endpoint_client_key. endpoint_client_cert: type: string description: Base64 encoded client certificate for certificate-based authentication. Only used if disable_tls_validation is undefined or false. Should be provided together with endpoint_ca and endpoint_client_key. endpoint_client_key: type: string description: Base64 encoded client key for certificate-based authentication. Only used if disable_tls_validation is undefined or false. Should be provided together with endpoint_ca and endpoint_client_cert. startTime: type: string format: date-time description: Start time for data migration endTime: type: string format: date-time description: End time for data migration gateway_service_name: type: string description: Name of the gateway service to migrate data from disable_tls_validation: type: boolean description: Whether to disable TLS certificate validation when connecting to the endpoint, by default the value is set to false required: - endpoint - gateway_service_name RuntimeMetricsGetResponse: type: object properties: runtimes: type: array items: type: object properties: runtimeName: type: string description: The name of the gateway service as registered in the cloud manager. example: gateway_service1 data: type: object properties: apiTransactionMetricsList: type: array items: type: object properties: apiId: type: string description: UUID of the API. example: 93e24761-b84e-4363-a199-687405a9b3e1 apiName: type: string description: Name of the API. example: petstore_api apiVersion: type: string description: Version of the API. example: 1.0.6 apiMetrics: $ref: '#/components/schemas/AgentApiMetrics' metricsByStatusCode: $ref: '#/components/schemas/MetricsByStatusCode' runtimeTransactionMetrics: type: object properties: apiMetrics: $ref: '#/components/schemas/AgentApiMetrics' metricsByStatusCode: $ref: '#/components/schemas/MetricsByStatusCode' timestamp: type: number description: Time metrics were collected in the form of timestamp. example: 1707114619000 MetricsByStatusCode: type: object properties: 1xx: $ref: '#/components/schemas/AgentApiMetrics' 2xx: $ref: '#/components/schemas/AgentApiMetrics' 3xx: $ref: '#/components/schemas/AgentApiMetrics' 4xx: $ref: '#/components/schemas/AgentApiMetrics' 5xx: $ref: '#/components/schemas/AgentApiMetrics' AuditEntity: type: object description: A product, API or MCP server whose audit history was requested. properties: type: type: string enum: - product - api - mcp_server name: type: string version: type: string description: Present when the history was narrowed to one version. FilterParamListResponse: type: object description: Parameter list response. properties: params: $ref: '#/components/schemas/FilterParamList' operatorsByType: $ref: '#/components/schemas/OperatorsTypeList' DateHourValueData: type: object properties: description: type: string description: Description of what this chart data represents total: type: integer data: type: array items: type: object properties: date: type: string hour: type: string value: type: number AuditFilterParamListResponse: type: object description: List of supported audit filter parameters. properties: params: type: object properties: topLevel: type: array items: $ref: '#/components/schemas/AuditFilterParam' nested: type: object properties: reason: type: array items: $ref: '#/components/schemas/AuditFilterParam' initiator: type: array items: $ref: '#/components/schemas/AuditFilterParam' target: type: array items: $ref: '#/components/schemas/AuditFilterParam' attachments: type: object properties: main: type: array items: $ref: '#/components/schemas/AuditFilterParam' user: type: array items: $ref: '#/components/schemas/AuditFilterParam' registration: type: array items: $ref: '#/components/schemas/AuditFilterParam' Summary: type: object description: API event. properties: event: $ref: '#/components/schemas/SummaryBody' BackendSlowRequestsData: type: object properties: description: type: string description: Description of what this data represents total: $ref: '#/components/schemas/NonNegativeInteger' data: type: array items: $ref: '#/components/schemas/BackendSlowRequestItem' TransparencyMetricsList: type: object properties: enabled: type: boolean method: type: string interval: type: string data_points_used: type: number confidence_level: type: string message: type: string SettingsBody: type: object description: OpenSearch settings request body properties: rollover: type: object required: - min_doc_count - min_index_age properties: min_doc_count: description: The minimum number of documents required to roll over the event index. type: integer minimum: 1 x-example: 25000000 min_index_age: description: The minimum age required to roll over the event index. Index age is the time between its creation and the present. Use d for day and h for hour, e.g. 30d or 96h. type: string x-example: 1d retention: type: object required: - min_index_age properties: min_index_age: description: The minimum age required to delete the event index. Index age is the time between its creation and the present. Use d for day and h for hour, e.g. 30d or 96h. type: string x-example: 90d summary_retention: type: object required: - min_index_age properties: min_index_age: description: The minimum age required to delete the summary index. Index age is the time between its creation and the present. Use d for day and h for hour, e.g. 366d or 8000h. type: string x-example: 366d audit_retention: type: object required: - min_index_age properties: min_index_age: description: The minimum age required to delete the audit index. Index age is the time between its creation and the present. Use d for day and h for hour, e.g. 30d or 800h. type: string x-example: 30d heartbeat_retention: type: object required: - min_index_age properties: min_index_age: description: The minimum age required to delete the heartbeat index. Index age is the time between its creation and the present. Use d for day and h for hour, e.g. 30d or 800h. type: string x-example: 30d metrics_retention: type: object required: - min_index_age properties: min_index_age: description: The minimum age required to delete the metrics index. Index age is the time between its creation and the present. Use d for day and h for hour, e.g. 30d or 800h. type: string x-example: 30d FilterParamListLevel2: type: array description: Array of filter params for nested fields. items: $ref: '#/components/schemas/FilterParamLevel2' ScrollDeleteRequest: type: object properties: scroll_id: type: string description: 'Pass this scroll ID to close its search context. To close all open scroll context use ''_all''. ' SummaryCountResponse: type: object description: Number of matching summary API events at the requested scope. properties: total_api_calls: $ref: '#/components/schemas/NonNegativeInteger' ConsumerTrendLeaderboardDetailReportResponse: type: object description: Leaderboard detail for the consumer trends report properties: org_name: type: string catalog_name: type: string space_name: type: string start: type: string format: date-time end: type: string format: date-time type: type: string enum: - application - consumerorg ref: type: string example: custom-app is_deleted: type: boolean default: false catalogs: description: Semicolon separated list of org/catalog names example: custom-org/custom-cat;other-org/other-cat type: string trends: type: object description: Trends section with description properties: description: type: string description: Description of the trends data subscription_count: $ref: '#/components/schemas/ReportTrendComponent' app_count: $ref: '#/components/schemas/ReportTrendComponent' api_calls: $ref: '#/components/schemas/GroupDataValueForecastItemData' data_usage: $ref: '#/components/schemas/GroupDateValueItemData' breakdown: $ref: '#/components/schemas/BreakDownData' response_times: $ref: '#/components/schemas/GroupDateValueItemData' api_leaderboard: type: object description: API leaderboard with description properties: description: type: string description: Description of the API leaderboard total: type: integer description: Total number of items offset: type: integer description: Current offset limit: type: integer description: Items per page data: type: array items: $ref: '#/components/schemas/LeaderboardRankedItem' product_leaderboard: type: object description: Product leaderboard with description properties: description: type: string description: Description of the product leaderboard total: type: integer description: Total number of items offset: type: integer description: Current offset limit: type: integer description: Items per page data: type: array items: $ref: '#/components/schemas/LeaderboardRankedItem' corg_names: type: object description: Consumer organization names with description properties: description: type: string description: Description of consumer organization names data: $ref: '#/components/schemas/RefApiCallsData' application_names: type: object description: Application names with description properties: description: type: string description: Description of application names data: $ref: '#/components/schemas/RefDetailData' EventContextTimeBucket: type: object properties: t: type: string format: date-time description: Start of the bucket. total: $ref: '#/components/schemas/NonNegativeInteger' errors: $ref: '#/components/schemas/NonNegativeInteger' DataItem: type: object properties: description: type: string description: Description of what this metric represents data: type: number ClientDashboardResponse: type: object description: Data to display on the Client Dashboard. properties: total_client_ips: $ref: '#/components/schemas/DataItem' total_countries: $ref: '#/components/schemas/DataItem' total_timezones: $ref: '#/components/schemas/DataItem' total_useragents: $ref: '#/components/schemas/DataItem' total_os: $ref: '#/components/schemas/DataItem' total_devices: $ref: '#/components/schemas/DataItem' geo_hash: type: object properties: data: type: array items: type: object properties: key: type: string doc_count: type: number top_countries: $ref: '#/components/schemas/GroupKeyValueDataList' top_timezones: $ref: '#/components/schemas/GroupKeyValueDataList' top_client_ips_errors_over_time: $ref: '#/components/schemas/GroupDateValueItemData' top_client_ips_over_time: $ref: '#/components/schemas/GroupDateValueItemData' top_os: $ref: '#/components/schemas/GroupKeyValueDataList' top_useragents: $ref: '#/components/schemas/GroupKeyValueDataList' top_devices: $ref: '#/components/schemas/GroupKeyValueDataList' ai_insights: description: AI-generated insights about the Client dashboard, including geographic distribution, client patterns, and recommendations type: - object - 'null' ai_insights_metadata: description: Metadata about the AI insights generation process type: - object - 'null' ai_insights_error: description: optional attribute representing whether AI insights call resulted in error type: - boolean - 'null' ReportTrendComponent: type: object properties: trend: type: string description: Percentage change from start of the time period to the end. Negative values mean decrease. example: 20% value: type: number FilterParamLevel3: type: object description: Filter parameter for nested fields. properties: key: type: string name: type: string text: type: string type: type: string nestedFields: $ref: '#/components/schemas/FilterParamListLevel4' Error: type: object description: Generic error response. additionalProperties: true properties: status: $ref: '#/components/schemas/Status' message: $ref: '#/components/schemas/Message' errors: $ref: '#/components/schemas/ErrorModels' LatencyDashboardResponse: type: object description: Data to display on the LATENCY Dashboard. properties: search_time: $ref: '#/components/schemas/NonNegativeInteger' min_response_time: $ref: '#/components/schemas/DataItem' avg_response_time: $ref: '#/components/schemas/DataItem' max_response_time: $ref: '#/components/schemas/DataItem' apis_with_slowest_response_time: $ref: '#/components/schemas/GroupKeyValueDataList' apis_with_fastest_response_time: $ref: '#/components/schemas/GroupKeyValueDataList' apis_with_slowest_backend_response_time: $ref: '#/components/schemas/GroupKeyValueDataList' apis_with_fastest_backend_response_time: $ref: '#/components/schemas/GroupKeyValueDataList' apis_with_slowest_gateway_processing_time: $ref: '#/components/schemas/GroupKeyValueDataList' apis_with_fastest_gateway_processing_time: $ref: '#/components/schemas/GroupKeyValueDataList' response_times: $ref: '#/components/schemas/GroupDateValueItemData' response_times_successful_calls: $ref: '#/components/schemas/GroupDateValueItemData' response_times_error_calls: $ref: '#/components/schemas/GroupDateValueItemData' ai_insights: description: AI-generated insights about the Latency dashboard, including response time patterns, slowest APIs, and recommendations type: - object - 'null' ai_insights_metadata: description: Metadata about the AI insights generation process type: - object - 'null' ai_insights_error: description: optional attribute representing whether AI insights call resulted in error type: - boolean - 'null' AuditEntityHistory: type: object description: 'The audit history of a product, API or MCP server: a summary and the matching audit records, paged and sorted like the audit list. ' properties: search_time: $ref: '#/components/schemas/NonNegativeInteger' total: description: Number of audit records about the entity after filters. $ref: '#/components/schemas/NonNegativeInteger' entity: $ref: '#/components/schemas/AuditEntity' summary: type: object properties: first_seen: type: - string - 'null' format: date-time description: Time of the oldest matching audit record. last_seen: type: - string - 'null' format: date-time description: Time of the newest matching audit record. actions: type: object description: Number of audit records for each action, e.g. create, update, delete. additionalProperties: type: integer outcomes: type: object description: Number of audit records for each outcome (success, failure, pending). additionalProperties: type: integer users: type: array description: Who changed the entity most, by initiator name. items: $ref: '#/components/schemas/AuditEntityCount' catalogs: type: array description: Catalogs the entity was changed in. items: $ref: '#/components/schemas/AuditEntityCount' versions: type: array description: 'Versions of the entity with audit records, most recently changed first. Omitted when the history is for one version. ' items: type: object properties: version: type: string events: type: integer last_seen: type: string format: date-time first: $ref: '#/components/schemas/PaginationLink' next: $ref: '#/components/schemas/PaginationLink' previous: $ref: '#/components/schemas/PaginationLink' last: $ref: '#/components/schemas/PaginationLink' audits: type: array items: $ref: '#/components/schemas/AuditResponse' CatalogBreakdown: type: array description: An array of catalog breakdown information items: type: object properties: name: type: string total: type: number errors: type: number success: type: number FilterParamLevel4: type: object description: Filter parameter for nested fields. properties: key: type: string name: type: string text: type: string type: type: string nestedFields: $ref: '#/components/schemas/FilterParamListLevel5' WmMigrationRequest: description: Request object to create a migration $ref: '#/components/schemas/MigrationRequest' Id: type: string description: Event ID. minLength: 1 maxLength: 1000 HeaderItem: type: object description: An HTTP header additionalProperties: true EventContextPolicy: type: object properties: key: type: string description: 'Identifies the same policy across calls: task and name (or title), with a counter when a policy runs more than once. ' task: type: string name: type: string title: type: string value_ms: type: number description: Duration in this event. p50_ms: type: number p95_ms: type: number delta_ms: type: number description: This event's duration minus the usual (p50) duration. present_in_pct: type: number description: Percentage of sampled calls that ran this policy. LatencyInfoItem: type: object description: An object representing the latency information for an API assembly policy properties: started: type: string description: The time the policy started task: type: string description: The type of policy name: type: string description: The name of the policy (optional) title: type: string description: The title of the policy (optional) error_message: type: string description: Any error message from the policy (optional) RerouteBody: type: object properties: commands: type: array items: type: object additionalProperties: true FilterParamList: type: array description: Array of filter params. items: $ref: '#/components/schemas/FilterParam' ApplicationDashboardResponse: type: object description: Data to display on the Application Dashboard. properties: search_time: $ref: '#/components/schemas/NonNegativeInteger' total_applications: $ref: '#/components/schemas/NonNegativeInteger' total_client_ids: $ref: '#/components/schemas/NonNegativeInteger' top_apps_over_time: $ref: '#/components/schemas/GroupDateValueItemData' top_apps_by_calls: $ref: '#/components/schemas/GroupValueDataList' top_apps_for_errors_over_time: $ref: '#/components/schemas/GroupDateValueItemData' top_apps_by_errors: $ref: '#/components/schemas/GroupValueDataList' top_apps_rate_limited: $ref: '#/components/schemas/GroupValueDataList' ai_insights: description: AI-generated insights about the Application dashboard, including usage patterns, error analysis, and recommendations type: - object - 'null' ai_insights_metadata: description: Metadata about the AI insights generation process type: - object - 'null' ai_insights_error: description: optional attribute representing whether AI insights call resulted in error type: - boolean - 'null' UmsReportResponse: type: object description: UMS (Usage Metering Service) metering data for license compliance tracking properties: data: type: array items: type: object properties: processing: type: string enum: - ADD - MAX description: Processing type for metric aggregation instances: type: array description: List of instances reporting metrics items: type: object properties: metrics: type: array description: List of metrics for this instance items: type: object properties: productId: type: string description: Product ID from license annotations productName: type: string description: Product name from license annotations cloudpakId: type: string description: Cloud Pak ID (empty for non-CP4I environments) cloudpakName: type: string description: Cloud Pak name (empty for non-CP4I environments) metricName: type: string description: Metric name from license annotations metricDescription: type: string description: Description of the metric being reported metricType: type: string enum: - CONTRACTUAL - USAGE description: Type of metric (CONTRACTUAL for compliance) measurementTimestamp: type: string format: date-time description: Timestamp when measurement was taken (ISO 8601 format) metricQuantity: type: integer description: Total API call count (API + AI calls combined) GroupValueDataList: type: object properties: description: type: string description: Description of what this chart data represents total: type: integer data: $ref: '#/components/schemas/GroupValueItemList' IwhiMeteringReportResponse: type: object description: IWHI (IBM webMethods Hybrid Integration) metering data for license compliance tracking properties: product: type: string description: Product identifier version: type: string description: Product version runtimeId: type: string description: Cloud runtime name tenant: type: string description: Tenant name alias: type: string description: Optional tenant alias from: type: integer format: int64 description: Start date timestamp in milliseconds to: type: integer format: int64 description: End date timestamp in milliseconds usageData: type: array description: List of usage data collected for specified period items: type: object properties: tenantId: type: string description: Tenant ID from: type: integer format: int64 description: Start date timestamp in milliseconds to: type: integer format: int64 description: End date timestamp in milliseconds count: type: integer description: Total call count measurements: type: object description: Measurement metrics properties: ApiCallsNumber: type: integer description: Total API call count (API + AI calls combined) EventBody: type: object description: The API Event logged by the gateway additionalProperties: true properties: ai_cache_hit: type: boolean description: If the request hit the gateway AI LLM cache ai_model: type: string description: The AI LLM Model name/ID ai_request_tokens: type: number description: The request AI LLM token count ai_response_tokens: type: number description: The response AI LLM token count ai_total_tokens: type: number description: The total of the AI LLM request and response token counts alert_source: type: string description: The source the alert is coming from api_version: type: string description: The version of the API api_name: type: string description: The name of the API api_id: type: string description: The ID of the API api_resource_id: type: string description: The API resource ID api_type: type: string description: The API type, mcp, rest, soap or graphql enum: - rest - soap - graphql - mcp app_lifecycle_state: type: string description: The lifecycle state of the calling application backend_method: type: string description: The backend HTTP method backend_request_body: type: string description: The backend request body payload backend_request_headers: type: array description: The backend request headers items: $ref: '#/components/schemas/HeaderItem' backend_response_body: type: string description: The backend response body payload backend_response_headers: type: array description: The backend response headers items: $ref: '#/components/schemas/HeaderItem' backend_status_code: type: string description: The backend HTTP response status code example: 200 OK backend_time_to_serve_request: type: number description: The backend time taken to serve the request billing: type: object description: Billing information if monetization is being used properties: trial_period_days: description: The number of trial days type: number currency: type: string description: The billing currency example: USD model: type: string description: The billing model in use example: free amount: description: The billing price type: number provider: type: string description: The billing provider URL example: none bytes_received: type: number description: The number of bytes received by the gateway bytes_sent: type: number description: The number of bytes sent by the gateway cached_response: type: boolean description: Whether this response was served from the gateway cache or not callback_request: type: boolean description: Shows whether this was a callback request catalog_id: type: string description: The catalog ID catalog_name: type: string description: The catalog name client_id: type: string description: The application client ID used client_ip: type: string description: The consumer IP address client_geoip: type: object description: The geographical data for the client IP address if GeoIP filtering is enabled in ingestion properties: country_name: type: string description: The consumer country name example: United States continent_code: type: string description: The consumer continent code example: NA location: type: object description: The geographical data for the client IP address properties: lat: type: string description: The consumer latitude coordinate long: type: string description: The consumer longitude coordinate timezone: type: string description: The consumer timezone example: America/New York country_code3: type: string description: A three letter code representing the consumer country example: US latitude: type: string description: The consumer latitude coordinate country_code2: type: string description: A two letter code representing the consumer country example: US longitude: type: string description: The consumer longitude coordinate ip: type: string description: The consumer IP address custom_data: type: array description: Optional custom_data information items: $ref: '#/components/schemas/CustomDataItem' datetime: type: string format: date-time description: The date time of the API event from the gateway developer_org_id: type: string description: The consumer organization ID developer_org_name: type: string description: The consumer organization name developer_org_title: type: string description: The consumer organization title document_size: type: number description: The size of this event document in bytes domain_name: type: string example: apiconnect description: The gateway domain name endpoint_url: type: string event_type: type: string description: The event type external_calls: type: array description: Array of information about external calls made by the gateway items: type: object external_provider: type: boolean default: false description: Indicates if this API call originated from an external provider managed via the developer portal gateway_host: type: string description: The host name of the gateway gateway_ip: type: string description: The IP address of the gateway gateway_geoip: type: object description: The geographical data for the gateway IP address if GeoIP filtering is enabled in ingestion properties: country_name: type: string description: The gateway country name example: United States continent_code: type: string description: The gateway continent code example: NA location: type: object description: The geographical data for the gateway IP address properties: lat: type: string description: The gateway latitude coordinate long: type: string description: The gateway longitude coordinate timezone: type: string description: The gateway timezone example: America/New York country_code3: type: string description: A three letter code representing the gateway country example: US latitude: type: string description: The gateway latitude coordinate country_code2: type: string description: A two letter code representing the gateway country example: US longitude: type: string description: The gateway longitude coordinate ip: type: string description: The gateway IP address gateway_port: type: string description: The port number of the gateway gateway_service_name: type: string description: The service name of the gateway (apigw only) gateway_time_to_serve_request: type: number description: The gateway time taken to serve the request gateway_type: type: string description: The type of the gateway global_transaction_id: type: string description: The transaction ID from the gateway headers: type: object description: Internal headers array from ingestion host: type: string description: The ingestion host IP address http_user_agent: type: string description: The caller user agent string example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.102 Safari/537.36 immediate_client_ip: type: string jsonrpc_request_id: type: string description: JSON-RPC request ID latency_info: type: array description: Latency information for the assembly policies items: $ref: '#/components/schemas/LatencyInfoItem' log_policy: type: string description: The log policy used mcp_method_name: type: string description: The MCP method name mcp_prompt_name: type: string description: The MCP prompt name mcp_tool_name: type: string description: The MCP tool name mcp_resource_uri: type: string description: The MCP resource URI mcp_operation_name: type: string description: The MCP operation name mcp_server_version: type: string description: The MCP server version mcp_server_name: type: string description: The MCP server name mcp_server_id: type: string description: The MCP server ID mcp_server_title: type: string description: The MCP server title mcp_session_id: type: string description: The MCP session_id mcp_tool_call_arguments: type: string description: The MCP tool call arguments mcp_tool_call_result: type: string description: The MCP tool call result opentracing_info: type: array description: Optional opentracing information items: $ref: '#/components/schemas/OpentracingInfoItem' operation_path: type: string description: The API operation path for REST, or SOAP operation name org_name: type: string description: The provider organization name org_id: type: string description: The provider organization ID plan_id: type: string description: The plan ID plan_name: type: string description: The plan name product_version: type: string description: The product version product_name: type: string description: The product name product_id: type: string description: The product ID product_title: type: string description: The product title protocol_version: type: string description: Protocol version query_string: type: string description: Any provided query parameters rate_limit: type: object description: Rate limit information for plans request_body: type: string description: The request body payload request_http_headers: type: array description: The request headers items: $ref: '#/components/schemas/HeaderItem' request_method: type: string description: The request HTTP method request_protocol: type: string description: The request protocol resource_id: type: string description: The resource ID resource_path: type: string description: The resource path response_body: type: string description: The response body payload response_http_headers: type: array description: The response headers items: $ref: '#/components/schemas/HeaderItem' rpc_status_code: type: string description: The RPC response status code scope: type: string description: The scope space_id: type: string description: The space ID (not present for non-space APIs) space_name: type: string description: The space name (not present for non-space APIs) status_code: type: string description: The HTTP response status code example: 200 OK tags: type: array description: Internal tags on the API event items: type: string example: apicapievent time_to_serve_request: type: number description: The time taken to serve the request transaction_id: type: string description: The internal transaction ID uri_path: type: string description: The URI path websocket_message_type: type: string description: The message type for websocket API calls websocket_origin: type: string description: The origin of websocket API calls required: - datetime - event_id AliasBody: type: object description: OpenSearch alias additionalProperties: true BackendPolicyErrorsData: type: object properties: description: type: string description: Description of what this data represents total: $ref: '#/components/schemas/NonNegativeInteger' offset: $ref: '#/components/schemas/NonNegativeInteger' limit: $ref: '#/components/schemas/NonNegativeInteger' data: type: array items: $ref: '#/components/schemas/BackendPolicyErrorItem' ConfigSyncLeaderboardDetailReportResponse: type: object description: Leaderboard detail for config sync report properties: search_time: $ref: '#/components/schemas/NonNegativeInteger' org_name: type: string catalog_name: type: string start: type: string format: date-time end: type: string format: date-time type: type: string enum: - configSync total_apis: type: object description: Total APIs with description properties: description: type: string description: Description of total APIs metric data: type: number description: Total number of APIs total_products: type: object description: Total products with description properties: description: type: string description: Description of total products metric data: type: number description: Total number of products total_applications: type: object description: Total applications with description properties: description: type: string description: Description of total applications metric data: type: number description: Total number of applications total_consumer_orgs: type: object description: Total consumer organizations with description properties: description: type: string description: Description of total consumer organizations metric data: type: number description: Total number of consumer organizations total_users: type: object description: Total users with description properties: description: type: string description: Description of total users metric data: type: number description: Total number of users total_subscriptions: type: object description: Total subscriptions with description properties: description: type: string description: Description of total subscriptions metric data: type: number description: Total number of subscriptions SecureSettingsPassword: type: object properties: secure_settings_password: type: string GatewayServiceLeaderboardDetailReportResponse: type: object description: Leaderboard detail for gateway service report properties: org_name: type: string catalog_name: type: string space_name: type: string catalogs: description: Semicolon separated list of org/catalog names example: custom-org/custom-cat;other-org/other-cat type: string ref: type: string example: v6gw trends: type: object description: Trends section with description properties: description: type: string description: Description of the trends data api_calls: $ref: '#/components/schemas/ReportTrendComponent' success_rate: $ref: '#/components/schemas/ReportTrendComponent' errors: $ref: '#/components/schemas/ReportTrendComponent' avg_response_time: $ref: '#/components/schemas/ReportTrendComponent' start: type: string format: date-time end: type: string format: date-time type: type: string enum: - gatewayService gateway_type: description: The gateway type associated with each gateway service type: string breakdown: $ref: '#/components/schemas/BreakDownData' usage: $ref: '#/components/schemas/GroupDateValueItemData' data_usage: $ref: '#/components/schemas/GroupDateValueItemData' latency: $ref: '#/components/schemas/GroupDateValueItemData' api_leaderboard: type: object description: API leaderboard with description properties: description: type: string description: Description of the API leaderboard total: type: integer description: Total number of items offset: type: integer description: Current offset limit: type: integer description: Items per page data: type: array items: $ref: '#/components/schemas/LeaderboardRankedItem' product_leaderboard: type: object description: Product leaderboard with description properties: description: type: string description: Description of the product leaderboard total: type: integer description: Total number of items offset: type: integer description: Current offset limit: type: integer description: Items per page data: type: array items: $ref: '#/components/schemas/LeaderboardRankedItem' ConsumerTrendReportResponse: type: object description: Data to display on the consumer trends report. properties: org_name: type: string catalog_name: type: string space_name: type: string start: type: string format: date-time end: type: string format: date-time trends: type: object description: Trends section with description properties: description: type: string description: Description of the trends data app_count: $ref: '#/components/schemas/ReportTrendComponent' subscription_count: $ref: '#/components/schemas/ReportTrendComponent' consumer_count: $ref: '#/components/schemas/ReportTrendComponent' applications: $ref: '#/components/schemas/GroupDataValueForecastItemData' subscriptions: $ref: '#/components/schemas/GroupDataValueForecastItemData' consumers: $ref: '#/components/schemas/GroupDateValueItemData' ai_insights: description: AI-generated insights about Consumer trends report type: - object - 'null' ai_insights_metadata: description: Metadata about the AI insights generation process type: - object - 'null' ai_insights_error: description: optional attribute representing whether AI insights call resulted in error type: - boolean - 'null' PurgeIndicesResponse: type: object description: Response after deleting indices properties: result: type: string description: Returns whether the process was successful reason: type: string description: Describes the reason for the result EventContextBaseline: type: object description: 'How the event compares with calls to the same operation (or, when the operation is not known, the same API version) over the baseline period. ' required: - scope_field - scope_label - period - sample_size properties: scope_field: type: string description: Event field the baseline is grouped on, for example api_resource_id. scope_label: type: string description: Readable label for the baseline scope. period: type: string description: Length of the baseline period, for example 24h. sample_size: $ref: '#/components/schemas/NonNegativeInteger' latency_ms: $ref: '#/components/schemas/EventContextPercentiles' gateway_latency_ms: $ref: '#/components/schemas/EventContextPercentiles' backend_latency_ms: $ref: '#/components/schemas/EventContextPercentiles' request_bytes: $ref: '#/components/schemas/EventContextPercentiles' response_bytes: $ref: '#/components/schemas/EventContextPercentiles' error_rate_pct: type: number description: Percentage of calls in the baseline period with a 4xx or 5xx status code. status_share: type: array description: Share of calls by status code over the baseline period (top 10). items: type: object properties: status: type: string pct: type: number AttributeListArray: type: array items: $ref: '#/components/schemas/AttributeListItem' OperatorsTypeList: type: object description: Object of operators by type. properties: string: $ref: '#/components/schemas/OperatorList' number: $ref: '#/components/schemas/OperatorList' date: $ref: '#/components/schemas/OperatorList' ipaddress: $ref: '#/components/schemas/OperatorList' boolean: $ref: '#/components/schemas/OperatorList' object: $ref: '#/components/schemas/OperatorList' FilterParamListLevel1: type: array description: Array of filter params for nested fields. items: $ref: '#/components/schemas/FilterParamLevel1' Operator: type: object description: Operator object properties: text: type: string operator: type: string ClusterMgmtObjectResponse: type: object description: ClusterMgmt object response content additionalProperties: true EventContextResponse: type: object description: 'Investigation context for an API event, including a comparison of its performance with recent calls. Each section is optional and is omitted when it cannot be calculated. All date-time values are UTC. ' properties: baseline: $ref: '#/components/schemas/EventContextBaseline' blast_radius: $ref: '#/components/schemas/EventContextBlastRadius' changes: $ref: '#/components/schemas/EventContextChanges' related: $ref: '#/components/schemas/EventContextRelated' performance: $ref: '#/components/schemas/EventContextPerformance' AttributeListItem: type: object properties: name: type: string id: type: string version: type: string count: type: number BackendSlowRequestItem: type: object properties: id: type: string date: type: string value: type: number backend_url: type: string api_name: type: string backend_status_code: type: string InactiveProductResponse: type: object description: Inactive product response properties: start: type: string format: date-time end: type: string format: date-time total: type: number inactive_items: $ref: '#/components/schemas/InactiveProducts' GroupDateValueItem: type: object properties: group: type: string date: type: string value: type: number DiskUsageReportResponse: type: object description: Data to display on the Disk Usage report. properties: search_time: type: number description: Time taken for the search in milliseconds type: type: string description: Type of disk usage report (e.g., api, product, application, consumerorg) total_storage: type: object description: Total storage used with description properties: description: type: string description: Description of total storage metric bytes: type: number description: Total storage in bytes value: type: number description: Formatted storage value unit: type: string description: Unit of storage (KB, MB, GB) storage_breakdown: type: object description: Breakdown of storage by source properties: description: type: string description: Description of storage breakdown api_events: type: object properties: bytes: type: number value: type: number unit: type: string summary_data: type: object properties: bytes: type: number value: type: number unit: type: string total_api_calls: type: object description: Total API calls with description properties: description: type: string description: Description of total API calls metric data: type: number description: Total number of API calls data: type: array description: List of disk usage data items items: type: object properties: ref: type: string description: Reference identifier for the entity storage: type: object description: Storage used by this entity properties: bytes: type: number description: Storage in bytes value: type: number description: Formatted storage value unit: type: string description: Unit of storage (KB, MB, GB) api_calls: type: number description: Number of API calls for this entity average_event_size: type: object description: Average size per event properties: bytes: type: number description: Average size in bytes value: type: number description: Formatted average size value unit: type: string description: Unit of size (KB, MB, GB) percentage_of_total: type: number description: Percentage of total storage used total: type: number description: Total number of items available limit: type: number description: Number of items per page offset: type: number description: Offset for pagination ai_insights: description: AI-generated insights about disk usage patterns, trends, anomalies, and recommendations type: - object - 'null' ai_insights_metadata: description: Metadata about the AI insights generation process type: - object - 'null' ai_insights_error: description: optional attribute representing whether AI insights call resulted in error type: - boolean - 'null' GroupValueItemList: type: array items: $ref: '#/components/schemas/GroupValueItem' ConsumerApiCallsList: type: object properties: total: $ref: '#/components/schemas/NonNegativeInteger' data: $ref: '#/components/schemas/ConsumerEventArray' QueryUpdateRequest: type: object description: Request body to update a query. properties: title: type: string description: type: string query_string: type: string settings: type: object additionalProperties: true ProductListResponse: type: object description: Data to get the list of products and their count. properties: start: type: string format: date-time end: type: string format: date-time products: type: object properties: total: $ref: '#/components/schemas/NonNegativeInteger' data: $ref: '#/components/schemas/AttributeListArray' SeedTrialDataResponse: type: object properties: status: type: string message: type: string RefApiCallsData: type: array description: An array of reference field details in the consumer trend report details items: type: object properties: ref: description: The reference field for this artifact type: string example: corg-shirt org_name: type: string catalog_name: type: string value: type: number StatusCodesCount: type: object description: Data to display the breakdown of API calls per status code properties: description: type: string description: Description of what this status code data represents data: type: array items: $ref: '#/components/schemas/GroupValueItem' SummaryList: type: array description: Array of summary API events. items: $ref: '#/components/schemas/SummaryBody' ApiListResponse: type: object description: Data to get the list of APIs and their count. properties: start: type: string format: date-time end: type: string format: date-time apis: type: object properties: total: $ref: '#/components/schemas/NonNegativeInteger' data: $ref: '#/components/schemas/AttributeListArray' ClusterMgmtIngestionResponse: type: object description: ClusterMgmt ingestion response content properties: data: type: object additionalProperties: true GroupKeyValueItemList: type: array items: $ref: '#/components/schemas/GroupKeyValueItem' Settings: type: object additionalProperties: true BackendStatusCodeMismatchData: type: object properties: description: type: string description: Description of what this data represents total: $ref: '#/components/schemas/NonNegativeInteger' matched_value: $ref: '#/components/schemas/NonNegativeInteger' unmatched_value: $ref: '#/components/schemas/NonNegativeInteger' data: type: array items: $ref: '#/components/schemas/BackendStatusCodeMismatchItem' GroupValueItem: type: object properties: group: type: string value: type: integer LeaderboardRankedItem: type: object properties: rank: description: This items rank position, e.g. 1 equals first type: number ref: description: The reference field for this artifact, e.g. apiname:version or productname:version or productname:version:plan type: string example: apiname:1.0.0 gateway_type: description: The gateway type associated with each gateway service type: string catalogs: $ref: '#/components/schemas/CatalogBreakdown' total: type: number errors: type: number success: type: number GroupDateValueForecastItemList: type: array items: $ref: '#/components/schemas/GroupDateValueForecastItem' DeprecatedProductResponse: type: object description: Deprecated product response properties: start: type: string format: date-time end: type: string format: date-time total: type: number deprecated_items: $ref: '#/components/schemas/DeprecatedProducts' ClusterMgmtCatResponse: type: object description: ClusterMgmt array response content properties: data: type: array items: type: object additionalProperties: true StatusCodeMismatchResponse: type: object description: Paginated list of status code mismatch events. properties: total: $ref: '#/components/schemas/NonNegativeInteger' search_time: $ref: '#/components/schemas/NonNegativeInteger' offset: $ref: '#/components/schemas/NonNegativeInteger' limit: $ref: '#/components/schemas/NonNegativeInteger' first: $ref: '#/components/schemas/PaginationLink' next: $ref: '#/components/schemas/PaginationLink' previous: $ref: '#/components/schemas/PaginationLink' last: $ref: '#/components/schemas/PaginationLink' data: type: array items: $ref: '#/components/schemas/BackendStatusCodeMismatchItem' GroupKeyValueDataList: type: object properties: description: type: string description: Description of what this chart data represents total: type: integer data: $ref: '#/components/schemas/GroupKeyValueItemList' InactiveCorgTableResponse: type: object description: Inactive consumer organizations funnel response properties: start: type: string format: date-time end: type: string format: date-time total: type: number inactive_items: $ref: '#/components/schemas/InactiveCorgs' FunnelReport: type: object description: Part of the funnel report response properties: count: type: number example: 10 percent: type: number example: 1 ErrorTargetModel: type: object description: Contains information about specific error targets. properties: type: type: string description: Either field, parameter, or header. name: type: string description: The name of the problematic field (with dot-syntax if necessary), query parameter, or header. SummaryResponse: type: object description: Summary API event response. allOf: - $ref: '#/components/schemas/Summary' ScrollRequest: type: object properties: size: type: number description: 'The number of results that you want returned for each batch. Defaults to 1000. Requests with a scroll_id will ignore this field. ' scroll: type: string description: 'Tell OpenSearch how long you need to keep scrolling. Defaults to ''10m''. This search context needs to be long enough to process a single batch of results. ' scroll_id: type: string description: Pass this scroll ID to the scroll operation to get back the next batch of results. AgentApiMetrics: type: object properties: transactionCount: type: number description: Total transactions of the runtime/api. example: 100 averageLatency: type: number description: Average latency of the runtime/api. example: 1.04 averageResponseTime: type: number description: Average response time of the runtime/api. example: 3.05 averageBackendResponseTime: type: number description: Average backend response time of the runtime/api. example: 2.01 NonNegativeInteger: type: integer description: Integer greater than or equal to zero. minimum: 0 GroupDateValueItemList: type: array items: $ref: '#/components/schemas/GroupDateValueItem' ServiceStatusResponse: type: object description: Response showing analytics service information. properties: initial_transform: type: boolean long_term_data_enabled: type: boolean storage_enabled: type: boolean rollover_ok: type: boolean aws_storage: type: boolean geoip_enabled: type: boolean diskspace_ok: type: boolean transform_ok: type: boolean storage_memory_ok: type: boolean reindex_ok: type: boolean analytics_mode_enabled: type: boolean federated_api_management_mode_enabled: type: boolean dev_portal_mode_enabled: type: boolean reconciled_version: type: string api_agent: type: boolean api_security_mode_enabled: type: boolean ProviderConsumerAnalyticsResponse: type: object description: Data to display on the consumer analytics Dashboard. properties: search_time: $ref: '#/components/schemas/NonNegativeInteger' status_codes: $ref: '#/components/schemas/GroupValueDataList' min_response_time: $ref: '#/components/schemas/DataItem' avg_response_time: $ref: '#/components/schemas/DataItem' max_response_time: $ref: '#/components/schemas/DataItem' total_api_calls: $ref: '#/components/schemas/DataItem' total_errors: $ref: '#/components/schemas/DataItem' errors: $ref: '#/components/schemas/GroupDateValueItemData' throttled_calls: $ref: '#/components/schemas/GroupDateValueItemData' api_calls_per_day: $ref: '#/components/schemas/GroupDateValueItemData' last_api_calls: $ref: '#/components/schemas/ConsumerApiCallsList' top_apis_over_time: $ref: '#/components/schemas/GroupDateValueItemData' top_products_over_time: $ref: '#/components/schemas/GroupDateValueItemData' top_api_paths_by_calls: $ref: '#/components/schemas/GroupValueDataList' apis_with_slowest_response_time: $ref: '#/components/schemas/GroupKeyValueDataList' apis_with_fastest_response_time: $ref: '#/components/schemas/GroupKeyValueDataList' SummaryBody: type: object description: The Analytics summary event which is generated by transforming the API event data additionalProperties: true properties: api_ref: type: string description: The API reference (name:version) api_type: type: string description: The API type (e.g. rest,soap,graphql,llm,mcp) app_name: type: string description: The name of the application bytes_received: type: number description: The number of bytes received by the gateway bytes_sent: type: number description: The number of bytes sent by the gateway catalog_name: type: string description: The catalog name datetime: type: string format: date-time description: The date time of the API event from the gateway developer_org_name: type: string description: The consumer organization name event_count: type: number description: The number of API calls aggregated into this summary record gateway_service_name: type: string description: The service name of the gateway (apigw only) mcp_server_ref: type: string description: The MCP server reference (mcp_server_name:version) plan_id: type: string description: The plan ID product_ref: type: string description: The product reference (product_name:version) org_name: type: string description: The provider organization name space_name: type: string description: The space name (not present for non-space APIs) status_code: type: string description: The HTTP response status code example: 200 OK summary_event_id: $ref: '#/components/schemas/Id' time_to_serve_request: type: number description: The time taken to serve the request EventContextPercentiles: type: object description: Percentiles over the baseline period and the event's own value. properties: p50: type: number p90: type: - number - 'null' p95: type: - number - 'null' p99: type: - number - 'null' value: type: - number - 'null' description: Value for this event. percentile_rank: type: number description: Percentile rank (0-100) of this event's value within the baseline. SummaryListResponse: type: object description: Summary API event list response. required: - total - search_time - events properties: total: $ref: '#/components/schemas/NonNegativeInteger' search_time: $ref: '#/components/schemas/NonNegativeInteger' offset: $ref: '#/components/schemas/NonNegativeInteger' limit: $ref: '#/components/schemas/NonNegativeInteger' first: $ref: '#/components/schemas/PaginationLink' next: $ref: '#/components/schemas/PaginationLink' previous: $ref: '#/components/schemas/PaginationLink' last: $ref: '#/components/schemas/PaginationLink' events: $ref: '#/components/schemas/SummaryList' ConsumptionResponse: type: object description: Data to display on the Consumption metrics. properties: start: type: string format: date-time end: type: string format: date-time monthly_summary: description: Status-code breakdown for all calls (used by the "All" chart view) $ref: '#/components/schemas/GroupKeyValueDataList' monthly_summary_ai: description: Status-code breakdown for AI calls only (api_type llm or mcp) $ref: '#/components/schemas/GroupKeyValueDataList' monthly_summary_api: description: Status-code breakdown for non-AI API calls only $ref: '#/components/schemas/GroupKeyValueDataList' monthly_data: $ref: '#/components/schemas/ConsumptionDataList' daily_summary: description: Status-code breakdown for all calls (used by the "All" chart view) $ref: '#/components/schemas/GroupKeyValueDataList' daily_summary_ai: description: Status-code breakdown for AI calls only (api_type llm or mcp) $ref: '#/components/schemas/GroupKeyValueDataList' daily_summary_api: description: Status-code breakdown for non-AI API calls only $ref: '#/components/schemas/GroupKeyValueDataList' daily_data: $ref: '#/components/schemas/ConsumptionDataList' InactiveCorgFunnelResponse: type: object description: Inactive consumer organizations funnel response properties: start: type: string format: date-time end: type: string format: date-time total: type: number no_applications: $ref: '#/components/schemas/FunnelReport' no_subscriptions: $ref: '#/components/schemas/FunnelReport' no_traffic: $ref: '#/components/schemas/FunnelReport' no_recent_traffic: $ref: '#/components/schemas/FunnelReport' AliasesBody: type: object description: OpenSearch aliases request body properties: action: type: object additionalProperties: true EventContextChanges: type: object properties: lookback: type: string description: How far back changes were looked for, for example 24h. content_as_of: type: string format: date-time description: 'When the hourly API Manager content data for the event''s catalog was last updated. Creates and updates after this time are not reported from that data yet. ' audit_status: type: string description: 'Whether API Manager audit events are included in the items. included: the audit log was searched. not_permitted: the caller does not have permission to view audit data. unavailable: audit data is not being sent to analytics or could not be read. ' enum: - included - not_permitted - unavailable items: type: array items: $ref: '#/components/schemas/EventContextChange' AiDashboardResponse: type: object description: Data to display on the AI LLM Dashboard. properties: search_time: $ref: '#/components/schemas/NonNegativeInteger' total_consumer_orgs: $ref: '#/components/schemas/DataItem' total_requests: $ref: '#/components/schemas/DataItem' total_tokens: $ref: '#/components/schemas/DataItem' token_count_over_time: $ref: '#/components/schemas/GroupDateValueItemData' token_heatmap: $ref: '#/components/schemas/DateHourValueData' top_consumers_by_token_over_time: $ref: '#/components/schemas/GroupDateValueItemData' top_consumers_by_token: $ref: '#/components/schemas/GroupValueDataList' top_apps_by_token_over_time: $ref: '#/components/schemas/GroupDateValueItemData' top_apps_by_token: $ref: '#/components/schemas/GroupValueDataList' model_usage: $ref: '#/components/schemas/GroupValueDataList' cache_hits_over_time: $ref: '#/components/schemas/GroupDateValueItemData' top_apps_rate_limited: $ref: '#/components/schemas/GroupValueDataList' response_time_percentiles: $ref: '#/components/schemas/GroupDateValueItemData' request_token_count_percentiles: $ref: '#/components/schemas/GroupDateValueItemData' response_token_count_percentiles: $ref: '#/components/schemas/GroupDateValueItemData' ai_insights: description: AI-generated insights about the AI LLM dashboard, including token usage patterns, model performance, and recommendations type: - object - 'null' ai_insights_metadata: description: Metadata about the AI insights generation process type: - object - 'null' ai_insights_error: description: optional attribute representing whether AI insights call resulted in error type: - boolean - 'null' FilterParam: type: object description: Filter parameter. properties: name: type: string text: type: string type: type: string nestedFields: $ref: '#/components/schemas/FilterParamListLevel1' EventListResponse: type: object description: API event list response. required: - total - search_time - events properties: total: $ref: '#/components/schemas/NonNegativeInteger' search_time: $ref: '#/components/schemas/NonNegativeInteger' offset: $ref: '#/components/schemas/NonNegativeInteger' limit: $ref: '#/components/schemas/NonNegativeInteger' first: $ref: '#/components/schemas/PaginationLink' next: $ref: '#/components/schemas/PaginationLink' previous: $ref: '#/components/schemas/PaginationLink' last: $ref: '#/components/schemas/PaginationLink' events: $ref: '#/components/schemas/EventList' LeaderboardReport: type: object properties: total: type: number data: $ref: '#/components/schemas/LeaderboardRankedWithErrorRate' ProductDashboardResponse: type: object description: Data to display on the PRODUCT Dashboard. properties: search_time: $ref: '#/components/schemas/NonNegativeInteger' apps_per_plan: $ref: '#/components/schemas/GroupValueDataList' total_products: $ref: '#/components/schemas/DataItem' total_plans: $ref: '#/components/schemas/DataItem' top_products_over_time: $ref: '#/components/schemas/GroupDateValueItemData' top_products_by_calls: $ref: '#/components/schemas/GroupValueDataList' top_products_for_errors_over_time: $ref: '#/components/schemas/GroupDateValueItemData' top_products_by_errors: $ref: '#/components/schemas/GroupValueDataList' top_plans_over_time: $ref: '#/components/schemas/GroupDateValueItemData' top_plans_by_calls: $ref: '#/components/schemas/GroupValueDataList' top_plans_for_errors_over_time: $ref: '#/components/schemas/GroupDateValueItemData' top_plans_by_errors: $ref: '#/components/schemas/GroupValueDataList' ai_insights: description: AI-generated insights about the product dashboard, including usage patterns, error analysis, and recommendations type: - object - 'null' ai_insights_metadata: description: Metadata about the AI insights generation process type: - object - 'null' ai_insights_error: description: optional attribute representing whether AI insights call resulted in error type: - boolean - 'null' ApiDashboardResponse: type: object description: Data to display on the API Dashboard. properties: search_time: $ref: '#/components/schemas/NonNegativeInteger' total_apis: $ref: '#/components/schemas/DataItem' total_paths: $ref: '#/components/schemas/DataItem' total_operations: $ref: '#/components/schemas/DataItem' top_apis_over_time: $ref: '#/components/schemas/GroupDateValueItemData' top_apis_by_calls: $ref: '#/components/schemas/GroupValueDataList' top_apis_for_errors_over_time: $ref: '#/components/schemas/GroupDateValueItemData' top_apis_by_errors: $ref: '#/components/schemas/GroupValueDataList' top_apis_using_analytics_storage: $ref: '#/components/schemas/GroupValueDataList' top_api_paths_by_calls: $ref: '#/components/schemas/GroupValueDataList' top_api_paths_by_errors: $ref: '#/components/schemas/GroupValueDataList' cached_api_calls_over_time: $ref: '#/components/schemas/GroupDateValueItemData' api_type_calls_over_time: $ref: '#/components/schemas/GroupDateValueItemData' ai_insights: description: AI-generated insights about the API dashboard, including performance analysis, error patterns, and recommendations type: - object - 'null' ai_insights_metadata: description: Metadata about the AI insights generation process type: - object - 'null' ai_insights_error: description: optional attribute representing whether AI insights call resulted in error type: - boolean - 'null' BackendStatusCodeMismatchItem: type: object properties: id: type: string date: type: string status_code: type: string backend_status_code: type: string api_name: type: string backend_url: type: string PlanListResponse: type: object description: Data to get the list of plans and their count. properties: start: type: string format: date-time end: type: string format: date-time plans: type: object properties: total: $ref: '#/components/schemas/NonNegativeInteger' data: $ref: '#/components/schemas/AttributeListArray' DataDashboardResponse: type: object description: Data to display on the DATA Dashboard. properties: search_time: $ref: '#/components/schemas/NonNegativeInteger' top_apis_by_request_size: $ref: '#/components/schemas/GroupKeyValueDataList' top_apis_by_response_size: $ref: '#/components/schemas/GroupKeyValueDataList' top_apps_by_request_size: $ref: '#/components/schemas/GroupKeyValueDataList' top_apps_by_response_size: $ref: '#/components/schemas/GroupKeyValueDataList' top_corgs_by_request_size: $ref: '#/components/schemas/GroupKeyValueDataList' top_corgs_by_response_size: $ref: '#/components/schemas/GroupKeyValueDataList' top_plans_by_request_size: $ref: '#/components/schemas/GroupKeyValueDataList' top_plans_by_response_size: $ref: '#/components/schemas/GroupKeyValueDataList' total_request_size: $ref: '#/components/schemas/DataItem' total_response_size: $ref: '#/components/schemas/DataItem' data_usage_received: $ref: '#/components/schemas/GroupDateValueItemData' data_usage_sent: $ref: '#/components/schemas/GroupDateValueItemData' ai_insights: description: AI-generated insights about the Data dashboard, including data usage patterns, top consumers by data volume, and recommendations type: - object - 'null' ai_insights_metadata: description: Metadata about the AI insights generation process type: - object - 'null' ai_insights_error: description: optional attribute representing whether AI insights call resulted in error type: - boolean - 'null' IndexBody: type: object properties: aliases: type: object additionalProperties: true mappings: type: object additionalProperties: true settings: type: object additionalProperties: true Event: type: object description: API event. properties: id: $ref: '#/components/schemas/Id' event: $ref: '#/components/schemas/EventBody' ConsumptionDataItem: type: object description: An individual data point of API usage by response code additionalProperties: true properties: id: type: string total: type: number other: type: number ai_calls: type: number description: Number of AI calls (api_type llm or mcp) api_calls: type: number description: Number of non-AI API calls RefDetailData: type: array description: An array of reference field details in the application trend report details items: type: object properties: rank: type: number name: type: string total: type: number errors: type: number success: type: number LeaderboardsReportResponse: type: object description: Leaderboard Response properties: org_name: type: string catalog_name: type: string space_name: type: string start: type: string format: date-time end: type: string format: date-time type: type: string enum: - api - product - plan - applications - consumerOrg - gatewayService - configSync leaderboard: $ref: '#/components/schemas/LeaderboardReport' ai_insights_error: description: optional attribute representing whether AI insights call resulted in error type: - boolean - 'null' ErrorModels: type: array description: Array of more detailed error information. items: type: object properties: code: type: string description: A snake case string succinctly identifying the problem. message: type: string description: A plainly-written, developer-oriented explanation of the solution to the problem in complete, well-formed sentences. more_info: type: string description: A publicly-accessible URL where information about the error can be read. target: $ref: '#/components/schemas/ErrorTargetModel' FilterParamListLevel3: type: array description: Array of filter params for nested fields. items: $ref: '#/components/schemas/FilterParamLevel3' ConsumerOrgListResponse: type: object description: Data to get the list of consumer and their count. properties: start: type: string format: date-time end: type: string format: date-time consumer_orgs: type: object properties: total: $ref: '#/components/schemas/NonNegativeInteger' data: $ref: '#/components/schemas/AttributeListArray' EventContextSampleStats: type: object properties: value: type: - number - 'null' description: Value for this event. p50: type: number p95: type: number GatewayServiceNamesByScopes: type: array description: An array of gateway service names linked to each org, catalog and space scope items: type: object properties: org_name: type: string catalog_name: type: string space_name: type: string gateway_service_name: type: string PaginationLink: type: object description: Pagination link used in list responses. properties: href: type: string Message: type: array items: type: string description: Detailed error message. example: Invalid request payload JSON format. SummaryDashboardResponse: type: object description: Data to display on the Summary Dashboard. properties: search_time: $ref: '#/components/schemas/NonNegativeInteger' avg_response_time: $ref: '#/components/schemas/DataItem' total_applications: $ref: '#/components/schemas/DataItem' total_apis: $ref: '#/components/schemas/DataItem' total_products: $ref: '#/components/schemas/DataItem' total_consumer_orgs: $ref: '#/components/schemas/DataItem' total_api_calls: $ref: '#/components/schemas/DataItem' total_errors: $ref: '#/components/schemas/DataItem' transactions_per_second: type: object properties: data: description: String representation of a float, but will be shown as `< 0.01` if greater than 0 but rounds to 0. type: string status_codes: $ref: '#/components/schemas/GroupValueDataList' response_times: $ref: '#/components/schemas/GroupDateValueItemData' errors: $ref: '#/components/schemas/GroupDateValueItemData' api_calls_per_day: $ref: '#/components/schemas/GroupDateValueItemData' api_calls_per_day_per_hour: $ref: '#/components/schemas/DateHourValueData' ai_insights: description: AI-generated insights about the API event, including error analysis, performance recommendations, and anomaly detection type: - object - 'null' ai_insights_metadata: description: Metadata about the AI insights generation process type: - object - 'null' ai_insights_error: description: optional attribute representing whether AI insights call resulted in error type: - boolean - 'null' CustomDataItem: type: object description: An optional object containing custom_data information if in use. additionalProperties: true ConsumptionDataList: type: object description: A list of data points on API usage by response code over time properties: total: type: number filter: description: The query filter string used for this search type: string data: $ref: '#/components/schemas/ConsumptionDataItemList' InactiveProducts: type: array description: Array of inactive items items: type: object properties: ref: type: string description: Name of the inactive item catalogs: type: string description: Comma-separated list of org/catalog ConsumerTrendRankedData: type: array description: An array of ranked data as used in consumer trend report leaderboards items: type: object properties: rank: description: This items rank position, e.g. 1 equals first type: number ref: description: The reference field for this artifact, e.g. appname or consumerorgname type: string example: appname value: type: number trend: description: optional attribute representing whether this item is trending up or down type: - string - 'null' enum: - up - down WmapigwMigrationStatusResponse: type: object description: Response from the WMAPIGW migration status API. properties: jobId: type: string description: Identifier for the migration job example: migration-job-wmapigw status: type: string description: Current status of the migration operation example: PROCESSING createdAt: type: string format: date-time description: Time when the migration job was created updatedAt: type: string format: date-time description: Time when the migration job was last updated progress: type: number description: Percentage of migration completed minimum: 0 maximum: 100 example: 65 totalIndices: type: number description: Total number of indices to be migrated example: 10 completedIndices: type: number description: Number of indices that have been successfully migrated example: 6 failedIndices: type: number description: Number of indices that failed to migrate example: 1 currentIndex: type: string description: Name of the index currently being migrated example: apic-events-2025.01 processedDocs: type: number description: Number of documents that have been processed example: 15000 skippedDocs: type: number description: Number of documents that were skipped during migration example: 50 error: type: string description: Error message if migration failed example: Failed to connect to source database canRetry: type: boolean description: Whether the migration can be retried example: true ConsumerEventBody: type: object description: The API Event logged by the gateway additionalProperties: true properties: api_version: type: string description: The version of the API api_name: type: string description: The name of the API api_id: type: string description: The ID of the API api_resource_id: type: string description: The API resource ID app_lifecycle_state: type: string description: The lifecycle state of the calling application bytes_received: type: number description: The number of bytes received by the gateway bytes_sent: type: number description: The number of bytes sent by the gateway client_id: type: string description: The application client ID used datetime: type: string format: date-time description: The date time of the API event from the gateway developer_org_id: type: string description: The consumer organization ID developer_org_name: type: string description: The consumer organization name developer_org_title: type: string description: The consumer organization title document_size: type: number description: The size of this event document in bytes host: type: string description: The ingestion host IP address http_user_agent: type: string description: The caller user agent string example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.102 Safari/537.36 org_name: type: string description: The provider organization name org_id: type: string description: The provider organization ID plan_id: type: string description: The plan ID plan_name: type: string description: The plan name product_version: type: string description: The product version product_name: type: string description: The product name product_id: type: string description: The product ID product_title: type: string description: The product title query_string: type: string description: Any provided query parameters request_body: type: string description: The request body payload request_http_headers: type: array description: The request headers items: $ref: '#/components/schemas/HeaderItem' request_method: type: string description: The request HTTP method request_protocol: type: string description: The request protocol resource_id: type: string description: The resource ID resource_path: type: string description: The resource path response_body: type: string description: The response body payload response_http_headers: type: array description: The response headers items: $ref: '#/components/schemas/HeaderItem' status_code: type: string description: The HTTP response status code example: 200 OK time_to_serve_request: type: number description: The time taken to serve the request uri_path: type: string description: The URI path required: - org_name - org_id - resource_path - status_code - product_name - product_version - product_id - api_name - api_version - api_id FilterParamListLevel5: type: array description: Array of filter params for nested fields. items: $ref: '#/components/schemas/FilterParamLevel5' EventList: type: array description: Array of API events. items: $ref: '#/components/schemas/Event' DeprecatedPollingResponse: type: object description: Deprecated report polling response properties: report_url: type: string description: Partial URL to query for the report generation example: /cloud/reports/deprecated/consumerorg message: type: string description: Information message about the response example: Report processing GroupDataValueForecastItemData: type: object properties: description: type: string description: Description of what this chart data represents data: $ref: '#/components/schemas/GroupDateValueForecastItemList' forecast: $ref: '#/components/schemas/TransparencyMetricsList' WmapigwMigrationStopResponse: type: object description: Stop a migration properties: status: type: string message: type: string EventContextChange: type: object required: - detected_at - source - entity_type - entity_name - change_type properties: detected_at: type: string format: date-time detected_after: type: string format: date-time description: Earliest time the change could have happened, when only a window is known. source: type: string description: 'traffic: derived from API events. management: product lifecycle notifications from API Manager. audit: API Manager audit log. content_snapshot: created_at/updated_at timestamps in the hourly API Manager content data. ' enum: - traffic - management - audit - content_snapshot entity_type: type: string description: 'api, product, plan, gateway, backend, application, consumer_org, subscription, mcp_server or catalog. ' entity_name: type: string change_type: type: string description: 'new_version, version_change, status_change, first_seen, volume_change, state_change, updated, created, modified or audit. ' from: type: string to: type: string description: type: string action: type: string description: Audit events only. The operation performed, for example update or publish. actor: type: string description: Audit events only. Who made the change. audit_id: type: string description: Audit events only. ID of the audit record. snapshot_at: type: string format: date-time description: 'content_snapshot changes only. When the API Manager content data that reported the change was captured. ' target_type: type: string description: 'Audit events only. The kind of API Manager object the record changed, for example app, subscription or catalog. ' published: type: object description: 'Project publish audit events only. What the publish contained, as name:version strings. Lists stop at 100 entries in total, when truncated is true; total is always the full count. ' properties: products: type: array items: type: string apis: type: array items: type: string mcp_servers: type: array items: type: string total: type: integer truncated: type: boolean matched_resources: type: array description: 'Project publish audit events only. Which of this event''s resources (product, api, mcp_server) the publish contained. ' items: type: string outcome: type: string description: 'Audit events only. Set to failure for a publish that failed partway; the items listed in published were published before the failure. ' enum: - failure error: type: string description: Audit events only. Error reported by API Manager for a failed change. pending_approval: type: boolean description: 'Audit events only. True when the change is waiting for approval, so it is not yet live on the gateway. ' relevance: type: string description: 'Audit events only. direct: the record names this event''s API, product, application or consumer organization. catalog: a change in this event''s catalog that does not say which product or API it affected (for example a product publish), so it may or may not be related. ' enum: - direct - catalog EventContextPerformance: type: object description: 'How this event''s assembly policies performed compared with a sample of up to 200 recent successful calls to the same operation (or API version) in the baseline period, plus hourly latency percentiles for the operation. Policy durations are worked out from latency_info: a policy lasts until the next one starts, and the last one until the response was sent. ' properties: scope_label: type: string period: type: string sample_size: $ref: '#/components/schemas/NonNegativeInteger' total_ms: $ref: '#/components/schemas/EventContextSampleStats' backend_ms: $ref: '#/components/schemas/EventContextSampleStats' policies: type: array description: This event's policies, in the order they ran. items: $ref: '#/components/schemas/EventContextPolicy' missing_policies: type: array description: 'Policies that at least 80% of sampled calls ran but this event did not. ' items: $ref: '#/components/schemas/EventContextPolicy' unusual_policies: type: array description: Keys of this event's policies that fewer than 20% of sampled calls ran. items: type: string biggest_contributor: type: string description: Key of the policy that took the most time more than usual. typical_event: type: object description: A sampled call with close to the median total latency, to compare with. properties: event_id: $ref: '#/components/schemas/Id' datetime: type: string format: date-time time_to_serve_request: type: number trend: type: object properties: interval: type: string description: Bucket size, for example 1h. series: type: array items: type: object properties: t: type: string format: date-time count: $ref: '#/components/schemas/NonNegativeInteger' p50: type: - number - 'null' p95: type: - number - 'null' GatewayDashboardResponse: type: object description: Data to display on the GATEWAY Dashboard. properties: search_time: $ref: '#/components/schemas/NonNegativeInteger' description: type: string description: Description of what this dashboard data represents total: $ref: '#/components/schemas/NonNegativeInteger' data: type: array items: $ref: '#/components/schemas/GatewayObject' ai_insights: description: AI-generated insights about the Gateway Operations dashboard, including traffic patterns, latency analysis, and recommendations type: - object - 'null' ai_insights_metadata: description: Metadata about the AI insights generation process type: - object - 'null' ai_insights_error: description: optional attribute representing whether AI insights call resulted in error type: - boolean - 'null' ConsumerDashboardResponse: type: object description: Data to display on the Consumer Dashboard. properties: search_time: $ref: '#/components/schemas/NonNegativeInteger' total_consumer_orgs: $ref: '#/components/schemas/DataItem' average_apps_per_consumer: $ref: '#/components/schemas/NonNegativeInteger' top_corgs_over_time: $ref: '#/components/schemas/GroupDateValueItemData' top_consumers_by_calls: $ref: '#/components/schemas/GroupValueDataList' top_corgs_for_errors_over_time: $ref: '#/components/schemas/GroupDateValueItemData' top_consumers_by_errors: $ref: '#/components/schemas/GroupValueDataList' ai_insights: description: AI-generated insights about the consumer dashboard, including usage patterns, error analysis, and recommendations type: - object - 'null' ai_insights_metadata: description: Metadata about the AI insights generation process type: - object - 'null' ai_insights_error: description: optional attribute representing whether AI insights call resulted in error type: - boolean - 'null' parameters: help_optional: name: help in: query description: If true, the response includes help information. required: false schema: type: boolean snapshots_optional: name: snapshots in: query description: Number of samples of thread stacktrace. Defaults to 10. required: false schema: type: integer groups_optional: name: groups in: query description: Comma-separated list of search groups to include in the search statistics. required: false schema: type: string parent_task_id_optional: name: parent_task_id in: query description: Return tasks with specified parent task ID. required: false schema: type: string auditId_optional: name: id in: query description: Filter result by audit event id required: false schema: type: string example: a3d935afd935cb9da38fe4cd3db05056 nodes_optional: name: nodes in: query description: Comma-separated list of node IDs or names used to limit the request. required: false schema: type: string request_body_optional: name: request_body in: query description: Filter results by request body. required: false schema: type: string example: '{"app_name":"Weather app"}' saved_query_search_optional: name: search in: query description: Search for a saved query by either title, description or query_string. required: false schema: type: string graphql_document_hash_optional: name: graphql_document_hash in: query description: Filter results by graphql document hash value. required: false schema: type: string monitor_attribute_optional: name: monitor_attribute in: query description: Filter results by monitor attribute. required: false schema: type: string product_ref_optional: name: product_ref in: query description: Filter results by product reference (name:version) required: false schema: type: string example: api-connect-lueilwitz-mcclure-handcrafted-intelligent-fresh-tuna-product:1.0.0 all_status_optional: name: all_status in: query description: If true, the response includes all status codes, including those that are not successful. Defaults to false. required: false schema: type: boolean inactive-consumer-report-type: name: inactive-consumer-report-type in: path description: 'Type of inactive consumer report to query. Specifies which category of inactive consumer organizations to retrieve. Possible values: `no_applications` (Consumer organizations with no applications created), `no_subscriptions` (Consumer organizations with no active subscriptions to products), `no_traffic` (Consumer organizations with no API traffic at all), `no_recent_traffic` (Consumer organizations with no recent API traffic within the specified time period).' required: true schema: type: string enum: - no_applications - no_subscriptions - no_traffic - no_recent_traffic example: no_subscriptions opentracing_info_optional: name: opentracing_info in: query description: If set, the value for a given key must match in the opentracing_info array. required: false schema: type: object properties: span_id: type: string trace_id: type: string example: span_id: 400e90d0-b5ea-4ab4-81f0-d336958b97c8 trace_id: 7fa28820-ac69-4f87-8678-b5868f5601bd style: deepObject explode: true threshold_ms_optional: name: threshold_ms in: query description: Running time threshold in milliseconds for identifying stuck tasks. Defaults to 600000 (10 minutes). required: false schema: type: integer alert_type_optional: name: alert_type in: query description: Filter results by alert type. required: false schema: type: string document_size_optional: name: document_size in: query description: Filter results by the document size. required: false schema: type: string example: 500 mcp_prompt_name_optional: name: mcp_prompt_name in: query description: Filter results by MCP prompt name. required: false schema: type: string example: analyze-code reason_optional: name: reason in: query description: Filter result by audit reason required: false schema: type: object example: reasonCode: 200 style: deepObject explode: true client_ip_optional: name: client_ip in: query description: Filter results by client IP address. Only supports equality checks and `not` but no other operator prefixes. Supports CIDR notation based queries, e.g. `client_ip=9.123.234.0/24` required: false schema: type: string example: 9.12.34.56 audit-entity-type: name: audit-entity-type in: path description: The type of resource whose audit history to return. required: true schema: type: string enum: - product - api - mcp_server initiator_optional: name: initiator in: query description: Filter result by audit initiator required: false schema: type: object example: typeURI: www.url.com style: deepObject explode: true gateway_service_name_optional: name: gateway_service_name in: query description: Filter results by gateway service name (only included for apigw services). required: false schema: type: string example: gateway-service1 gateway_port_optional: name: gateway_port in: query description: Filter results by gateway port required: false schema: type: string example: 3000 s_optional: name: s in: query description: Comma-separated list of column names or column aliases used to sort the response. required: false schema: type: string policy-id: name: policy-id in: path description: Identifier of the ISM policy. required: true schema: type: string metric_optional: name: metric in: query description: Limits the information returned to the specified metrics. Defaults to all but metadata. required: false schema: type: string task-id: name: task-id in: path description: ID of the task. required: true schema: type: string timeout_optional: name: timeout in: query description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. required: false schema: type: string mcp_server_id_optional: name: mcp_server_id in: query description: Filter results by MCP server ID. required: false schema: type: string example: d3fcc626-bf11-4318-8045-8d8502608c88 provider_org_id_optional: name: provider_org_id in: query description: Filter results by provider organization ID. required: false schema: type: string example: dc299ac1-223d-4f53-94ce-2f264ea32d81 include_disk_info_optional: name: include_disk_info_optional in: query description: If true, returns information about disk usage and shard sizes. Defaults to false. required: false schema: type: boolean eventGenerator_optional: name: eventGenerator in: query description: filter result by where event was generated required: false schema: type: string example: analytics node-id: name: node-id in: path description: Node ID required: true schema: type: string active_only_optional: name: active_only in: query description: If true, the response only includes ongoing shard recoveries. Defaults to false. required: false schema: type: boolean api_name_optional: name: api_name in: query description: Filter results by API name. required: false schema: type: string example: custom_api mcp_server_name_optional: name: mcp_server_name in: query description: Filter results by MCP server name. required: false schema: type: string example: custom_mcpserver bytes_optional: name: bytes in: query description: Unit used to display byte values. required: false schema: type: string enum: - b - kb - mb - gb - tb - pb features_optional: name: features in: query description: Return information about specific index features. Supports comma- separated values. required: false schema: type: string enum: - aliases - mappings - settings logSourceType_optional: name: logSourceType in: query description: Filter result by log source type required: false schema: type: string interval_optional: name: interval in: query description: The interval to do the second sampling of threads. Defaults to 500ms. required: false schema: type: string example: 500ms end_time_optional: name: end in: query description: 'If set, only return events with a datetime equal or older than this. The value must follow the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z. See https://datatracker.ietf.org/doc/html/rfc3339#section-5.6. ' required: false schema: type: string format: date-time node_names_optional: name: node_names in: query description: A comma-separated list of the names of the nodes. required: false schema: type: string summary-event-id: name: summary-event-id in: path description: 'Analytics summary event ID. This ID is globally unique across the analytics service. ' required: true schema: $ref: '#/components/schemas/Id' catalog_id_optional: name: catalog_id in: query description: Filter results by catalog ID. required: false schema: type: string example: 6c592723-b2b7-49dc-b956-14596b6cc8f3 use_gateway_validation_optional: name: use_gateway_validation in: query description: Indicates whether the request is coming from the wmapigw. This is an internal-use parameter. required: false schema: type: boolean websocket_message_type_optional: name: websocket_message_type in: query description: Filter results by websocket message type required: false schema: type: string types_optional: name: types in: query description: A comma-separated list of document types for the indexing index metric. required: false schema: type: string audit_changes_only_optional: name: changes_only in: query description: 'If true, only return changes: leave out reads, sign-ins, sign-outs and token refreshes. Defaults to false. ' required: false schema: type: boolean include_others_optional: name: include_others in: query description: If true the dashboard top x charts will include a representation of what share of the whole the top x represents. required: false schema: type: boolean api_ref_optional: name: api_ref in: query description: Filter results by API reference (name:version) required: false schema: type: string example: card-services-lock-control-api-api:1.0.0 tags_optional: name: tags in: query description: Filter result by audit tags required: false schema: type: string example: apicnonapievent limit_optional: name: limit in: query description: 'If set, the number of items to return when requesting a list. Maximum: 500' required: false schema: type: string example: '50' audit_entity_sort_optional: name: sort in: query description: 'Order of the audit records by event time: -eventTime for newest first (the default) or eventTime for oldest first. ' required: false schema: type: string enum: - eventTime - -eventTime wait_for_nodes_optional: name: wait_for_nodes in: query description: The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and : or :: where type is product, api or mcp_server. Includes changes to its drafts, publishing and lifecycle changes. ' required: false schema: type: string maxLength: 530 pattern: ^(product|api|mcp_server):[^:]+(:[^:]+)?$ example: product:orders:1.0.0 ai_response_tokens_optional: name: ai_response_tokens in: query description: Filter results by AI LLM response tokens. required: false schema: type: string example: 500 space_id_optional: name: space_id in: query description: Filter results by space ID. required: false schema: type: string example: c3ac3e87-fe39-4866-9ea4-01517d6e90cd analytics-service: name: analytics-service in: path description: Analytics service name or ID. required: true schema: type: string index-metric: name: index-metric in: path description: Limit the information returned for indices metric to the specific index metrics. required: true schema: type: string corg: name: corg in: path description: Filter results by consumer organization id (filters on the `developer_org_id` data field) or consumer organization name (filters on the `developer_org_name` data field) . required: true schema: type: string example: my_consumer_org snapshot: name: snapshot in: path description: Comma-separated list of snapshot names to retrieve. required: true schema: type: string inactive-product-report-type: name: inactive-product-report-type in: path description: 'Type of inactive product report to query. Specifies which category of inactive products to retrieve. Possible values: `no_subscriptions` (Products with no active subscriptions), `no_traffic` (Products with no API traffic at all), `no_recent_traffic` (Products with no recent API traffic within the specified time period).' required: true schema: type: string enum: - no_subscriptions - no_traffic - no_recent_traffic example: no_subscriptions immediate_client_ip_optional: name: immediate_client_ip in: query description: Filter results by immediate client IP address. Only supports equality checks and `not` but no other operator prefixes. Supports CIDR notation based queries, e.g. `immediate_client_ip=9.123.234.0/24` required: false schema: type: string example: 9.12.34.56 wait_if_ongoing_optional: name: wait_if_ongoing in: query description: If true, the flush operation blocks until execution when another flush operation is running required: false schema: type: boolean mcp_method_name_optional: name: mcp_method_name in: query description: Filter results by MCP method name. required: false schema: type: string example: notifications/initialized product_offset_optional: name: product_offset in: query description: If set, the offset to be applied when requesting a list. e.g. return events starting from the 100th result required: false schema: type: string example: '100' rule_name_optional: name: rule_name in: query description: Filter results by rule_name. required: false schema: type: string wait_for_no_initializing_shards_optional: name: wait_for_no_initializing_shards in: query description: boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards. required: false schema: type: boolean api_version_optional: name: api_version in: query description: Filter results by API version. required: false schema: type: string example: 1.0.0 bucket_interval_optional: name: bucket_interval in: query description: 'The time interval between data points. For example, if you set `--timeframe` to 1 day, and you want 24 datapoints on the chart, then set `bucket_interval` to 1h. Format is an integer followed by the units: s|m|h|d (seconds, minutes, hours or days). ' required: false schema: type: string example: 1d explain_optional: name: explain in: query description: If true, then the response contains an explanation of why the commands can or cannot be executed. required: false schema: type: boolean node_ids_optional: name: node_ids in: query description: A comma-separated list of the persistent ids of nodes. required: false schema: type: string query_string_optional: name: query_string in: query description: Filter results by query_string. required: false schema: type: string example: name=john&client_id=cd16fbb0001f11c73cf6c00bd0b3b70d app_name_optional: name: app_name in: query description: Filter results by application name. required: false schema: type: string example: custom_app schedule_optional: name: schedule in: query description: 'Time window for the report in format '''' where value is a positive integer and unit is ''h'' (hours) or ''d'' (days). For example: ''1h'' for last 1 hour, ''24h'' for last 24 hours, ''7d'' for last 7 days. Defaults to ''24h'' if not specified. ' required: false schema: type: string pattern: ^\d+(h|d)$ example: 24h wait_for_removal_optional: name: wait_for_removal in: query description: Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. Defaults to true. required: false schema: type: boolean planref: name: planref in: path description: Plan reference (productname:version:plan) required: true schema: type: string example: custom_product:1.0.0:default transaction_id_optional: name: transaction_id in: query description: Filter by transaction ID from the gateway. required: false schema: type: string example: '167472' audit_mcp_server_optional: name: mcp_server in: query description: 'If set, only return audit records about the MCP server with this name, or name:version for one version. Includes changes to its drafts, publishing and lifecycle changes. Use oneof: with a comma separated list for several, and not: or notoneof: to leave them out. ' required: false schema: type: string maxLength: 2000 pattern: ^((equals|not|oneof|notoneof):)?[^:,]+(:[^:,]+)?(,[^:,]+(:[^:,]+)?)*$ example: equals:orders-mcp:1.0.0 target: name: target in: path description: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all. required: true schema: type: string dry_run_optional: name: dry_run in: query description: If true, then the request simulates the operation only and returns the resulting state. required: false schema: type: boolean api_offset_optional: name: api_offset in: query description: If set, the offset to be applied when requesting a list. e.g. return events starting from the 100th result required: false schema: type: string example: '100' sort_optional: name: sort in: query description: Specifies the field name to use to sort the results. By default, the sorting is in ascending order. To sort in descending order, prefix the field name with a - required: false schema: type: string example: api_name jsonrpc_request_id_optional: name: jsonrpc_request_id in: query description: Filter results by JSON-RPC request ID. required: false schema: type: string example: 400e90d0-b5ea-4ab4-81f0-d336958b97c8 deploymentmode: name: deploymentmode in: path description: Specifies the deployment mode to delete the indices for required: true schema: type: string enum: - federatedapimanagement - devportal - analytics - apiagent - apisecurity - all status_code_optional: name: status_code in: query description: If set, only return events that match this response code e.g. 200 OK, 404 Not Found. It is also possible to use wildcard based values 10x, 20x, 30x, 40x, 50x. The values 'error' and 'success' can also be used to filter for all errors or all successful calls. required: false schema: type: string example: 404 Not Found monitor-id: name: monitor-id in: path description: ID of the threat intelligence monitor. required: true schema: type: string health_optional: name: health in: query description: Health status used to limit returned indices. required: false schema: type: string enum: - green - yellow - red backend_request_body_optional: name: backend_request_body in: query description: Filter results by backend request body. required: false schema: type: string example: '{"app_name":"Weather app"}' mcp_operation_name_optional: name: mcp_operation_name in: query description: Filter results by MCP operation name. required: false schema: type: string example: execute_tool wait_for_timeout_optional: name: wait_for_timeout in: query description: Specifies the maximum time to wait for wait_for_metadata_version before timing out. required: false schema: type: string v_columns_optional: name: v_columns in: query description: If true, the response includes column headings. required: false schema: type: boolean requestData_optional: name: requestData in: query description: Filter audit results by requestData required: false schema: type: object example: url: www.url.com style: deepObject explode: true index-name: name: index-name in: path description: 'Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified using the : syntax. ' required: true schema: type: string bottom_right_optional: name: bottom_right in: query description: The latitude and longitude of the bottom right corner of the chart. required: false schema: type: string example: 40.712776,-74.005974 regenerate_optional: name: regenerate in: query description: 'If true, forces the regeneration of an analytics report. Use this when you need fresh data or when the cached report is outdated. When set to true, the API will return a 202 status with a polling message, and you''ll need to poll the endpoint again to get the regenerated report. ' required: false schema: type: boolean example: false time_optional: name: time in: query description: Unit used to display time values. schema: type: string backend_method_optional: name: backend_method in: query description: Filter results by backend HTTP method e.g. GET, PUT, POST, DELETE, HEAD, TRACE, OPTIONS. required: false schema: type: string example: GET resource_id_optional: name: resource_id in: query description: Filter results by resource ID. required: false schema: type: string example: 70848db2-5d5f-4df3-87e1-dd63f61f290c mcp_server_title_optional: name: mcp_server_title in: query description: Filter results by MCP server title. schema: type: string example: Custom MCP Server iwhi_version_required: name: version in: query description: Product version for IWHI metering required: true schema: type: string example: 10.0.8.0 accept_language_optional: name: accept-language in: header description: Natural language and locale that the client prefers. required: false schema: type: string example: en ignore_idle_threads_optional: name: ignore_idle_threads in: query description: If true, known idle threads (e.g. waiting in a socket select, or to get a task from an empty queue) are filtered out. Defaults to true. required: false schema: type: boolean action_optional: name: action in: query description: Filter result by audit action name required: false schema: type: string example: create response_http_headers_optional: name: response_http_headers in: query description: If set, the value for a given key must match in the response_http_headers array. required: false schema: type: object example: Content-Type: application/json Access-Control-Allow-Origin: example.ibm.com style: deepObject explode: true mcp_resource_uri_optional: name: mcp_resource_uri in: query description: Filter results by MCP resource URI. required: false schema: type: string example: file:///home/user/documents/report.pdf h_optional: name: h in: query description: Comma-separated list of column names to display. required: false schema: type: string node-metric: name: node-metric in: path description: Node or metric filter. required: true schema: type: string operation_path_optional: name: operation_path in: query description: Filter results by operation path. required: false schema: type: string include_segment_file_sizes_optional: name: include_segment_file_sizes in: query description: If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). Defaults to false. required: false schema: type: boolean return_format_optional: name: return_format in: query description: Short version of the HTTP accept header. Valid values include JSON, YAML, etc. required: false schema: type: string method_optional: name: method in: query description: Filter results by HTTP method e.g. GET, PUT, POST, DELETE, HEAD, TRACE, OPTIONS. required: false schema: type: string example: GET app: name: app in: path description: Filter results by application name or application id. required: true schema: type: string example: custom_app wait_for_status_optional: name: wait_for_status in: query description: Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will not wait for any status. required: false schema: type: string enum: - green - yellow - red backend_response_body_optional: name: backend_response_body in: query description: Filter results by backend response body. required: false schema: type: string example: '{"message":"success"}' force_optional: name: force in: query description: If true, the request forces a flush even if there are no changes to commit to the index. Defaults to true. required: false schema: type: boolean allow_no_indices_optional: name: allow_no_indices in: query description: If true, the wildcard indices expression that resolves into no concrete indices will be ignored. (This includes _all string or when no indices have been specified). Defaults to true. required: false schema: type: boolean consumer_org_id_optional: name: consumer_org_id in: query description: Filter results by consumer organization ID (filters on the `developer_org_id` data field). required: false schema: type: string example: ddcaf2b9-0460-4783-a743-f773dd3c7e64 include_defaults_optional: name: include_defaults in: query description: If true, returns all default cluster settings. Defaults to false. required: false schema: type: boolean actions_optional: name: actions in: query description: Comma-separated list or wildcard expression of actions used to limit the request. required: false schema: type: string zoom_optional: name: zoom in: query description: Zoom level of the map required: false schema: type: string example: '1' bytes_sent_optional: name: bytes_sent in: query description: Filter results by the number of bytes sent. required: false schema: type: string example: 500 rate_limit_status: name: status in: query description: 'Filter rate limit report by status level. Only returns applications matching the specified status. Status levels are calculated based on usage percentage: overage (100%), critical (90-99%), warning (75-89%), moderate (50-74%), healthy (0-49%). Use ''all'' to return all records without filtering. ' required: true schema: type: string enum: - all - overage - critical - warning - moderate - healthy default: all example: critical event-id: name: event-id in: path description: 'Analytics API event ID. This ID is globally unique across the analytics service. ' required: true schema: $ref: '#/components/schemas/Id' providerOrgId_optional: name: orgId in: query description: Filter results by provider organization ID. required: false schema: type: string example: dc299ac1-223d-4f53-94ce-2f264ea32d81 plan_version_optional: name: plan_version in: query description: Filter results by plan version required: false schema: type: string example: 2.0.0 graphql_request_field_cost_optional: name: graphql_request_field_cost in: query description: Filter results by graphql request field cost value. required: false schema: type: string include_unloaded_segments_optional: name: include_unloaded_segments in: query description: If true, the response includes information from segments that are not loaded into memory. required: false schema: type: boolean mcp_tool_name_optional: name: mcp_tool_name in: query description: Filter results by MCP tool name. required: false schema: type: string example: Flights report_forecast_optional: name: forecast in: query description: 'If set to true, includes forecasted data projections in the report response based on historical trends. The forecast extends beyond the current date to provide predictive analytics for future API usage patterns. This parameter is useful for trend analysis. ' required: false schema: type: boolean apiref: name: apiref in: path description: API reference (name:version) required: true schema: type: string example: custom_api:1.0.0 consumer_org_title_optional: name: consumer_org_title in: query description: Filter results by consumer organization title (filters on the `developer_org_title` data field). required: false schema: type: string example: My Consumer Org callback_request_optional: name: callback_request in: query description: Filter results by callback request. required: false schema: type: string example: 'true' ai_cache_hit_optional: name: ai_cache_hit in: query description: Filter results by AI LLM cache hit. required: false schema: type: string example: 'true' graphql_error_count_optional: name: graphql_error_count in: query description: Filter results by graphql error count value. required: false schema: type: string report_timeframe_optional: name: timeframe in: query description: 'If set, only return events within the indicated timeframe. Timeframe values are in the format of ''last'' where is a positive integer greater than one, and can be one of day, month, quarter or year. ' required: false schema: type: string example: last2year summary_event_id_optional: name: summary_event_id in: query description: If set, only return this specific summary event ID. required: false schema: type: string example: x4xBahH6GwQTCgFcvgml0g response_body_optional: name: response_body in: query description: Filter results by response body. required: false schema: type: string example: '{"message":"success"}' provider_org_name_optional: name: provider_org_name in: query description: Filter results by provider organization name. required: false schema: type: string example: custom_prov_org catalog: name: catalog in: path description: Catalog name or ID. required: true schema: type: string event_fields_optional: name: fields in: query description: 'A list of the event fields that you want included in each event. You can use a comma as a separator when specifying the fields. Use this parameter if you require only a subset of the event fields rather than the full set. ' required: false schema: type: string example: api_version,api_name,api_id report_ai_insights_optional: name: ai_insights in: query description: 'If set to true, enables AI-powered insights and analysis in the report response. This parameter requires the API agent feature to be enabled in the service configuration. When enabled, the report may include additional AI-generated recommendations and patterns. ' required: false schema: type: boolean protocol_version_optional: name: protocol_version in: query description: Filter results by protocol version. required: false schema: type: string example: 1.2.3 app_offset_optional: name: app_offset in: query description: If set, the offset to be applied when requesting a list. e.g. return events starting from the 100th result required: false schema: type: string example: '100' path_id_optional: name: path_id in: query description: Filter results by path_id required: false schema: type: string example: default:1.0.0:GET:/apath pri_optional: name: pri in: query description: If true, the response only includes information from primary shards. required: false schema: type: boolean audit_product_optional: name: product in: query description: 'If set, only return audit records about the product with this name, or name:version for one version. Includes changes to its drafts, publishing and lifecycle changes. Use oneof: with a comma separated list for several, and not: or notoneof: to leave them out. ' required: false schema: type: string maxLength: 2000 pattern: ^((equals|not|oneof|notoneof):)?[^:,]+(:[^:,]+)?(,[^:,]+(:[^:,]+)?)*$ example: oneof:orders,payments:2.0.0 graphql_response_type_cost_optional: name: graphql_response_type_cost in: query description: Filter results by graphql response type cost value. required: false schema: type: string iwhi_product_required: name: product in: query description: Product identifier for IWHI metering required: true schema: type: string example: IBM API Connect path_optional: name: path in: query description: If set, only return events that contain this path value. required: false schema: type: string example: /path/to/something target_optional: name: target in: query description: Filter result by audit target required: false schema: type: object example: typeURI: draft_api style: deepObject explode: true fields: name: fields in: path description: Comma-separated list of field names. required: true schema: type: string catalog_name_optional: name: catalog_name in: query description: Filter results by catalog name. required: false schema: type: string example: prod event_id_optional: name: event_id in: query description: If set, only return this specific event ID. required: false schema: type: string example: pLjDDYYBeE56v55xyHfQ id: name: id in: path description: Unique identifier. required: true schema: type: string attachments_optional: name: attachments in: query description: Filter result by audit attachments required: false schema: type: object example: user: url: www.url.com style: deepObject explode: true full_id_optional: name: full_id in: query description: If true, return the full node ID. If false, return the shortened node ID. required: false schema: type: boolean disable_monitors_optional: name: disable_monitors in: query description: Whether to disable active threat intelligence monitors during emergency drain. Defaults to true. required: false schema: type: boolean event_type_optional: name: event_type in: query description: Filter results by event type. required: false schema: type: string api_limit_optional: name: api_limit in: query description: 'Limits the number of APIs returned in the response. Use this parameter to control pagination and reduce response payload size. Valid range: 1-500. If not specified, a default limit will be applied by the server.' required: false schema: type: string example: '50' timeframe_optional: name: timeframe in: query description: 'If set, only return events within the indicated timeframe. This parameter will be ignored if either start or end have been specified. ' required: false schema: type: string enum: - last1minute - last5minutes - last15minutes - last30minutes - last1hour - last4hours - last12hours - last24hours - last7days - last30days - all voting_timeout_optional: name: timeout in: query description: Time to wait for the specified nodes to be excluded from the voting configuration before returning. Defaults to 30s. required: false schema: type: string catalog-name: name: catalog-name in: path description: Filter results by catalog name required: true schema: type: string example: api-connect-catalog-1 repository: name: repository in: path description: Comma-separated list of snapshot repository names. required: true schema: type: string typeURI_optional: name: typeURI in: query description: Filter result by audit typeURI required: false schema: type: string ai_insights_optional: name: ai_insights in: query description: 'If set to true, enables AI-powered insights and analysis in the dashboard and discover response. This parameter requires the API agent feature to be enabled in the service configuration. When enabled, the report may include additional AI-generated recommendations and patterns. ' required: false schema: type: boolean ignore_unavailable_optional: name: ignore_unavailable in: query description: 'For operations about indices, if true, unavailable indices (missing or closed) will be ignored. For operations about snapshots, if true, unavailable snapshots (corrupted or otherwise temporarily can''t be returned) will be ignored. Defaults to false. ' required: false schema: type: boolean logSourceCRN_optional: name: logSourceCRN in: query description: Filter result by log source CRN required: false schema: type: string observer_optional: name: observer in: query description: Filter result by audit observer required: false schema: type: object example: id: target style: deepObject explode: true gateway-service-name: name: gateway-service-name in: path description: Filter results by gateway service name required: true schema: type: string example: v5gw user_agent_optional: name: user_agent in: query description: 'If set, this parameter allows filtering API events based on the client user agent. The key specifies the field to evaluate within the user agent object (e.g., `device`, `major`, `minor`, `name`, `os`, `os_full`, `os_major`, `os_minor`, `os_name`, `os_version`, `patch`, `version`). For example, `user_agent[device]=iPhone` ' required: false schema: type: object example: device: iPhone style: deepObject explode: true consumer-org-name: name: consumer-org-name in: path description: Filter results by consumer organization name (filters on the `developer_org_name` data field). required: true schema: type: string example: my_consumer_org space_name_optional: name: space_name in: query description: Filter results by space name. required: false schema: type: string example: space1 scope_optional: name: scope in: query description: Filter results by scope. required: false schema: type: string example: sub/20240604-7e1f-4b52-a64e-b6ed74d4ef01 mcp_tool_call_result_optional: name: mcp_tool_call_result in: query description: Filter results by MCP tool call result. required: false schema: type: string example: '{"temperature_range": {"high": 75, "low": 60}, "conditions": "sunny"}' audit_area_optional: name: area in: query description: 'If set, only return audit records about these areas, comma separated. lifecycle: publishing and product lifecycle; development: projects, draft APIs and draft products; consumers: consumer organizations, applications, subscriptions, approvals and credentials; access: sign-ins, users, members and roles; system: webhooks from gateways and portals; configuration: everything else. ' required: false schema: type: string maxLength: 200 pattern: ^(lifecycle|development|consumers|access|configuration|system)(,(lifecycle|development|consumers|access|configuration|system))*$ example: lifecycle,consumers audit_actor_optional: name: actor in: query description: 'If set, only return audit records made by these kinds of actor, comma separated. people: users; clients: client applications, e.g. CI pipelines, using client credentials; system: API Connect itself. ' required: false schema: type: string maxLength: 50 pattern: ^(people|clients|system)(,(people|clients|system))*$ example: people request_http_headers_optional: name: request_http_headers in: query description: If set, the value for a given key must match in the request_http_headers array. required: false schema: type: object example: Accept: application/json Host: example.ibm.com style: deepObject explode: true graphql_operation_name_optional: name: graphql_operation_name in: query description: Filter results by graphql operation name value. required: false schema: type: string audit-dashboard: name: audit-dashboard in: path description: 'The audit dashboard to return. overview: activity across the provider organization; lifecycle: publishing and product lifecycle; consumers: consumer organizations, applications and subscriptions; access: sign-ins, members and roles; configuration: configuration changes. ' required: true schema: type: string enum: - overview - lifecycle - consumers - access - configuration example: overview time_to_serve_request_optional: name: time_to_serve_request in: query description: The time in milliseconds to serve the request. required: false schema: type: string example: '143' custom_data_optional: name: custom_data in: query description: Filter results by a custom data attribute. required: false schema: type: object example: CustomArg: customValue style: deepObject explode: true app_limit_optional: name: app_limit in: query description: 'Limits the number of applications returned in the response. Use this parameter to control pagination and reduce response payload size. Valid range: 1-500. If not specified, a default limit will be applied by the server.' required: false schema: type: string example: '50' iwhi_alias_optional: name: alias in: query description: Optional tenant alias for IWHI metering required: false schema: type: string example: prod-tenant audit-id: name: audit-id in: path description: Filter results by audit ID. required: true schema: type: string example: 6c597223-b2b7-49dc-b956-14596b6cc8f1 error_message_optional: name: error_message in: query description: Filter results by error message. required: false schema: type: string product_title_optional: name: product_title in: query description: Filter results by product title. schema: type: string example: Custom Product api_type_optional: name: api_type in: query description: Filter results by API type. required: false schema: type: string example: rest daily_offset_optional: name: daily_offset in: query description: 'If set, the offset to be applied when requesting daily consumption data. ' required: false schema: type: string rpc_status_code_optional: name: rpc_status_code in: query description: Filter results by RPC status code. required: false schema: type: string example: DEADLINE_EXCEEDED spaceId_optional: name: spaceId in: query description: Filter result by space Id required: false schema: type: string example: c3ac3e87-fe39-4866-9ea4-01517d6e90cd node-id-or-metric: name: node-id-or-metric in: path description: Node ID or metric required: true schema: type: string index: name: index in: path description: Comma-separated list or wildcard expression of index names used to limit the request. required: true schema: type: string product_name_optional: name: product_name in: query description: Filter results by product name. required: false schema: type: string example: custom_product wait_for_completion_optional: name: wait_for_completion in: query description: Should the request block until the task is complete. Defaults to false. required: false schema: type: boolean app_lifecycle_state_optional: name: app_lifecycle_state in: query description: Filter results by application lifecycle state. required: false schema: type: string example: production include_yes_decisions_optional: name: include_yes_decisions in: query description: If true, returns YES decisions in explanation. Defaults to false. required: false schema: type: boolean app_id_optional: name: app_id in: query description: Filter results by application ID. required: false schema: type: string example: 4d98ed08-0f11-42ad-a0e5-93093a5bc2d0 product_limit_optional: name: product_limit in: query description: 'Limits the number of products returned in the response. Use this parameter to control pagination and reduce response payload size. Valid range: 1-500. If not specified, a default limit will be applied by the server.' required: false schema: type: string example: '50' alias: name: alias in: path description: Analytics service name or ID. required: true schema: type: string alert_action_optional: name: alert_action in: query description: Filter results by alert action. required: false schema: type: string product_version_optional: name: product_version in: query description: Filter results by product version. required: false schema: type: string example: 2.0.0 product_id_optional: name: product_id in: query description: Filter results by product ID. required: false schema: type: string example: d3fcc626-bf11-4318-8045-8d8502608c88 offset_optional: name: offset in: query description: If set, the offset to be applied when requesting a list. e.g. return events starting from the 100th result required: false schema: type: string example: '100' endpoint_url_optional: name: endpoint_url in: query description: Filter results by endpoint_url, note this field is only set on failed API events. required: false schema: type: string client_geoip_optional: name: client_geoip in: query description: 'If set, this parameter allows filtering API events based on the client geographical location. The key specifies the field to evaluate within the client GeoIP object (e.g., `city_name`, `continent_code`, `country_code2`, `country_code3`, `country_name`, `latitude`, `longitude`, `postal_code`, `region_code`, `region_name`, `timezone`). For example, `client_geoip[country_name]=Germany` ' required: false schema: type: object example: country_name: Germany style: deepObject explode: true force_delete_optional: name: force in: query description: If true, this request forces a delete even if it is the current write alias target and will prevent the ingestion of new analytics data. Defaults to false. required: false schema: type: boolean iwhi_tenantId_required: name: tenantId in: query description: Tenant ID for IWHI metering required: true schema: type: string example: tenant-12345 iwhi_tenant_required: name: tenant in: query description: Tenant name for IWHI metering required: true schema: type: string example: customer-tenant detailed_optional: name: detailed in: query description: If true, the response includes detailed information about shard recoveries. required: false schema: type: boolean expand_wildcards_optional: name: expand_wildcards in: query description: 'Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. ' required: false schema: type: string enum: - all - open - closed - hidden - none alert_source_optional: name: alert_source in: query description: Filter results by alert source required: false schema: type: string example: analytics retry_failed_optional: name: retry_failed in: query description: If true, then it retries allocation of shards that are blocked due to too many subsequent allocation failures. required: false schema: type: boolean outcome_optional: name: outcome in: query description: Filter result by audit outcome required: false schema: type: string example: success type_optional: name: type in: query description: The type to sample. Defaults to cpu. required: false schema: type: string enum: - block - cpu - wait fielddata_fields_optional: name: fielddata_fields in: query description: Comma-separated list or wildcard expressions of fields to include in fielddata statistics. required: false schema: type: string timezone_optional: name: timezone in: query description: Convert date-time fields to the specified timezone using values from the Olson database (e.g. Europe/Paris or America/Los Angeles). Default if omitted is UTC. required: false schema: type: string example: Europe/Paris backend_url_optional: name: backend_url in: query description: Filter results by backend_url. required: false schema: type: string org: name: org in: path description: Provider organization name or ID. required: true schema: type: string pretty_optional: name: pretty in: query description: Prettify response required: false schema: type: - boolean - 'null' consumer_org_name_optional: name: consumer_org_name in: query description: Filter results by consumer organization name (filters on the `developer_org_name` data field). required: false schema: type: string example: my_consumer_org productref: name: productref in: path description: Product reference (name:version) required: true schema: type: string example: custom_product:1.0.0 wait_for_no_relocating_shards_optional: name: wait_for_no_relocating_shards in: query description: A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards. required: false schema: type: boolean index_optional: name: index in: query description: Comma-separated list or wildcard expression of index names used to limit the request. required: false schema: type: string master_timeout_optional: name: master_timeout in: query description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. required: false schema: type: string corg_offset_optional: name: corg_offset in: query description: If set, the offset to be applied when requesting a list. e.g. return events starting from the 100th result required: false schema: type: string example: '100' plan_name_optional: name: plan_name in: query description: Filter results by plan name required: false schema: type: string example: default_plan api_id_optional: name: api_id in: query description: Filter results by API ID. required: false schema: type: string example: dd371dba-035c-476b-acf5-6c81376b2311 http_user_agent_optional: name: http_user_agent in: query description: Filter results by HTTP user agent. required: false schema: type: string example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.102 Safari/537.36 query-id: name: query-id in: path description: Query ID required: true schema: type: string audit-entity-name: name: audit-entity-name in: path description: 'The name of the product, API or MCP server. Its history includes changes to its drafts, publishing and lifecycle changes of every version. ' required: true schema: type: string maxLength: 256 pattern: ^[^:/]+$ example: orders report-type: name: report-type in: path description: Type of entity for disk usage report required: true schema: type: string enum: - apis - products - applications - consumerorgs - mcpservers example: apis ai_model_optional: name: ai_model in: query description: Filter results by AI LLM model name. required: false schema: type: string example: bigcode/starcoder event_count_optional: name: event_count in: query description: Filter results by event count required: false schema: type: integer example: 30 api_resource_id_optional: name: api_resource_id in: query description: Filter results by API resource ID. required: false schema: type: string example: 70848db2-5d5f-4df3-87e1-dd63f61f290c filter_name_optional: name: filter_name in: query description: Filter results by filter name. required: false schema: type: string report_start_date_optional: name: start in: query description: 'If set, only return events with a date equal to or newer than this. The date-time value must be such that the time component represents midnight. for example, 2021-07-21T00:00:000Z. ' required: false schema: type: string format: date-time wait_for_metadata_version_optional: name: wait_for_metadata_version in: query description: Waits for the metadata version to be equal or greater than the specified metadata version. required: false schema: type: integer backend_request_headers_optional: name: backend_request_headers in: query description: If set, the value for a given key must match in the backend_request_headers array. required: false schema: type: object example: Accept: application/json Host: example.ibm.com style: deepObject explode: true backend_response_headers_optional: name: backend_response_headers in: query description: If set, the value for a given key must match in the backend_response_headers array. required: false schema: type: object example: Content-Type: application/json Access-Control-Allow-Origin: example.ibm.com style: deepObject explode: true responses: UmsReportResponse: description: UMS metering data for license compliance tracking content: application/json: schema: $ref: '#/components/schemas/UmsReportResponse' application/yaml: schema: $ref: '#/components/schemas/UmsReportResponse' ApiUsageReportResponse: description: Data needed to populate the API usage report content: application/json: schema: $ref: '#/components/schemas/ApiUsageReportResponse' application/yaml: schema: $ref: '#/components/schemas/ApiUsageReportResponse' SummaryDashboardResponse: description: Data needed to populate the SUMMARY Dashboard content: application/json: schema: $ref: '#/components/schemas/SummaryDashboardResponse' application/yaml: schema: $ref: '#/components/schemas/SummaryDashboardResponse' McpDashboardResponse: description: Data needed to populate the MCP Dashboard content: application/json: schema: $ref: '#/components/schemas/McpDashboardResponse' application/yaml: schema: $ref: '#/components/schemas/McpDashboardResponse' ClusterMgmtIngestionResponse: description: Response from Logstash cluster management API. content: application/json: schema: $ref: '#/components/schemas/ClusterMgmtIngestionResponse' application/yaml: schema: $ref: '#/components/schemas/ClusterMgmtIngestionResponse' ConfigSyncLeaderboardDetailReportResponse: description: Data needed to populate the detailed view of the leaderboard for the config sync report content: application/json: schema: $ref: '#/components/schemas/ConfigSyncLeaderboardDetailReportResponse' application/yaml: schema: $ref: '#/components/schemas/ConfigSyncLeaderboardDetailReportResponse' StatusCodeMismatchResponse: description: Paginated list of status code mismatch events content: application/json: schema: $ref: '#/components/schemas/StatusCodeMismatchResponse' application/yaml: schema: $ref: '#/components/schemas/StatusCodeMismatchResponse' AuditDashboardResponse: description: Data needed to populate an audit dashboard content: application/json: schema: $ref: '#/components/schemas/AuditDashboard' application/yaml: schema: $ref: '#/components/schemas/AuditDashboard' AuditTimelineResponse: description: Data needed to populate the Audit Events Timeline graph content: application/json: schema: $ref: '#/components/schemas/AuditTimelineResponse' application/yaml: schema: $ref: '#/components/schemas/AuditTimelineResponse' InactivePollingResponse: description: Report is being generated. content: application/json: schema: $ref: '#/components/schemas/InactivePollingResponse' application/yaml: schema: $ref: '#/components/schemas/InactivePollingResponse' InactiveCorgFunnelResponse: description: Data needed to populate the Inactive consumer organizations funnel report content: application/json: schema: $ref: '#/components/schemas/InactiveCorgFunnelResponse' application/yaml: schema: $ref: '#/components/schemas/InactiveCorgFunnelResponse' ConsumerOrgListResponse: description: Data needed to get the list of consumer organizations and their counts. content: application/json: schema: $ref: '#/components/schemas/ConsumerOrgListResponse' application/yaml: schema: $ref: '#/components/schemas/ConsumerOrgListResponse' FilterParamListResponse: description: Filter parameters supported at requested scope. content: application/json: schema: $ref: '#/components/schemas/FilterParamListResponse' application/yaml: schema: $ref: '#/components/schemas/FilterParamListResponse' WmapigwMigrationStatusResponse: description: Response from the WMAPIGW migration status API. content: application/json: schema: $ref: '#/components/schemas/WmapigwMigrationStatusResponse' application/yaml: schema: $ref: '#/components/schemas/WmapigwMigrationStatusResponse' ProductDashboardResponse: description: Data needed to populate the Product Dashboard content: application/json: schema: $ref: '#/components/schemas/ProductDashboardResponse' application/yaml: schema: $ref: '#/components/schemas/ProductDashboardResponse' LatencyDashboardResponse: description: Data needed to populate the Latency Dashboard content: application/json: schema: $ref: '#/components/schemas/LatencyDashboardResponse' application/yaml: schema: $ref: '#/components/schemas/LatencyDashboardResponse' ConsumptionResponse: description: Data needed to populate the Consumption metrics content: application/json: schema: $ref: '#/components/schemas/ConsumptionResponse' application/yaml: schema: $ref: '#/components/schemas/ConsumptionResponse' PlanListResponse: description: Data needed to get the list of plans and their counts. content: application/json: schema: $ref: '#/components/schemas/PlanListResponse' application/yaml: schema: $ref: '#/components/schemas/PlanListResponse' SettingsBodyResponse: description: Settings body content: application/json: schema: $ref: '#/components/schemas/SettingsBody' application/yaml: schema: $ref: '#/components/schemas/SettingsBody' DataDashboardResponse: description: Data needed to populate the Data Dashboard content: application/json: schema: $ref: '#/components/schemas/DataDashboardResponse' application/yaml: schema: $ref: '#/components/schemas/DataDashboardResponse' WmapigwMigrationResponse: description: Response from the WMAPIGW migration API. content: application/json: schema: $ref: '#/components/schemas/WmapigwMigrationResponse' application/yaml: schema: $ref: '#/components/schemas/WmapigwMigrationResponse' ConsumerTrendLeaderboardDetailReportResponse: description: Data needed to populate the detailed view of the leaderboard for the consumer trend report content: application/json: schema: $ref: '#/components/schemas/ConsumerTrendLeaderboardDetailReportResponse' application/yaml: schema: $ref: '#/components/schemas/ConsumerTrendLeaderboardDetailReportResponse' ApplicationListResponse: description: Data needed to get the list of applications and their counts. content: application/json: schema: $ref: '#/components/schemas/ApplicationListResponse' application/yaml: schema: $ref: '#/components/schemas/ApplicationListResponse' AuditListResponse: description: Response for the audit list endpoint. content: application/json: schema: $ref: '#/components/schemas/AuditListResponse' application/yaml: schema: $ref: '#/components/schemas/AuditListResponse' ScrollResponse: description: Response from the /events/scroll API. content: application/json: schema: $ref: '#/components/schemas/ScrollResponse' application/yaml: schema: $ref: '#/components/schemas/ScrollResponse' ApiDashboardResponse: description: Data needed to populate the API Dashboard content: application/json: schema: $ref: '#/components/schemas/ApiDashboardResponse' application/yaml: schema: $ref: '#/components/schemas/ApiDashboardResponse' DiskUsageReportResponse: description: Data needed to populate the Disk Usage report content: application/json: schema: $ref: '#/components/schemas/DiskUsageReportResponse' application/yaml: schema: $ref: '#/components/schemas/DiskUsageReportResponse' EventCountResponse: description: Number of events at requested scope. content: application/json: schema: $ref: '#/components/schemas/EventCountResponse' application/yaml: schema: $ref: '#/components/schemas/EventCountResponse' RuntimeMetricsGetResponse: description: Runtime metrics at requested scope. content: application/json: schema: $ref: '#/components/schemas/RuntimeMetricsGetResponse' application/yaml: schema: $ref: '#/components/schemas/RuntimeMetricsGetResponse' AuditFilterParamListResponse: description: Response for listing audit filter parameters. content: application/json: schema: $ref: '#/components/schemas/AuditFilterParamListResponse' application/yaml: schema: $ref: '#/components/schemas/AuditFilterParamListResponse' ApiUsageLeaderboardReportResponse: description: Data needed to populate the leaderboard for the API usage report content: application/json: schema: $ref: '#/components/schemas/LeaderboardReportResponse' application/yaml: schema: $ref: '#/components/schemas/LeaderboardReportResponse' AiplatformLeaderboardReportResponse: description: Data needed to populate the leaderboard for the AI Platform report content: application/json: schema: $ref: '#/components/schemas/LeaderboardReportResponse' application/yaml: schema: $ref: '#/components/schemas/LeaderboardReportResponse' ApiUsageLeaderboardDetailReportResponse: description: Data needed to populate the detailed view of the leaderboard for the API usage report content: application/json: schema: $ref: '#/components/schemas/ProviderLeaderboardDetailReportResponse' application/yaml: schema: $ref: '#/components/schemas/ProviderLeaderboardDetailReportResponse' DeprecatedProductResponse: description: Data needed to populate the Deprecateds product report content: application/json: schema: $ref: '#/components/schemas/DeprecatedProductResponse' application/yaml: schema: $ref: '#/components/schemas/DeprecatedProductResponse' SummaryListResponse: description: Summary events found at requested scope. content: application/json: schema: $ref: '#/components/schemas/SummaryListResponse' application/yaml: schema: $ref: '#/components/schemas/SummaryListResponse' InactiveCorgTableResponse: description: Data needed to populate the Inactive consumer organizations table report content: application/json: schema: $ref: '#/components/schemas/InactiveCorgTableResponse' application/yaml: schema: $ref: '#/components/schemas/InactiveCorgTableResponse' ProductListResponse: description: Data needed to get the list of products and their counts. content: application/json: schema: $ref: '#/components/schemas/ProductListResponse' application/yaml: schema: $ref: '#/components/schemas/ProductListResponse' PolicyErrorsResponse: description: Paginated list of policy error events content: application/json: schema: $ref: '#/components/schemas/PolicyErrorsResponse' application/yaml: schema: $ref: '#/components/schemas/PolicyErrorsResponse' ConsumerTrendLeaderboardReportResponse: description: Data needed to populate the leaderboard for the consumer trend report content: application/json: schema: $ref: '#/components/schemas/ConsumerTrendLeaderboardReportResponse' application/yaml: schema: $ref: '#/components/schemas/ConsumerTrendLeaderboardReportResponse' AuditEntityHistoryResponse: description: The audit history of a product, API or MCP server content: application/json: schema: $ref: '#/components/schemas/AuditEntityHistory' application/yaml: schema: $ref: '#/components/schemas/AuditEntityHistory' PurgeIndicesResponse: description: Purging Indices Response content: application/json: schema: $ref: '#/components/schemas/PurgeIndicesResponse' application/yaml: schema: $ref: '#/components/schemas/PurgeIndicesResponse' EventListResponse: description: Events found at requested scope. content: application/json: schema: $ref: '#/components/schemas/EventListResponse' application/yaml: schema: $ref: '#/components/schemas/EventListResponse' UsageEvolutionReportResponse: description: Data needed to populate the Usage Evolution report content: application/json: schema: $ref: '#/components/schemas/UsageEvolutionReportResponse' application/yaml: schema: $ref: '#/components/schemas/UsageEvolutionReportResponse' WmapigwStopMigrationResponse: description: Response from the WMAPIGW migration stop API. content: application/json: schema: $ref: '#/components/schemas/WmapigwMigrationStopResponse' application/yaml: schema: $ref: '#/components/schemas/WmapigwMigrationStopResponse' IwhiMeteringReportResponse: description: IWHI metering data for license compliance tracking content: application/json: schema: $ref: '#/components/schemas/IwhiMeteringReportResponse' application/yaml: schema: $ref: '#/components/schemas/IwhiMeteringReportResponse' QueryListResponse: description: Queries found at requested scope. content: application/json: schema: $ref: '#/components/schemas/QueryListResponse' application/yaml: schema: $ref: '#/components/schemas/QueryListResponse' Error: description: Unexpected error. content: application/json: schema: $ref: '#/components/schemas/Error' application/yaml: schema: $ref: '#/components/schemas/Error' NoContentResponse: description: The request was successfully processed. ApiListResponse: description: Data needed to get the list of APIs and their counts. content: application/json: schema: $ref: '#/components/schemas/ApiListResponse' application/yaml: schema: $ref: '#/components/schemas/ApiListResponse' DeprecatedPollingResponse: description: Report is being generated. content: application/json: schema: $ref: '#/components/schemas/DeprecatedPollingResponse' application/yaml: schema: $ref: '#/components/schemas/DeprecatedPollingResponse' SummaryResponse: description: Summary event matching supplied ID if exists at specified scope. content: application/json: schema: $ref: '#/components/schemas/SummaryResponse' application/yaml: schema: $ref: '#/components/schemas/SummaryResponse' GatewayServiceLeaderboardDetailReportResponse: description: Data needed to populate the detailed view of the leaderboard for the gateway services report content: application/json: schema: $ref: '#/components/schemas/GatewayServiceLeaderboardDetailReportResponse' application/yaml: schema: $ref: '#/components/schemas/GatewayServiceLeaderboardDetailReportResponse' ClientDashboardResponse: description: Data needed to populate the Client Dashboard content: application/json: schema: $ref: '#/components/schemas/ClientDashboardResponse' application/yaml: schema: $ref: '#/components/schemas/ClientDashboardResponse' ServiceStatusResponse: description: Analytics service status information content: application/json: schema: $ref: '#/components/schemas/ServiceStatusResponse' application/yaml: schema: $ref: '#/components/schemas/ServiceStatusResponse' SummaryCountResponse: description: Number of summary API event calls at requested scope. content: application/json: schema: $ref: '#/components/schemas/SummaryCountResponse' application/yaml: schema: $ref: '#/components/schemas/SummaryCountResponse' IlmtReportResponse: description: ILMT metering data for license compliance tracking content: application/json: schema: $ref: '#/components/schemas/IlmtReportResponse' application/yaml: schema: $ref: '#/components/schemas/IlmtReportResponse' LeaderboardResponse: description: Data needed to populate all leaderboards content: application/json: schema: $ref: '#/components/schemas/LeaderboardsReportResponse' application/yaml: schema: $ref: '#/components/schemas/LeaderboardsReportResponse' SeedTrialDataResponse: description: Response from the seed trial data API. content: application/json: schema: $ref: '#/components/schemas/SeedTrialDataResponse' application/yaml: schema: $ref: '#/components/schemas/SeedTrialDataResponse' EventContextResponse: description: 'Investigation context for the API event matching the supplied ID, if it exists at the specified scope. ' content: application/json: schema: $ref: '#/components/schemas/EventContextResponse' application/yaml: schema: $ref: '#/components/schemas/EventContextResponse' BackendDashboardResponse: description: Data needed to populate the Backend Dashboard content: application/json: schema: $ref: '#/components/schemas/BackendDashboardResponse' application/yaml: schema: $ref: '#/components/schemas/BackendDashboardResponse' ApplicationDashboardResponse: description: Data needed to populate the Application Dashboard content: application/json: schema: $ref: '#/components/schemas/ApplicationDashboardResponse' application/yaml: schema: $ref: '#/components/schemas/ApplicationDashboardResponse' AiplatformReportResponse: description: Data needed to populate the AI Platform report content: application/json: schema: $ref: '#/components/schemas/AiplatformReportResponse' application/yaml: schema: $ref: '#/components/schemas/AiplatformReportResponse' DiscoverTimelineResponse: description: Data needed to populate the Gateway Dashboard content: application/json: schema: $ref: '#/components/schemas/DiscoverTimelineResponse' application/yaml: schema: $ref: '#/components/schemas/DiscoverTimelineResponse' ConsumerDashboardResponse: description: Data needed to populate the Consumer Dashboard content: application/json: schema: $ref: '#/components/schemas/ConsumerDashboardResponse' application/yaml: schema: $ref: '#/components/schemas/ConsumerDashboardResponse' ProviderConsumerAnalyticsResponse: description: Data needed to populate the Provider level Consumer Analytics Dashboard content: application/json: schema: $ref: '#/components/schemas/ProviderConsumerAnalyticsResponse' application/yaml: schema: $ref: '#/components/schemas/ProviderConsumerAnalyticsResponse' GatewayDashboardResponse: description: Data needed to populate the Gateway Dashboard content: application/json: schema: $ref: '#/components/schemas/GatewayDashboardResponse' application/yaml: schema: $ref: '#/components/schemas/GatewayDashboardResponse' ScrollDeleteResponse: description: Response from the /events/scroll/delete API. content: application/json: schema: $ref: '#/components/schemas/ScrollDeleteResponse' application/yaml: schema: $ref: '#/components/schemas/ScrollDeleteResponse' StatusDashboardResponse: description: Data needed to populate the Status Dashboard content: application/json: schema: $ref: '#/components/schemas/StatusDashboardResponse' application/yaml: schema: $ref: '#/components/schemas/StatusDashboardResponse' QueryResponse: description: Singular query. content: application/json: schema: $ref: '#/components/schemas/Query' application/yaml: schema: $ref: '#/components/schemas/Query' InactiveProductResponse: description: Data needed to populate the Inactive product report content: application/json: schema: $ref: '#/components/schemas/InactiveProductResponse' application/yaml: schema: $ref: '#/components/schemas/InactiveProductResponse' ClusterMgmtObjectResponse: description: Response from cluster management API. content: application/json: schema: $ref: '#/components/schemas/ClusterMgmtObjectResponse' application/yaml: schema: $ref: '#/components/schemas/ClusterMgmtObjectResponse' RateLimitStatusResponse: description: Paginated list of applications approaching their rate limits content: application/json: schema: $ref: '#/components/schemas/RateLimitStatusResponse' application/yaml: schema: $ref: '#/components/schemas/RateLimitStatusResponse' EventResponse: description: Event matching supplied ID if exists at specified scope. content: application/json: schema: $ref: '#/components/schemas/EventResponse' application/yaml: schema: $ref: '#/components/schemas/EventResponse' WorldmapDashboardResponse: description: Data needed to populate the Worldmap Dashboard content: application/json: schema: $ref: '#/components/schemas/WorldmapDashboardResponse' application/yaml: schema: $ref: '#/components/schemas/WorldmapDashboardResponse' AuditResponse: description: Response for retrieving a single audit record. content: application/json: schema: $ref: '#/components/schemas/AuditResponse' application/yaml: schema: $ref: '#/components/schemas/AuditResponse' ConsumerTrendReportResponse: description: Data needed to populate the consumer trend report content: application/json: schema: $ref: '#/components/schemas/ConsumerTrendReportResponse' application/yaml: schema: $ref: '#/components/schemas/ConsumerTrendReportResponse' ConfigSyncResponse: description: Response from config-sync content: application/json: schema: $ref: '#/components/schemas/ConfigSyncResponse' application/yaml: schema: $ref: '#/components/schemas/ConfigSyncResponse' AiDashboardResponse: description: Data needed to populate the AI LLM Dashboard content: application/json: schema: $ref: '#/components/schemas/AiDashboardResponse' application/yaml: schema: $ref: '#/components/schemas/AiDashboardResponse' securitySchemes: oauth: type: oauth2 description: API Manager API Token at either Cloud Admin or Provider scope as appropriate for each operation as defined by the x-auth-token attribute. flows: implicit: authorizationUrl: https://apimserver.example.com/api/oauth2/authorize scopes: api-analytics:view: Create an Analytics object password: tokenUrl: https://apimserver.example.com/api/token refreshUrl: https://apimserver.example.com/api/token scopes: api-analytics:view: Create an Analytics object clientCredentials: tokenUrl: https://apimserver.example.com/api/token scopes: api-analytics:view: Create an Analytics object authorizationCode: authorizationUrl: https://apimserver.example.com/api/oauth2/authorize tokenUrl: https://apimserver.example.com/api/token refreshUrl: https://apimserver.example.com/api/token scopes: api-analytics:view: Create an Analytics object x-ibm-configuration: testable: false