Bot defense
Traffic classification, actions, attacked endpoints, automation, known bots, and peer comparisons. Required resource or feature: Bot Defense protected application and reporting entitlement.
Metric families and dimensions
Section titled “Metric families and dimensions”Transaction trends by traffic type, action, application, endpoint, attack intent, geography, user agent, and autonomous system number (ASN). Versioned routes can change classification and filter support. |
Use Query concepts for shared request guidance and table conventions.
Statistics and analytics queries
Section titled “Statistics and analytics queries”| Method and exact path | Information returned | Scope and principal filters | Specification reference |
|---|---|---|---|
POST /api/shape/bot/namespaces/{namespace}/reporting/endpoint/categories | Endpoint Categories; returns endpoint_categories, endpoint_count, event_count | Selected namespace; category, end_time, filters, start_time, use_raw_data, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/endpoint/categories/{category} | Endpoint Categories Label; returns endpoint_categories, endpoint_count, event_count | Selected namespace; category, end_time, filters, start_time, use_raw_data, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/endpoint/list | All Protected Endpoints; returns endpoints | Selected namespace; end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/endpoint/summary | Endpoint Summary; returns total_applications, total_distinct_endpoints | Selected namespace; category, end_time, filters, start_time, use_raw_data, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/endpoints | Protected endpoint traffic report data | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/insight/credential-stuffing-attack | Insight Event: Credential Stuffing Attack; returns bad_bot_login, bad_bot_login_percentage, create_date, mitigated_percentage, time_series | Selected namespace; date, region | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/insight/event/bad-bot-reduction | Insight Bad Bot Reduction; returns create_date, reduction, time_series_data | Selected namespace; date, region | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/insight/event/unaddressed-automations | Insight Unaddressed Automations; returns bad_bots, create_date, flagged_endpoints, unaddressed | Selected namespace; date, region | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/insight/personal-stats | Insight Personal Stats; returns bots, human | Selected namespace; date, region | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/insight/total-automation | Insight Event: Total Automation; returns automated, automated_percentage, create_date, endpoint, endpoint_label | Selected namespace; date, region | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/malicious/endpoints | Malicious Report Endpoints; returns endpoint_data | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/malicious/transactions/asn | Malicious Report Transactions ASN; returns malicious_bot | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/malicious/transactions/browser | Malicious Report Transactions Browser; returns malicious_bot | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/malicious/transactions/ip | Malicious Report Transactions IP; returns malicious_bot | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/malicious/transactions/os | Malicious Report Transactions OS; returns malicious_bot | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/malicious/transactions/ua | Malicious Report Transactions UA; returns malicious_bot | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/top/endpoints | Top Attacked Endpoints; returns attacked_endpoints | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/top/latency/overview | Top Latency Overview; returns average_latency, critical, high, low, previous_latency | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/top/latency/overview/apps | Top Latency Overview Apps; returns applications | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/top/malicious/asorg | Top Malicious Bots by ASOrg; returns malicious_bots | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/top/malicious/automation | Top Malicious Bot Automation Types; returns automation_types | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/top/malicious/ip | Top Malicious Bots by IP address; returns malicious_bots | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/top/malicious/ua | Top Malicious Bots by User Agent String; returns malicious_bots | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/top/transactions/app | Top Transactions by Application; returns application_data, total_applications | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/top/transactions/categories | Top Categories; returns categories, total_requests | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/top/transactions/endpointlabels | Top Endpoint Labels; returns endpoint_labels, total_requests | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/top/type/good | Top Good Bots; returns good_bots | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/top/type/human/dimension/browser | Top Human Browser; returns human_browser_data | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/top/type/human/dimension/device | Top Human Device; returns human_device_data | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/top/type/human/dimension/geolocation | Top Human Geolocation; returns human_geolocation_data | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/top/type/human/dimension/platform | Top Human Platform; returns human_platform_data | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/app | Top Malicious Bots by Application; returns application_data, total_applications | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/apps/timeseries | Malicious Report APP Time Series; returns app_data | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/asorg | Top Malicious Bots by ASOrg V2; returns malicious_bots | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/asorg/{attack_type} | Top ASN of Attack Intent; returns bad_bot_asn_data | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/attackintent | Top Malicious Bots by Attack Intent; returns attack_intents, total | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/automation | Top Malicious Bot Automation Types V2; returns automation_types | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/bfp | Top Attacked BFP; returns attacked_bfp | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/endpoints | Top Attacked Endpoints V2; returns attacked_endpoints | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/ip | Top Malicious Bots by IP address V2; returns malicious_bots | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/ip/{attack_type} | Top Source IP of Attack Intent; returns bad_bot_ip_data | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/ua | Top Malicious Bots by User Agent String V2; returns malicious_bots | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/ua/{attack_type} | Top User Agent of Attack Intent; returns bad_bot_ua_data | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/traffic/dimension/attackintent/timeseries | Attack Intent Time Series For All Traffic; returns attack_intent_data | Selected namespace; category, end_time, filters, start_time, use_raw_data, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/traffic/dimension/categories/timeseries | Categories Time Series For All Traffic; returns category_time_series_data | Selected namespace; category, end_time, filters, start_time, use_raw_data, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/traffic/malicious/dimension/attackintent/timeseries | Malicious Bot Attack Intent Time Series; returns attack_intent_data | Selected namespace; category, end_time, filters, start_time, use_raw_data, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/traffic/malicious/overview/actions | Malicious Traffic Overview in actions; returns flagged_count, flagged_percentage, flagged_previous, flagged_sentiment, flagged_trend | Selected namespace; category, end_time, filters, start_time, use_raw_data, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/traffic/malicious/overview/metrics | Malicious Traffic Overview Metrics; returns ASN, BFP, HFP, IP, UFP | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/traffic/malicious/overview/timeseries/actions | Malicious Traffic Overview Timeseries in Actions; returns values | Selected namespace; category, end_time, filters, start_time, use_raw_data, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/traffic/overview | Traffic Overview; returns human, malicious_bot, total | Selected namespace; category, end_time, filters, start_time, use_raw_data, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/traffic/overview/expanded | Expanded Traffic Overview; returns total_transactions, transactions | Selected namespace; end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/reporting/traffic/overview/timeseries | Traffic Overview Timeseries; returns values | Selected namespace; category, end_time, filters, start_time, use_raw_data, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v1/reporting/forensic/fields | Available forensic query field values | Selected namespace; end_time, fields, filters, start_time | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/automated/overview/actions | Automated Traffic Overview in actions; returns actions, current_total, previous_total, sentiment, trend | Selected namespace; category, end_time, filters, start_time, use_raw_data, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/known/active/ai | Active AI Known Bot; returns active_ai_bots | Selected namespace; end_time, filters, limit, pagination, request_metrics, sort_options, start_time, time_bucket_size | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/known/dimension/category | Known Bot Transactions Per Category; returns known_bot_category_distribution | Selected namespace; end_time, filters, limit, pagination, request_metrics, sort_options, start_time, time_bucket_size | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/known/dimension/category/actions | Known Bot Actions Per Category; returns action_taken_summary, category_action_breakdown | Selected namespace; end_time, filters, limit, pagination, request_metrics, sort_options, start_time, time_bucket_size | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/known/dimension/category/actions/ai | Known Bot Actions Per AI Category; returns action_taken_summary, category_action_breakdown | Selected namespace; end_time, filters, limit, pagination, request_metrics, sort_options, start_time, time_bucket_size | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/known/dimension/category/timeseries | Known Bot Categories Over Time; returns known_bot_category_time_series_data | Selected namespace; end_time, filters, limit, pagination, request_metrics, sort_options, start_time, time_bucket_size | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/known/dimension/endpoint | Known Bot Endpoint; returns known_bot_endpoints, pagination | Selected namespace; end_time, filters, limit, pagination, request_metrics, sort_options, start_time, time_bucket_size | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/known/statistics/overview | Known Bot Overview Statistics; returns distinct_ai_bots, distinct_ai_bots_sentiment, distinct_ai_bots_trend, distinct_categories, distinct_categories_sentiment | Selected namespace; end_time, filters, limit, pagination, request_metrics, sort_options, start_time, time_bucket_size | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/top/type/known/active | Top Active Known Bot; returns top_known_bots | Selected namespace; end_time, filters, limit, pagination, request_metrics, sort_options, start_time, time_bucket_size | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/endpoint/summary | Endpoint Summary V2; returns total_applications, total_distinct_endpoints, total_unevaluated_transactions | Selected namespace; category, end_time, filters, start_time, use_raw_data, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/malicious/endpoints | Malicious Report Endpoints V2; returns endpoint_data | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/malicious/transactions/asn | Malicious Report Transactions ASN V2; returns malicious_bot | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/malicious/transactions/browser | Malicious Report Transactions Browser V2; returns malicious_bot | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/malicious/transactions/ip | Malicious Report Transactions IP V2; returns malicious_bot | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/malicious/transactions/os | Malicious Report Transactions OS V2; returns malicious_bot | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/malicious/transactions/ua | Malicious Report Transactions UA V2; returns malicious_bot | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/peers/check | Check Peer Status V2; returns has_peers | Selected namespace; No additional selector | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/peers/threat-types | Peergroup By Threat Types V2; returns details | Selected namespace; end_time, limit, rank_by, start_time | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/peers/top-good-bots | Peer Group Top Good Bots V2; returns details | Selected namespace; end_time, limit, rank_by, start_time | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/peers/top-reason-codes | Peergroup Top Reason Codes V2; returns details | Selected namespace; end_time, limit, rank_by, start_time | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/peers/traffic/overview | Peer Group Traffic Overview V2; returns details, peer_percentage, peer_total, self_percentage, self_total | Selected namespace; end_time, limit, rank_by, start_time | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/good | Top Good Bots V2; returns good_bots, top_good_bots_percentage, total_good_bots | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/human/dimension/browser | Top Human Browser V2; returns human_browser_data | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/human/dimension/device | Top Human Device V2; returns human_device_data | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/human/dimension/geolocation | Top Human Geolocation V2; returns human_geolocation_data | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/human/dimension/platform | Top Human Platform V2; returns human_platform_data | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/malicious/dimension/apps/timeseries | Malicious Report APP Time Series V2; returns app_data | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/malicious/dimension/asorg/{attack_type} | Top ASN of Attack Intent V2; returns bad_bot_asn_data | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/malicious/dimension/attackintent | Top Malicious Bots by Attack Intent V2; returns attack_intents, total | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/malicious/dimension/endpoints | Top Attacked Endpoints V3; returns attacked_endpoints | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/malicious/dimension/ip/{attack_type} | Top Source IP of Attack Intent V2; returns bad_bot_ip_data | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/malicious/dimension/ua/{attack_type} | Top User Agent of Attack Intent V2; returns bad_bot_ua_data | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/traffic/malicious/dimension/attackintent/timeseries | Malicious Bot Attack Intent Time Series V2; returns attack_intent_data | Selected namespace; category, end_time, filters, start_time, use_raw_data, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/traffic/malicious/overview/actions | Malicious Traffic Overview in actions V2; returns actions | Selected namespace; category, end_time, filters, start_time, use_raw_data, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/traffic/malicious/overview/metrics | Malicious Traffic Overview Metrics V2; returns ASN, BFP, HFP, IP, UFP | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/traffic/malicious/overview/timeseries/actions | Malicious Traffic Overview Timeseries in Actions V2; returns values | Selected namespace; category, end_time, filters, start_time, use_raw_data, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/traffic/overview | Traffic Overview V2; returns bot_trend, good_bot, good_bot_percentage, good_bot_previous, good_bot_sentiment | Selected namespace; category, end_time, filters, start_time, use_raw_data, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/traffic/overview/expanded | Expanded Traffic Overview V2; returns total_transactions, transactions | Selected namespace; end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v2/reporting/traffic/overview/timeseries | Traffic Overview Timeseries V2; returns values | Selected namespace; category, end_time, filters, start_time, use_raw_data, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v3/reporting/top/type/good | Top Good Bots V3; returns good_bots, top_good_bots_percentage, total_good_bots | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v3/reporting/top/type/malicious/dimension/asorg | Top Malicious Bots by ASOrg V3; returns malicious_bots | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v3/reporting/top/type/malicious/dimension/automation | Top Malicious Bot Automation Types V3; returns automation_types | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v3/reporting/top/type/malicious/dimension/ip | Top Malicious Bots by IP address V3; returns malicious_bots | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v3/reporting/top/type/malicious/dimension/ua | Top Malicious Bots by User Agent String V3; returns malicious_bots | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v3/reporting/traffic/overview | Traffic Overview V3; returns traffic_type_data | Selected namespace; category, end_time, filters, start_time, use_raw_data, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v3/reporting/traffic/overview/expanded | Expanded Traffic Overview V3; returns total_transactions, transactions | Selected namespace; end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v3/reporting/traffic/overview/timeseries | Traffic Overview Timeseries V3; returns traffic_type_data | Selected namespace; category, end_time, filters, start_time, use_raw_data, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v4/reporting/top/type/malicious/dimension/endpoints | Top Attacked Endpoints V4; returns attacked_endpoints | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v4/reporting/top/type/malicious/dimension/ua | Top Malicious Bots by User Agent String V4; returns malicious_bots | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v4/reporting/traffic/overview/expanded | Expanded Traffic Overview in Traffic Analyzer; returns total_transactions, transactions | Selected namespace; end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v4/reporting/traffic/overview/timeseries | Traffic Overview Timeseries V4; returns traffic_type_data | Selected namespace; category, end_time, filters, start_time, use_raw_data | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v5/reporting/top/type/malicious/dimension/endpoints | Top Attacked Endpoints V5; returns attacked_endpoints | Selected namespace; attack_type, end_time, filters, limit, start_time, virtual_host | Operation · Request schema · Response schema |
POST /api/shape/bot/namespaces/{namespace}/v5/reporting/traffic/overview/expanded | Expanded Traffic Overview V5; returns total_transactions, transactions | Selected namespace; end_time, filters, pagination, sort, start_time | Operation · Request schema · Response schema |
POST /api/shape/bot/reporting/peers/threat-types | Peergroup By Threat Types; returns details | Tenant or entitled peer group; end_time, limit, rank_by, start_time | Operation · Request schema · Response schema |
POST /api/shape/bot/reporting/peers/top-good-bots | Peer Group Top Good Bots; returns details | Tenant or entitled peer group; end_time, limit, rank_by, start_time | Operation · Request schema · Response schema |
POST /api/shape/bot/reporting/peers/top-reason-codes | Peergroup Top Reason Codes; returns details | Tenant or entitled peer group; end_time, limit, rank_by, start_time | Operation · Request schema · Response schema |
POST /api/shape/bot/reporting/peers/traffic/overview | Peer Group Traffic Overview; returns details, peer_percentage, peer_total, self_percentage, self_total | Tenant or entitled peer group; end_time, limit, rank_by, start_time | Operation · Request schema · Response schema |
Related discovery and status
Section titled “Related discovery and status”| Method and exact path | Information returned | Scope and principal filters | Specification reference |
|---|---|---|---|
GET /api/shape/bot/custom/namespaces/{namespace}/bot_detection_rules/summary | summary of bot detection rules; returns rule_summary | Selected namespace; No additional selector | Operation · Request schema · Response schema |
GET /api/shape/bot/namespaces/system/regions | Regions; returns regions | Tenant; system only; No additional selector | Operation · Request schema · Response schema |
Existing reports and artifacts
Section titled “Existing reports and artifacts”| Method and exact path | Information returned | Scope and principal filters | Specification reference |
|---|---|---|---|
POST /api/report/namespaces/{namespace}/report_configs/list-reports-history-bot-defence | Reports History Bot Defence; returns items, reports, reports_list | Selected namespace; include_all, report_config_names | Operation · Request schema · Response schema |