Method: matters.count

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:

JSON representation
{
  "query": {
    object (Query)
  },
  "view": enum (CountResultView)
}
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

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.