Skip to content
OpenParablePublic APIs

Proximity Beacon API API

by googleapis.com

OAuthHTTPSAnalytics
Open documentation ↗

Overview

Registers, manages, indexes, and searches beacons.

Proximity Beacon API is an analytics API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 17 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Category
Analytics
Base URL
https://proximitybeacon.googleapis.com/
Version
v1beta1
Endpoints
17
OpenAPI
Specification ↗
Spec updated
2021-06-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://proximitybeacon.googleapis.com/v1beta1/beacons" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://proximitybeacon.googleapis.com/v1beta1/beacons", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://proximitybeacon.googleapis.com/v1beta1/beacons",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
POST/v1beta1/beaconinfo:getforobservedGiven one or more beacon observations, returns any beacon information and attachments accessible to your application. Authorize by using the [API key](https://d
GET/v1beta1/beaconsSearches the beacon registry for beacons that match the given search criteria. Only those beacons that the client has permission to list will be returned. Authe
POST/v1beta1/beacons:registerRegisters a previously unregistered beacon given its `advertisedId`. These IDs are unique within the system. An ID can be registered only once. Authenticate usi
GET/v1beta1/eidparamsGets 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
GET/v1beta1/namespacesLists all attachment namespaces owned by your Google Developers Console project. Attachment data associated with a beacon must include a namespaced type, and th
DELETE/v1beta1/{attachmentName}Deletes the specified attachment for the given beacon. Each attachment has a unique attachment name (`attachmentName`) which is returned when you fetch the atta
GET/v1beta1/{beaconName}Returns detailed information about the specified beacon. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) fro
PUT/v1beta1/{beaconName}Updates the information about the specified beacon. **Any field that you do not populate in the submitted beacon will be permanently erased**, so you should fol
DELETE/v1beta1/{beaconName}Deletes the specified beacon including all diagnostics data for the beacon as well as any attachments on the beacon (including those belonging to other projects
GET/v1beta1/{beaconName}/attachmentsReturns the attachments for the specified beacon that match the specified namespaced-type pattern. To control which namespaced types are returned, you add the `
POST/v1beta1/{beaconName}/attachmentsAssociates the given data with the specified beacon. Attachment data must contain two parts: - A namespaced type. - The actual attachment data itself. The names
POST/v1beta1/{beaconName}/attachments:batchDeleteDeletes multiple attachments on a given beacon. This operation is permanent and cannot be undone. You can optionally specify `namespacedType` to choose which at
GET/v1beta1/{beaconName}/diagnosticsList the diagnostics for a single beacon. You can also list diagnostics for all the beacons owned by your Google Developers Console project by using the beacon
POST/v1beta1/{beaconName}:activateActivates a beacon. A beacon that is active will return information and attachment data when queried via `beaconinfo.getforobserved`. Calling this method on an
POST/v1beta1/{beaconName}:deactivateDeactivates a beacon. Once deactivated, the API will not return information nor attachment data for the beacon when queried via `beaconinfo.getforobserved`. Cal
POST/v1beta1/{beaconName}:decommissionDecommissions the specified beacon in the service. This beacon will no longer be returned from `beaconinfo.getforobserved`. This operation is permanent -- you w
PUT/v1beta1/{namespaceName}Updates the information about the specified namespace. Only the namespace visibility can be updated.

Questions

Does the Proximity Beacon API API need an API key?

Yes. The Proximity Beacon API API uses OAuth authentication; the documentation explains how to get credentials.

Does the Proximity Beacon API API support HTTPS?

Yes, the Proximity Beacon API API is served over HTTPS.

How many endpoints does the Proximity Beacon API API have?

Its OpenAPI description lists 17 endpoints in version v1beta1. All of them are shown on this page.

What are alternatives to the Proximity Beacon API API?

Other Analytics APIs include Google Play Integrity API, versionhistory.googleapis.com API, Doc Converter, Perspective Comment Analyzer API, Safe Browsing API.

Compare alternatives →

Google Play Integrity API

Analytics

The Play Integrity API helps you check that you're interacting with your genuine app on a genuine Android device powered by Google Play services. The Play Integrity API has replaced SafetyNet Attestation and Android Device Verification.

OAuth1 endpoints

versionhistory.googleapis.com API

Analytics

Version History API - Prod

No auth4 endpoints

Doc Converter

Analytics

This api converts file formats of OpenXml and OpenOffice documents formats to vector files (e.g., svg)

No auth1 endpoints

Perspective Comment Analyzer API

Analytics

The Perspective Comment Analyzer API provides information about the potential impact of a comment on a conversation (e.g. it can provide a score for the "toxicity" of a comment). Users can leverage the "SuggestCommentScore" method to submit corrections to improve Perspective over time. Users can set the "doNotStore" flag to ensure that all submitted comments are automatically deleted after scores are returned.

OAuth2 endpoints

Safe Browsing API

Analytics

Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.

No auth7 endpoints

Web Fonts Developer API

Analytics

The Google Web Fonts Developer API lets you retrieve information about web fonts served by Google.

No auth1 endpoints

Listed from APIs.guru (CC0).