Method: properties.dataStreams.list

  • This document provides details on how to list DataStreams on a property using an HTTP GET request.

  • The request requires a parent path parameter specifying the property, and can optionally include pageSize and pageToken query parameters for pagination.

  • The request body must be empty.

  • The response body contains a list of DataStreams and an optional nextPageToken for subsequent pages.

  • The request requires either the analytics.readonly or analytics.edit authorization scope.

Lists DataStreams on a property.

HTTP request

GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/dataStreams

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Example format: properties/1234

Query parameters

Parameters
pageSize

integer

The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).

pageToken

string

A page token, received from a previous dataStreams.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to dataStreams.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

Response message for dataStreams.list RPC.

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

JSON representation
{
  "dataStreams": [
    {
      object (DataStream)
    }
  ],
  "nextPageToken": string
}
Fields
dataStreams[]

object (DataStream)

List of DataStreams.

nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit