feedback

Creates, updates, deletes, gets or lists a feedback resource.

Overview

Name	feedback
Type	Resource
Id	cloudflare.bot_management.feedback

Fields

The following fields are returned by SELECT queries:

list

List of feedback reports

Name	Datatype	Description
created_at	string (date-time)
description	string
expression	string	Wirefilter expression describing the traffic being reported.
first_request_seen_at	string (date-time)
last_request_seen_at	string (date-time)
requests	integer (int64)
requests_by_attribute	object	Top attributes contributing to the feedback sample. Keys include topASNs, topCountries, topHosts, topIPs, topJA3Hashes, topJA4s, topPaths, topUserAgents.
requests_by_score	object	Map of bot scores (1-99) to request counts. Sum must equal requests.
requests_by_score_src	object	Map of score source to request counts. Sum must equal requests.
subtype	string
type	string	Type of feedback report. (false_positive, false_negative) (example: false_positive)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	zone_id		Returns all feedback reports previously submitted for the specified zone. Feedback reports help improve detection by sharing samples of traffic that were misclassified as bots or humans.
bot_management_zone_feedback_create	insert	zone_id, type, description, expression, first_request_seen_at, last_request_seen_at, requests, requests_by_score, requests_by_score_src, requests_by_attribute		Submit a feedback report for the specified zone. Use type to indicate whether the report is a false positive (good traffic flagged as bot) or a false negative (bot traffic missed). Furthermore, you can also use expression as a wirefilter to identify the affected traffic sample. See more accepted API fields and expression types at https://developers.cloudflare.com/bots/concepts/feedback-loop/#api-fields and https://developers.cloudflare.com/bots/concepts/feedback-loop/#expression-fields, respectively.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
zone_id	string	The Cloudflare zone ID.

SELECT examples

list

Returns all feedback reports previously submitted for the specified zone. Feedback reports help improve detection by sharing samples of traffic that were misclassified as bots or humans.

SELECT
created_at,
description,
expression,
first_request_seen_at,
last_request_seen_at,
requests,
requests_by_attribute,
requests_by_score,
requests_by_score_src,
subtype,
type
FROM cloudflare.bot_management.feedback
WHERE zone_id = '{{ zone_id }}' -- required
;

INSERT examples

bot_management_zone_feedback_create

Submit a feedback report for the specified zone. Use type to indicate whether the report is a false positive (good traffic flagged as bot) or a false negative (bot traffic missed). Furthermore, you can also use expression as a wirefilter to identify the affected traffic sample. See more accepted API fields and expression types at https://developers.cloudflare.com/bots/concepts/feedback-loop/#api-fields and https://developers.cloudflare.com/bots/concepts/feedback-loop/#expression-fields, respectively.

INSERT INTO cloudflare.bot_management.feedback (
description,
expression,
first_request_seen_at,
last_request_seen_at,
requests,
requests_by_attribute,
requests_by_score,
requests_by_score_src,
subtype,
type,
zone_id
)
SELECT 
'{{ description }}' /* required */,
'{{ expression }}' /* required */,
'{{ first_request_seen_at }}' /* required */,
'{{ last_request_seen_at }}' /* required */,
{{ requests }} /* required */,
'{{ requests_by_attribute }}' /* required */,
'{{ requests_by_score }}' /* required */,
'{{ requests_by_score_src }}' /* required */,
'{{ subtype }}',
'{{ type }}' /* required */,
'{{ zone_id }}'
;

Manifest

# Description fields are for documentation purposes
- name: feedback
props:
  - name: zone_id
    value: "{{ zone_id }}"
    description: Required parameter for the feedback resource.
  - name: description
    value: "{{ description }}"
  - name: expression
    value: "{{ expression }}"
    description: |
      Wirefilter expression describing the traffic being reported.
  - name: first_request_seen_at
    value: "{{ first_request_seen_at }}"
  - name: last_request_seen_at
    value: "{{ last_request_seen_at }}"
  - name: requests
    value: {{ requests }}
  - name: requests_by_attribute
    value: "{{ requests_by_attribute }}"
    description: |
      Top attributes contributing to the feedback sample. Keys include topASNs, topCountries, topHosts, topIPs, topJA3Hashes, topJA4s, topPaths, topUserAgents.
  - name: requests_by_score
    value: "{{ requests_by_score }}"
    description: |
      Map of bot scores (1-99) to request counts. Sum must equal `requests`.
  - name: requests_by_score_src
    value: "{{ requests_by_score_src }}"
    description: |
      Map of score source to request counts. Sum must equal `requests`.
  - name: subtype
    value: "{{ subtype }}"
  - name: type
    value: "{{ type }}"
    description: |
      Type of feedback report.
    valid_values: ['false_positive', 'false_negative']