Method: matters.count
Stay organized with collections
Save and categorize content based on your preferences.
Counts the accounts processed by the specified query.
HTTP request
POST https://vault.googleapis.com/v1/matters/{matterId}:count
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
matterId |
string
The matter ID.
|
Request body
The request body contains data with the following structure:
| Fields |
query |
object (Query)
The search query.
|
view |
enum (CountResultView)
Sets the granularity of the count results.
|
Response body
If successful, the response body contains an instance of Operation.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/ediscovery
For more information, see the Authorization guide.
CountResultView
The possible granularity level of a count result.
| Enums |
COUNT_RESULT_VIEW_UNSPECIFIED |
Default. Same as TOTAL_COUNT. |
TOTAL_COUNT |
Response includes counts of the total accounts, queried accounts, matching accounts, non-queryable accounts, and queried account errors. |
ALL |
Response includes the same details as TOTAL_COUNT, plus additional account breakdown. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-17 UTC.
[null,null,["Last updated 2025-03-17 UTC."],[],[],null,["# Method: matters.count\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [CountResultView](#CountResultView)\n- [Try it!](#try-it)\n\nCounts the accounts processed by the specified query.\n\n### HTTP request\n\n`POST https://vault.googleapis.com/v1/matters/{matterId}:count`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|-------------------------|\n| `matterId` | `string` The matter ID. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"query\": { object (/workspace/vault/reference/rest/v1/Query) }, \"view\": enum (/workspace/vault/reference/rest/v1/matters/count#CountResultView) } ``` |\n\n| Fields ||\n|---------|-------------------------------------------------------------------------------------------------------------------------------------------|\n| `query` | `object (`[Query](/workspace/vault/reference/rest/v1/Query)`)` The search query. |\n| `view` | `enum (`[CountResultView](/workspace/vault/reference/rest/v1/matters/count#CountResultView)`)` Sets the granularity of the count results. |\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/workspace/vault/reference/rest/v1/operations#Operation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/ediscovery`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nCountResultView\n---------------\n\nThe possible granularity level of a count result.\n\n| Enums ||\n|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|\n| `COUNT_RESULT_VIEW_UNSPECIFIED` | Default. Same as **TOTAL_COUNT**. |\n| `TOTAL_COUNT` | Response includes counts of the total accounts, queried accounts, matching accounts, non-queryable accounts, and queried account errors. |\n| `ALL` | Response includes the same details as **TOTAL_COUNT**, plus additional account breakdown. |"]]
