documents new behavior

Datawheel · Sep 3, 2020 · dc1e2ed · dc1e2ed
1 parent cd21607
commit dc1e2ed
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/packages/cms/README.md b/packages/cms/README.md
@@ -495,6 +495,9 @@ If you would prefer to build your own search component, the DeepSearch API is av
 |`query`|Query to search for|
 |`locale`|Language for results|
 |`limit`|Maximum number of results to return|
+|`profile`|Restrict results to a profile, must be an integer profile id or a profile slug (unary profiles only)|
+|`dimension`|Restrict results by dimension|
+|`hierarchy`|Restrict results by hierarchy (comma separated)|
 |`min_confidence`|Confidence threshold (Deepsearch Only)|
 
 Results will be returned in a response object that includes metadata on the results. Matching members separated by profile can be found in the `profiles` key of the response object. A single grouped list of all matching profiles can be found in the `grouped` key of the response object.