{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beaconinfo-getforobserved":{"post":{"operationId":"analytics_googleapis_proximitybeacon_proximitybeacon_beaconinfo_getforobserved","summary":"Given one or more beacon observations, returns any beacon information and attachments accessible to your…","description":"POST /v1beta1/beaconinfo:getforobserved","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beacons-activate":{"post":{"operationId":"analytics_googleapis_proximitybeacon_proximitybeacon_beacons_activate","summary":"Activates a beacon. A beacon that is active will return information and attachment data when queried via…","description":"POST /v1beta1/{+beaconName}:activate","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["beaconName"],"properties":{"beaconName":{"type":"string","description":"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":{"type":"string","description":"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…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beacons-deactivate":{"post":{"operationId":"analytics_googleapis_proximitybeacon_proximitybeacon_beacons_deactivate","summary":"Deactivates a beacon. Once deactivated, the API will not return information nor attachment data for the…","description":"POST /v1beta1/{+beaconName}:deactivate","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["beaconName"],"properties":{"beaconName":{"type":"string","description":"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":{"type":"string","description":"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…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beacons-decommission":{"post":{"operationId":"analytics_googleapis_proximitybeacon_proximitybeacon_beacons_decommission","summary":"Decommissions the specified beacon in the service. This beacon will no longer be returned from…","description":"POST /v1beta1/{+beaconName}:decommission","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["beaconName"],"properties":{"beaconName":{"type":"string","description":"Beacon that should be decommissioned. A beacon name has the format \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by…"},"projectId":{"type":"string","description":"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…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beacons-get":{"get":{"operationId":"analytics_googleapis_proximitybeacon_proximitybeacon_beacons_get","summary":"Returns detailed information about the specified beacon. Authenticate using an [OAuth access…","description":"GET /v1beta1/{+beaconName}","tags":["analytics"],"parameters":[{"name":"beaconName","in":"query","required":true,"description":"Resource name of this beacon. A beacon name has the format \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by the…","schema":{"type":"string","description":"Resource name of this beacon. A beacon name has the format \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by the…"}},{"name":"projectId","in":"query","required":false,"description":"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…","schema":{"type":"string","description":"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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beacons-update":{"post":{"operationId":"analytics_googleapis_proximitybeacon_proximitybeacon_beacons_update","summary":"Updates the information about the specified beacon. **Any field that you do not populate in the submitted…","description":"PUT /v1beta1/{+beaconName}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["beaconName","body"],"properties":{"beaconName":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beacons-delete":{"post":{"operationId":"analytics_googleapis_proximitybeacon_proximitybeacon_beacons_delete","summary":"Deletes the specified beacon including all diagnostics data for the beacon as well as any attachments on the…","description":"DELETE /v1beta1/{+beaconName}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["beaconName"],"properties":{"beaconName":{"type":"string","description":"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":{"type":"string","description":"The project id of the beacon to delete. If not provided, the project that is making the request is used. Optional."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beacons-list":{"get":{"operationId":"analytics_googleapis_proximitybeacon_proximitybeacon_beacons_list","summary":"Searches the beacon registry for beacons that match the given search criteria. Only those beacons that the…","description":"GET /v1beta1/beacons","tags":["analytics"],"parameters":[{"name":"pageSize","in":"query","required":false,"description":"The maximum number of records to return for this request, up to a server-defined upper limit.","schema":{"type":"integer","description":"The maximum number of records to return for this request, up to a server-defined upper limit."}},{"name":"pageToken","in":"query","required":false,"description":"A pagination token obtained from a previous request to list beacons.","schema":{"type":"string","description":"A pagination token obtained from a previous request to list beacons."}},{"name":"projectId","in":"query","required":false,"description":"The project id to list beacons under. If not present then the project credential that made the request is used as the project. Optional.","schema":{"type":"string","description":"The project id to list beacons under. If not present then the project credential that made the request is used as the project. Optional."}},{"name":"q","in":"query","required":false,"description":"Filter query string that supports the following field filters: * **description:`\" \"`** For example: **description:\"Room 3\"** Returns…","schema":{"type":"string","description":"Filter query string that supports the following field filters: * **description:`\" \"`** For example: **description:\"Room 3\"** Returns…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beacons-register":{"post":{"operationId":"analytics_googleapis_proximitybeacon_proximitybeacon_beacons_register","summary":"Registers a previously unregistered beacon given its `advertisedId`. These IDs are unique within the system.…","description":"POST /v1beta1/beacons:register","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"projectId":{"type":"string","description":"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":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beacons-attachments-batch-delete":{"post":{"operationId":"analytics_googleapis_proximitybeacon_proximitybeacon_beacons_attachments_batch_delete","summary":"Deletes multiple attachments on a given beacon. This operation is permanent and cannot be undone. You can…","description":"POST /v1beta1/{+beaconName}/attachments:batchDelete","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["beaconName"],"properties":{"beaconName":{"type":"string","description":"The beacon whose attachments should be deleted. A beacon name has the format \"beacons/N!beaconId\" where the beaconId is the base16 ID…"},"namespacedType":{"type":"string","description":"Specifies the namespace and type of attachments to delete in `namespace/type` format. Accepts `*/*` to specify \"all types in all…"},"projectId":{"type":"string","description":"The project id to delete beacon attachments under. This field can be used when \"*\" is specified to mean all attachment namespaces.…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beacons-attachments-list":{"get":{"operationId":"analytics_googleapis_proximitybeacon_proximitybeacon_beacons_attachments_list","summary":"Returns the attachments for the specified beacon that match the specified namespaced-type pattern. To…","description":"GET /v1beta1/{+beaconName}/attachments","tags":["analytics"],"parameters":[{"name":"beaconName","in":"query","required":true,"description":"Beacon whose attachments should be fetched. A beacon name has the format \"beacons/N!beaconId\" where the beaconId is the base16 ID…","schema":{"type":"string","description":"Beacon whose attachments should be fetched. A beacon name has the format \"beacons/N!beaconId\" where the beaconId is the base16 ID…"}},{"name":"namespacedType","in":"query","required":false,"description":"Specifies the namespace and type of attachment to include in response in namespace/type format. Accepts `*/*` to specify \"all types in all…","schema":{"type":"string","description":"Specifies the namespace and type of attachment to include in response in namespace/type format. Accepts `*/*` to specify \"all types in all…"}},{"name":"projectId","in":"query","required":false,"description":"The project id to list beacon attachments under. This field can be used when \"*\" is specified to mean all attachment namespaces. Projects…","schema":{"type":"string","description":"The project id to list beacon attachments under. This field can be used when \"*\" is specified to mean all attachment namespaces. Projects…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beacons-attachments-create":{"post":{"operationId":"analytics_googleapis_proximitybeacon_proximitybeacon_beacons_attachments_create","summary":"Associates the given data with the specified beacon. Attachment data must contain two parts: A namespaced…","description":"POST /v1beta1/{+beaconName}/attachments","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["beaconName","body"],"properties":{"beaconName":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beacons-attachments-delete":{"post":{"operationId":"analytics_googleapis_proximitybeacon_proximitybeacon_beacons_attachments_delete","summary":"Deletes the specified attachment for the given beacon. Each attachment has a unique attachment name…","description":"DELETE /v1beta1/{+attachmentName}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["attachmentName"],"properties":{"attachmentName":{"type":"string","description":"The attachment name (`attachmentName`) of the attachment to remove. For example:…"},"projectId":{"type":"string","description":"The project id of the attachment to delete. If not provided, the project that is making the request is used. Optional."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-proximitybeacon/proximitybeacon-beacons-diagnostics-list":{"get":{"operationId":"analytics_googleapis_proximitybeacon_proximitybeacon_beacons_diagnostics_list","summary":"List the diagnostics for a single beacon. You can also list diagnostics for all the beacons owned by your…","description":"GET /v1beta1/{+beaconName}/diagnostics","tags":["analytics"],"parameters":[{"name":"alertFilter","in":"query","required":false,"description":"Requests only beacons that have the given alert. For example, to find beacons that have low batteries use `alert_filter=LOW_BATTERY`.","schema":{"type":"string","enum":["ALERT_UNSPECIFIED","WRONG_LOCATION","LOW_BATTERY","LOW_ACTIVITY"],"description":"Requests only beacons that have the given alert. For example, to find beacons that have low batteries use `alert_filter=LOW_BATTERY`."}},{"name":"beaconName","in":"query","required":true,"description":"Beacon that the diagnostics are for.","schema":{"type":"string","description":"Beacon that the diagnostics are for."}},{"name":"pageSize","in":"query","required":false,"description":"Specifies the maximum number of results to return. Defaults to 10. Maximum 1000. Optional.","schema":{"type":"integer","description":"Specifies the maximum number of results to return. Defaults to 10. Maximum 1000. Optional."}},{"name":"pageToken","in":"query","required":false,"description":"Requests results that occur after the `page_token`, obtained from the response to a previous request. Optional.","schema":{"type":"string","description":"Requests results that occur after the `page_token`, obtained from the response to a previous request. Optional."}},{"name":"projectId","in":"query","required":false,"description":"Requests only diagnostic records for the given project id. If not set, then the project making the request will be used for looking up…","schema":{"type":"string","description":"Requests only diagnostic records for the given project id. If not set, then the project making the request will be used for looking up…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-proximitybeacon/proximitybeacon-namespaces-list":{"get":{"operationId":"analytics_googleapis_proximitybeacon_proximitybeacon_namespaces_list","summary":"Lists all attachment namespaces owned by your Google Developers Console project. Attachment data associated…","description":"GET /v1beta1/namespaces","tags":["analytics"],"parameters":[{"name":"projectId","in":"query","required":false,"description":"The project id to list namespaces under. Optional.","schema":{"type":"string","description":"The project id to list namespaces under. Optional."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-proximitybeacon/proximitybeacon-namespaces-update":{"post":{"operationId":"analytics_googleapis_proximitybeacon_proximitybeacon_namespaces_update","summary":"Updates the information about the specified namespace. Only the namespace visibility can be updated.","description":"PUT /v1beta1/{+namespaceName}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["namespaceName","body"],"properties":{"namespaceName":{"type":"string","description":"Resource name of this namespace. Namespaces names have the format: namespaces/ namespace ."},"projectId":{"type":"string","description":"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":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-proximitybeacon/proximitybeacon-get-eidparams":{"get":{"operationId":"analytics_googleapis_proximitybeacon_proximitybeacon_get_eidparams","summary":"Gets the Proximity Beacon API's current public key and associated parameters used to initiate the…","description":"GET /v1beta1/eidparams","tags":["analytics"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}