Proximity Beacon API

googleapis · Analytics

Analytics No Auth Free & Open analytics media

Registers, manages, indexes, and searches beacons.

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET proximitybeacon.beacons.list

Searches the beacon registry for beacons that match the given search criteria. Only those beacons that the client has permission to list will be returned. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is o

https://api.apis.guru/v2/specs/googleapis.com/proximitybeacon/v1beta1/v1beta1/beacons?q=test&alt=json&key=YOUR_API_KEY&fields=example&$.xgafv=1&callback=example&pageSize=1&pageToken=example&projectId=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/proximitybeacon/v1beta1/v1beta1/beacons?q=test&alt=json&key=YOUR_API_KEY&fields=example&$.xgafv=1&callback=example&pageSize=1&pageToken=example&projectId=example&quotaUser=example&uploadType=example&oauth_token=example&prettyPrint=true&access_token=example&upload_protocol=example"

import requests
params = {
    "q": "test",
    "alt": "json",
    "key": "YOUR_API_KEY",
    "fields": "example",
    "$.xgafv": "1",
    "callback": "example",
    "pageSize": "1",
    "pageToken": "example",
    "projectId": "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/proximitybeacon/v1beta1/v1beta1/beacons",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/googleapis.com/proximitybeacon/v1beta1/v1beta1/beacons');
url.searchParams.set('q', 'test');
url.searchParams.set('alt', 'json');
url.searchParams.set('key', 'YOUR_API_KEY');
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('projectId', '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/proximitybeacon/v1beta1/v1beta1/beacons")
	q := baseURL.Query()
	q.Set("q", "test")
	q.Set("alt", "json")
	q.Set("key", "YOUR_API_KEY")
	q.Set("fields", "example")
	q.Set("$.xgafv", "1")
	q.Set("callback", "example")
	q.Set("pageSize", "1")
	q.Set("pageToken", "example")
	q.Set("projectId", "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/proximitybeacon/v1beta1/v1beta1/beacons")
uri.query = URI.encode_www_form({
  "q" => "test",
  "alt" => "json",
  "key" => "YOUR_API_KEY",
  "fields" => "example",
  "$.xgafv" => "1",
  "callback" => "example",
  "pageSize" => "1",
  "pageToken" => "example",
  "projectId" => "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/proximitybeacon/v1beta1/v1beta1/beacons?" . http_build_query([
    "q" => "test",
    "alt" => "json",
    "key" => "YOUR_API_KEY",
    "fields" => "example",
    "$.xgafv" => "1",
    "callback" => "example",
    "pageSize" => "1",
    "pageToken" => "example",
    "projectId" => "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 proximitybeacon.namespaces.list

Lists all attachment namespaces owned by your Google Developers Console project. Attachment data associated with a beacon must include a namespaced type, and the namespace must be owned by your project. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth

https://api.apis.guru/v2/specs/googleapis.com/proximitybeacon/v1beta1/v1beta1/namespaces?alt=json&key=YOUR_API_KEY&fields=example&$.xgafv=1&callback=example&projectId=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/proximitybeacon/v1beta1/v1beta1/namespaces?alt=json&key=YOUR_API_KEY&fields=example&$.xgafv=1&callback=example&projectId=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",
    "$.xgafv": "1",
    "callback": "example",
    "projectId": "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/proximitybeacon/v1beta1/v1beta1/namespaces",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/googleapis.com/proximitybeacon/v1beta1/v1beta1/namespaces');
url.searchParams.set('alt', 'json');
url.searchParams.set('key', 'YOUR_API_KEY');
url.searchParams.set('fields', 'example');
url.searchParams.set('$.xgafv', '1');
url.searchParams.set('callback', 'example');
url.searchParams.set('projectId', '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/proximitybeacon/v1beta1/v1beta1/namespaces")
	q := baseURL.Query()
	q.Set("alt", "json")
	q.Set("key", "YOUR_API_KEY")
	q.Set("fields", "example")
	q.Set("$.xgafv", "1")
	q.Set("callback", "example")
	q.Set("projectId", "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/proximitybeacon/v1beta1/v1beta1/namespaces")
uri.query = URI.encode_www_form({
  "alt" => "json",
  "key" => "YOUR_API_KEY",
  "fields" => "example",
  "$.xgafv" => "1",
  "callback" => "example",
  "projectId" => "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/proximitybeacon/v1beta1/v1beta1/namespaces?" . http_build_query([
    "alt" => "json",
    "key" => "YOUR_API_KEY",
    "fields" => "example",
    "$.xgafv" => "1",
    "callback" => "example",
    "projectId" => "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 proximitybeacon.getEidparams

Gets the Proximity Beacon API's current public key and associated parameters used to initiate the Diffie-Hellman key exchange required to register a beacon that broadcasts the Eddystone-EID format. This key changes periodically; clients may cache it and re-use the same public key to provision and re

https://api.apis.guru/v2/specs/googleapis.com/proximitybeacon/v1beta1/v1beta1/eidparams?alt=json&key=YOUR_API_KEY&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/proximitybeacon/v1beta1/v1beta1/eidparams?alt=json&key=YOUR_API_KEY&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",
    "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/proximitybeacon/v1beta1/v1beta1/eidparams",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/googleapis.com/proximitybeacon/v1beta1/v1beta1/eidparams');
url.searchParams.set('alt', 'json');
url.searchParams.set('key', 'YOUR_API_KEY');
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/proximitybeacon/v1beta1/v1beta1/eidparams")
	q := baseURL.Query()
	q.Set("alt", "json")
	q.Set("key", "YOUR_API_KEY")
	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/proximitybeacon/v1beta1/v1beta1/eidparams")
uri.query = URI.encode_www_form({
  "alt" => "json",
  "key" => "YOUR_API_KEY",
  "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/proximitybeacon/v1beta1/v1beta1/eidparams?" . http_build_query([
    "alt" => "json",
    "key" => "YOUR_API_KEY",
    "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 Proximity Beacon API?

Proximity Beacon 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. Proximity Beacon API is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide

Open documentation ↗