Method: beacons.diagnostics.list

List 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 name beacons/-.

Authenticate using an OAuth access token from a signed-in user with viewer, Is owner or Can edit permissions in the Google Developers Console project.

HTTP request

GET https://proximitybeacon.googleapis.com/v1beta1/{beaconName=beacons/*}/diagnostics

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
beaconName

string

Beacon that the diagnostics are for.

Query parameters

Parameters
pageSize

number

Specifies the maximum number of results to return. Defaults to 10. Maximum 1000. Optional.

pageToken

string

Requests results that occur after the pageToken, obtained from the response to a previous request. Optional.

alertFilter

enum(Alert)

Requests only beacons that have the given alert. For example, to find beacons that have low batteries use alertFilter=LOW_BATTERY.

projectId

string

Requests only diagnostic records for the given project id. If not set, then the project making the request will be used for looking up diagnostic records. Optional.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response that contains the requested diagnostics.

JSON representation
{
  "diagnostics": [
    {
      object(Diagnostics)
    }
  ],
  "nextPageToken": string,
}
Fields
diagnostics[]

object(Diagnostics)

The diagnostics matching the given request.

nextPageToken

string

Token that can be used for pagination. Returned only if the request matches more beacons than can be returned in this response.

Authorization

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/userlocation.beacon.registry

For more information, see the Auth Guide.