Rest API Report View Count "fields" parameter

Frappe Framework
, ,
1

I have this rest API : api/method/frappe.desk.reportview.get_count that hit on each doctype/ report, but I need to know when we send this parameter fields and what’s the use case for it (when can i use it or what example of it can i have)?

curl --location 'http://erp.local/api/method/frappe.desk.reportview.get_count' \
--header 'Accept: application/json' \
--header 'Accept-Language: en-US,en;q=0.9' \
--header 'Connection: keep-alive' \
--header 'Content-Type: application/x-www-form-urlencoded; charset=UTF-8' \
--header 'Origin: http://erp.local' \
--header 'Referer: http://erp.local/app/sales-invoice' \
--header 'Sec-Fetch-Dest: empty' \
--header 'Sec-Fetch-Mode: cors' \
--header 'Sec-Fetch-Site: same-origin' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/132.0.0.0 Safari/537.36' \
--header 'X-Frappe-CSRF-Token: -' \
--header 'Authorization: token -:-' \
--header 'Cookie: full_name=Guest; sid=Guest; system_user=no; user_id=Guest; user_image=' \
--form 'doctype="Sales Invoice"' \
--form 'filters=""' \
--form 'fields=""' \
--form 'distinct="false"' \
--form 'limit="1001"'
2

You will hardly find use cases to use it.

fields will help you to get the total count for the column/field that you specify in the report.

When distinct is set = True, it will give you unique entries based on field you pass, if blank, name is taken by default for Count.

You will find the code here if needed more.