CFA-1223

site/specs/messaging.yml

@@ -887,6 +887,7 @@ paths:
         - $ref: '#/components/parameters/sort'
         - $ref: '#/components/parameters/pageToken'
         - $ref: '#/components/parameters/limit'
+        - $ref: '#/components/parameters/limitTotalCount'
       responses:
         '200':
           $ref: '#/components/responses/listMessagesResponse'
@@ -1529,6 +1530,19 @@ components:
       schema:
         type: integer
       example: 50
+    limitTotalCount:
+      in: query
+      name: limitTotalCount
+      required: false
+      description: >-
+        When set to true, the response's totalCount field will have a maximum
+        value of 10,000. When set to false, or excluded, this will give an
+        accurate totalCount of all messages that match the provided filters. If
+        you are experiencing latency, try using this parameter to limit your
+        results.
+      example: true
+      schema:
+        type: boolean
   schemas:
     priorityEnum:
       type: string
@@ -1593,7 +1607,9 @@ components:
       properties:
         totalCount:
           type: integer
-          description: Total number of messages matched by the search.
+          description: >-
+            The total number of messages matched by the search. When the request
+            has limitTotalCount set to true this value is limited to 10,000.
           example: 100
         pageInfo:
           $ref: '#/components/schemas/pageInfo'