Team Drives-related fields in the Vault API are being replaced. Learn more.

Method: matters.count

Counts the artifacts within the context of a matter and returns a detailed breakdown of metrics.

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)

Specifies the granularity of the count result returned in response.

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. It works the same as TOTAL_COUNT.
TOTAL_COUNT Response includes: total count, queried accounts count, matching accounts count, non-queryable accounts, queried account errors.
ALL Response includes additional breakdown of account count.