# Proximity Beacon API API

> Proximity Beacon API API on Apizie: 17 endpoints (Given one or more beacon observations, returns any beacon information and attachments accessible to your…, Activates a beacon. A beacon that is active will return information and attachment data when queried via…, Deactivates a beacon. Once deactivated, the API will not return information nor attachment data for the…, Decommissions the specified beacon in the service. This beacon will no longer be returned from…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/analytics:googleapis-proximitybeacon/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `analytics:googleapis-proximitybeacon`
- Category: Analytics
- Status: byok
- Source: https://developers.google.com/beacons/proximity/
- Page: https://www.apizie.tech/api/analytics/googleapis-proximitybeacon
- OpenAPI: https://www.apizie.tech/api/analytics/googleapis-proximitybeacon/openapi.json

Registers, manages, indexes, and searches beacons.

## Endpoints

### Given one or more beacon observations, returns any beacon information and attachments accessible to your…
`POST https://www.apizie.tech/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beaconinfo-getforobserved` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Activates a beacon. A beacon that is active will return information and attachment data when queried via…
`POST https://www.apizie.tech/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beacons-activate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| beaconName | string | yes | Beacon that should be activated. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the… |
| projectId | string | no | The project id of the beacon to activate. If the project id is not specified then the project making the request is used. The project id… |

### Deactivates a beacon. Once deactivated, the API will not return information nor attachment data for the…
`POST https://www.apizie.tech/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beacons-deactivate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| beaconName | string | yes | Beacon that should be deactivated. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the… |
| projectId | string | no | The project id of the beacon to deactivate. If the project id is not specified then the project making the request is used. The project id… |

### Decommissions the specified beacon in the service. This beacon will no longer be returned from…
`POST https://www.apizie.tech/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beacons-decommission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| beaconName | string | yes | Beacon that should be decommissioned. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by… |
| projectId | string | no | The project id of the beacon to decommission. If the project id is not specified then the project making the request is used. The project… |

### Returns detailed information about the specified beacon. Authenticate using an [OAuth access…
`GET https://www.apizie.tech/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beacons-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| beaconName | string | yes | Resource name of this beacon. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the… |
| projectId | string | no | The project id of the beacon to request. If the project id is not specified then the project making the request is used. The project id… |

### Updates the information about the specified beacon. **Any field that you do not populate in the submitted…
`POST https://www.apizie.tech/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beacons-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| beaconName | string | yes | Resource name of this beacon. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the… |
| projectId | string | no | The project id of the beacon to update. If the project id is not specified then the project making the request is used. The project id… |
| body | object | yes | JSON request body |

### Deletes the specified beacon including all diagnostics data for the beacon as well as any attachments on the…
`POST https://www.apizie.tech/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beacons-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| beaconName | string | yes | Beacon that should be deleted. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the… |
| projectId | string | no | The project id of the beacon to delete. If not provided, the project that is making the request is used. Optional. |

### Searches the beacon registry for beacons that match the given search criteria. Only those beacons that the…
`GET https://www.apizie.tech/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beacons-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageSize | integer | no | The maximum number of records to return for this request, up to a server-defined upper limit. |
| pageToken | string | no | A pagination token obtained from a previous request to list beacons. |
| projectId | string | no | The project id to list beacons under. If not present then the project credential that made the request is used as the project. Optional. |
| q | string | no | Filter query string that supports the following field filters: * **description:`" "`** For example: **description:"Room 3"** Returns… |

### Registers a previously unregistered beacon given its `advertisedId`. These IDs are unique within the system.…
`POST https://www.apizie.tech/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beacons-register` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| projectId | string | no | The project id of the project the beacon will be registered to. If the project id is not specified then the project making the request is… |
| body | object | yes | JSON request body |

### Deletes multiple attachments on a given beacon. This operation is permanent and cannot be undone. You can…
`POST https://www.apizie.tech/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beacons-attachments-batch-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| beaconName | string | yes | The beacon whose attachments should be deleted. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID… |
| namespacedType | string | no | Specifies the namespace and type of attachments to delete in `namespace/type` format. Accepts `*/*` to specify "all types in all… |
| projectId | string | no | The project id to delete beacon attachments under. This field can be used when "*" is specified to mean all attachment namespaces.… |

### Returns the attachments for the specified beacon that match the specified namespaced-type pattern. To…
`GET https://www.apizie.tech/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beacons-attachments-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| beaconName | string | yes | Beacon whose attachments should be fetched. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID… |
| namespacedType | string | no | Specifies the namespace and type of attachment to include in response in namespace/type format. Accepts `*/*` to specify "all types in all… |
| projectId | string | no | The project id to list beacon attachments under. This field can be used when "*" is specified to mean all attachment namespaces. Projects… |

### Associates the given data with the specified beacon. Attachment data must contain two parts: A namespaced…
`POST https://www.apizie.tech/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beacons-attachments-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| beaconName | string | yes | Beacon on which the attachment should be created. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID… |
| projectId | string | no | The project id of the project the attachment will belong to. If the project id is not specified then the project making the request is… |
| body | object | yes | JSON request body |

### Deletes the specified attachment for the given beacon. Each attachment has a unique attachment name…
`POST https://www.apizie.tech/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beacons-attachments-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| attachmentName | string | yes | The attachment name (`attachmentName`) of the attachment to remove. For example:… |
| projectId | string | no | The project id of the attachment to delete. If not provided, the project that is making the request is used. Optional. |

### List the diagnostics for a single beacon. You can also list diagnostics for all the beacons owned by your…
`GET https://www.apizie.tech/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beacons-diagnostics-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| alertFilter | string | no | Requests only beacons that have the given alert. For example, to find beacons that have low batteries use `alert_filter=LOW_BATTERY`. |
| beaconName | string | yes | Beacon that the diagnostics are for. |
| pageSize | integer | no | Specifies the maximum number of results to return. Defaults to 10. Maximum 1000. Optional. |
| pageToken | string | no | Requests results that occur after the `page_token`, obtained from the response to a previous request. Optional. |
| projectId | string | no | Requests only diagnostic records for the given project id. If not set, then the project making the request will be used for looking up… |

### Lists all attachment namespaces owned by your Google Developers Console project. Attachment data associated…
`GET https://www.apizie.tech/v1/analytics:googleapis-proximitybeacon/proximitybeacon-namespaces-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| projectId | string | no | The project id to list namespaces under. Optional. |

### Updates the information about the specified namespace. Only the namespace visibility can be updated.
`POST https://www.apizie.tech/v1/analytics:googleapis-proximitybeacon/proximitybeacon-namespaces-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespaceName | string | yes | Resource name of this namespace. Namespaces names have the format: namespaces/ namespace . |
| projectId | string | no | The project id of the namespace to update. If the project id is not specified then the project making the request is used. The project id… |
| body | object | yes | JSON request body |

### Gets the Proximity Beacon API's current public key and associated parameters used to initiate the…
`GET https://www.apizie.tech/v1/analytics:googleapis-proximitybeacon/proximitybeacon-get-eidparams` (byok)

## Example
```
curl "https://www.apizie.tech/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beaconinfo-getforobserved" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Proximity Beacon API API?
Create a free Apizie key, then send POST https://www.apizie.tech/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beaconinfo-getforobserved with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Proximity Beacon API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Proximity Beacon API itself also needs your own key from googleapis.com.

### Can AI agents use the Proximity Beacon API API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key analytics:googleapis-proximitybeacon.

### What is the status of the Proximity Beacon API API?
Needs your own provider key (bring your own key)