Google Vault API

googleapis · Analytics

Analytics No Auth Free & Open analytics media

Retention and eDiscovery for Google Workspace. To work with Vault resources, the account must have the [required Vault privileges](https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege. For example, to download an export, an account needs the **Manage Exports** privilege and the matter shared with them.

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET vault.matters.list

Lists matters the requestor has access to.

https://api.apis.guru/v2/specs/googleapis.com/vault/v1/v1/matters?alt=json&key=YOUR_API_KEY&view=VIEW_UNSPECIFIED&state=STATE_UNSPECIFIED&fields=example&$.xgafv=1&callback=example&pageSize=1&pageToken=example&quotaUser=example&uploadType=example&oauth_token=example&prettyPrint=true&access_token=example&upload_protocol=example

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/googleapis.com/vault/v1/v1/matters?alt=json&key=YOUR_API_KEY&view=VIEW_UNSPECIFIED&state=STATE_UNSPECIFIED&fields=example&$.xgafv=1&callback=example&pageSize=1&pageToken=example&quotaUser=example&uploadType=example&oauth_token=example&prettyPrint=true&access_token=example&upload_protocol=example"

import requests
params = {
    "alt": "json",
    "key": "YOUR_API_KEY",
    "view": "VIEW_UNSPECIFIED",
    "state": "STATE_UNSPECIFIED",
    "fields": "example",
    "$.xgafv": "1",
    "callback": "example",
    "pageSize": "1",
    "pageToken": "example",
    "quotaUser": "example",
    "uploadType": "example",
    "oauth_token": "example",
    "prettyPrint": "true",
    "access_token": "example",
    "upload_protocol": "example"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/googleapis.com/vault/v1/v1/matters",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/googleapis.com/vault/v1/v1/matters');
url.searchParams.set('alt', 'json');
url.searchParams.set('key', 'YOUR_API_KEY');
url.searchParams.set('view', 'VIEW_UNSPECIFIED');
url.searchParams.set('state', 'STATE_UNSPECIFIED');
url.searchParams.set('fields', 'example');
url.searchParams.set('$.xgafv', '1');
url.searchParams.set('callback', 'example');
url.searchParams.set('pageSize', '1');
url.searchParams.set('pageToken', 'example');
url.searchParams.set('quotaUser', 'example');
url.searchParams.set('uploadType', 'example');
url.searchParams.set('oauth_token', 'example');
url.searchParams.set('prettyPrint', 'true');
url.searchParams.set('access_token', 'example');
url.searchParams.set('upload_protocol', 'example');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/googleapis.com/vault/v1/v1/matters")
	q := baseURL.Query()
	q.Set("alt", "json")
	q.Set("key", "YOUR_API_KEY")
	q.Set("view", "VIEW_UNSPECIFIED")
	q.Set("state", "STATE_UNSPECIFIED")
	q.Set("fields", "example")
	q.Set("$.xgafv", "1")
	q.Set("callback", "example")
	q.Set("pageSize", "1")
	q.Set("pageToken", "example")
	q.Set("quotaUser", "example")
	q.Set("uploadType", "example")
	q.Set("oauth_token", "example")
	q.Set("prettyPrint", "true")
	q.Set("access_token", "example")
	q.Set("upload_protocol", "example")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/googleapis.com/vault/v1/v1/matters")
uri.query = URI.encode_www_form({
  "alt" => "json",
  "key" => "YOUR_API_KEY",
  "view" => "VIEW_UNSPECIFIED",
  "state" => "STATE_UNSPECIFIED",
  "fields" => "example",
  "$.xgafv" => "1",
  "callback" => "example",
  "pageSize" => "1",
  "pageToken" => "example",
  "quotaUser" => "example",
  "uploadType" => "example",
  "oauth_token" => "example",
  "prettyPrint" => "true",
  "access_token" => "example",
  "upload_protocol" => "example"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/googleapis.com/vault/v1/v1/matters?" . http_build_query([
    "alt" => "json",
    "key" => "YOUR_API_KEY",
    "view" => "VIEW_UNSPECIFIED",
    "state" => "STATE_UNSPECIFIED",
    "fields" => "example",
    "$.xgafv" => "1",
    "callback" => "example",
    "pageSize" => "1",
    "pageToken" => "example",
    "quotaUser" => "example",
    "uploadType" => "example",
    "oauth_token" => "example",
    "prettyPrint" => "true",
    "access_token" => "example",
    "upload_protocol" => "example"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET vault.operations.list

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

https://api.apis.guru/v2/specs/googleapis.com/vault/v1/v1/{name}?alt=json&key=YOUR_API_KEY&fields=example&filter=example&$.xgafv=1&callback=example&pageSize=1&pageToken=example&quotaUser=example&uploadType=example&oauth_token=example&prettyPrint=true&access_token=example&upload_protocol=example

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/googleapis.com/vault/v1/v1/{name}?alt=json&key=YOUR_API_KEY&fields=example&filter=example&$.xgafv=1&callback=example&pageSize=1&pageToken=example&quotaUser=example&uploadType=example&oauth_token=example&prettyPrint=true&access_token=example&upload_protocol=example"

import requests
params = {
    "alt": "json",
    "key": "YOUR_API_KEY",
    "fields": "example",
    "filter": "example",
    "$.xgafv": "1",
    "callback": "example",
    "pageSize": "1",
    "pageToken": "example",
    "quotaUser": "example",
    "uploadType": "example",
    "oauth_token": "example",
    "prettyPrint": "true",
    "access_token": "example",
    "upload_protocol": "example"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/googleapis.com/vault/v1/v1/{name}",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/googleapis.com/vault/v1/v1/{name}');
url.searchParams.set('alt', 'json');
url.searchParams.set('key', 'YOUR_API_KEY');
url.searchParams.set('fields', 'example');
url.searchParams.set('filter', 'example');
url.searchParams.set('$.xgafv', '1');
url.searchParams.set('callback', 'example');
url.searchParams.set('pageSize', '1');
url.searchParams.set('pageToken', 'example');
url.searchParams.set('quotaUser', 'example');
url.searchParams.set('uploadType', 'example');
url.searchParams.set('oauth_token', 'example');
url.searchParams.set('prettyPrint', 'true');
url.searchParams.set('access_token', 'example');
url.searchParams.set('upload_protocol', 'example');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/googleapis.com/vault/v1/v1/{name}")
	q := baseURL.Query()
	q.Set("alt", "json")
	q.Set("key", "YOUR_API_KEY")
	q.Set("fields", "example")
	q.Set("filter", "example")
	q.Set("$.xgafv", "1")
	q.Set("callback", "example")
	q.Set("pageSize", "1")
	q.Set("pageToken", "example")
	q.Set("quotaUser", "example")
	q.Set("uploadType", "example")
	q.Set("oauth_token", "example")
	q.Set("prettyPrint", "true")
	q.Set("access_token", "example")
	q.Set("upload_protocol", "example")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/googleapis.com/vault/v1/v1/{name}")
uri.query = URI.encode_www_form({
  "alt" => "json",
  "key" => "YOUR_API_KEY",
  "fields" => "example",
  "filter" => "example",
  "$.xgafv" => "1",
  "callback" => "example",
  "pageSize" => "1",
  "pageToken" => "example",
  "quotaUser" => "example",
  "uploadType" => "example",
  "oauth_token" => "example",
  "prettyPrint" => "true",
  "access_token" => "example",
  "upload_protocol" => "example"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/googleapis.com/vault/v1/v1/{name}?" . http_build_query([
    "alt" => "json",
    "key" => "YOUR_API_KEY",
    "fields" => "example",
    "filter" => "example",
    "$.xgafv" => "1",
    "callback" => "example",
    "pageSize" => "1",
    "pageToken" => "example",
    "quotaUser" => "example",
    "uploadType" => "example",
    "oauth_token" => "example",
    "prettyPrint" => "true",
    "access_token" => "example",
    "upload_protocol" => "example"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET vault.matters.get

Gets the specified matter.

https://api.apis.guru/v2/specs/googleapis.com/vault/v1/v1/matters/{matterId}?alt=json&key=YOUR_API_KEY&view=VIEW_UNSPECIFIED&fields=example&$.xgafv=1&callback=example&quotaUser=example&uploadType=example&oauth_token=example&prettyPrint=true&access_token=example&upload_protocol=example

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/googleapis.com/vault/v1/v1/matters/{matterId}?alt=json&key=YOUR_API_KEY&view=VIEW_UNSPECIFIED&fields=example&$.xgafv=1&callback=example&quotaUser=example&uploadType=example&oauth_token=example&prettyPrint=true&access_token=example&upload_protocol=example"

import requests
params = {
    "alt": "json",
    "key": "YOUR_API_KEY",
    "view": "VIEW_UNSPECIFIED",
    "fields": "example",
    "$.xgafv": "1",
    "callback": "example",
    "quotaUser": "example",
    "uploadType": "example",
    "oauth_token": "example",
    "prettyPrint": "true",
    "access_token": "example",
    "upload_protocol": "example"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/googleapis.com/vault/v1/v1/matters/{matterId}",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/googleapis.com/vault/v1/v1/matters/{matterId}');
url.searchParams.set('alt', 'json');
url.searchParams.set('key', 'YOUR_API_KEY');
url.searchParams.set('view', 'VIEW_UNSPECIFIED');
url.searchParams.set('fields', 'example');
url.searchParams.set('$.xgafv', '1');
url.searchParams.set('callback', 'example');
url.searchParams.set('quotaUser', 'example');
url.searchParams.set('uploadType', 'example');
url.searchParams.set('oauth_token', 'example');
url.searchParams.set('prettyPrint', 'true');
url.searchParams.set('access_token', 'example');
url.searchParams.set('upload_protocol', 'example');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/googleapis.com/vault/v1/v1/matters/{matterId}")
	q := baseURL.Query()
	q.Set("alt", "json")
	q.Set("key", "YOUR_API_KEY")
	q.Set("view", "VIEW_UNSPECIFIED")
	q.Set("fields", "example")
	q.Set("$.xgafv", "1")
	q.Set("callback", "example")
	q.Set("quotaUser", "example")
	q.Set("uploadType", "example")
	q.Set("oauth_token", "example")
	q.Set("prettyPrint", "true")
	q.Set("access_token", "example")
	q.Set("upload_protocol", "example")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/googleapis.com/vault/v1/v1/matters/{matterId}")
uri.query = URI.encode_www_form({
  "alt" => "json",
  "key" => "YOUR_API_KEY",
  "view" => "VIEW_UNSPECIFIED",
  "fields" => "example",
  "$.xgafv" => "1",
  "callback" => "example",
  "quotaUser" => "example",
  "uploadType" => "example",
  "oauth_token" => "example",
  "prettyPrint" => "true",
  "access_token" => "example",
  "upload_protocol" => "example"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/googleapis.com/vault/v1/v1/matters/{matterId}?" . http_build_query([
    "alt" => "json",
    "key" => "YOUR_API_KEY",
    "view" => "VIEW_UNSPECIFIED",
    "fields" => "example",
    "$.xgafv" => "1",
    "callback" => "example",
    "quotaUser" => "example",
    "uploadType" => "example",
    "oauth_token" => "example",
    "prettyPrint" => "true",
    "access_token" => "example",
    "upload_protocol" => "example"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

Postman Setup Guide

Get Postman ↗

See official documentation for authentication and setup.

What can you build with Google Vault API?

Google Vault API is a Analytics API. Developers commonly use analytics APIs for:

tracking product usage and user behaviour
building custom reporting and BI dashboards
measuring marketing and campaign performance
running funnel, retention, and cohort analysis
aggregating metrics from multiple data sources

No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. Google Vault API is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide · Learn about API keys · What is REST?

Open documentation ↗