diff --git a/cl/api/templates/search-api-docs-vlatest.html b/cl/api/templates/search-api-docs-vlatest.html index 89de45e3c6..c0a0d9162b 100644 --- a/cl/api/templates/search-api-docs-vlatest.html +++ b/cl/api/templates/search-api-docs-vlatest.html @@ -40,6 +40,7 @@
type=d
and type=r
use cardinality aggregation to compute the result count. This enhances performance, but has an error of ±6% if results are over 2000. We recommend noting this in your interface by saying something like, "About 10,000 results."
When filering by courts, it’s important to understand how court data is organized and how parent-child relationships between courts work in our system.
+For instance, Massachusetts has multiple Superior Courts, but you may only be interested in opinions from the Suffolk County branch located in Boston.
+To search specifically for opinions from the Massachusetts Superior Court, Suffolk County, you can include the court ID masssuperctsuff
in your query:
http://localhost:8000/q=foo&court=masssuperctsuff+
If instead you want all opinions from any Massachusetts Superior Court, regardless of the county, use should use the parent court ID masssuperct
:
http://localhost:8000/q=foo&court=masssuperct+
This query will return opinions from all Massachusetts Superior Courts in our database.
+The is possible by a parent-child relationship in some courts. Here, masssuperctsuff
(Suffolk County) is a child of masssuperct
. By using the appropriate court ID in your query, you can tailor your search to be as broad or specific as needed.
This approach allows you to refine your results to match your exact requirements, whether you need comprehensive coverage or a focused subset of opinions.
A few fields deserve special consideration: