/data/realtime - Google Analytics API

Returns real time data for a view (profile).

{ "columnHeaders": [ { "columnType": "string", "dataType": "string", "name": "string" } ], "id": "string", "kind": "analytics#realtimeData", "profileInfo": { "accountId": "string", "internalWebPropertyId": "string", "profileId": "string", "profileName": "string", "tableId": "string", "webPropertyId": "string" }, "query": { "dimensions": "string", "filters": "string", "ids": "string", "max-results": 0, "metrics": [ "string" ], "sort": [ "string" ] }, "rows": [ [ "string" ] ], "selfLink": "string", "totalResults": 0, "totalsForAllResults": { "property1": "string", "property2": "string" } }

Request

Query Params

ids

string

required

Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.

metrics

string

required

A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified.

dimensions

string

optional

A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'.

filters

string

optional

A comma-separated list of dimension or metric filters to be applied to real time data.

max-results

integer

optional

The maximum number of entries to include in this feed.

sort

string

optional

A comma-separated list of dimensions or metrics that determine the sort order for real time data.

Responses

🟢200Successful response

application/json

Body

Real time data for a given view (profile).

columnHeaders

array [object {3}]

optional

Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.

columnType

string

optional

Column Type. Either DIMENSION or METRIC.

dataType

string

optional

Data type. Dimension column headers have only STRING as the data type. Metric column headers have data types for metric values such as INTEGER, DOUBLE, CURRENCY etc.

name

string

optional

Column name.

string

optional

Unique ID for this data response.

kind

string

optional

Resource type.

Default:

analytics#realtimeData

profileInfo

object

optional

Information for the view (profile), for which the real time data was requested.

accountId

string

optional

Account ID to which this view (profile) belongs.

internalWebPropertyId

string

optional

Internal ID for the web property to which this view (profile) belongs.

profileId

string

optional

View (Profile) ID.

profileName

string

optional

View (Profile) name.

tableId

string

optional

Table ID for view (profile).

webPropertyId

string

optional

Web Property ID to which this view (profile) belongs.

query

object

optional

Real time data request query parameters.

dimensions

string

optional

List of real time dimensions.

filters

string

optional

Comma-separated list of dimension or metric filters.

ids

string

optional

Unique table ID.

max-results

integer <int32>

optional

Maximum results per page.

metrics

array[string]

optional

List of real time metrics.

sort

array[string]

optional

List of dimensions or metrics based on which real time data is sorted.

rows

array [array]

optional

Real time data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.

string

optional

selfLink

string

optional

Link to this page.

totalResults

integer <int32>

optional

The total number of rows for the query, regardless of the number of rows in the response.

totalsForAllResults

object

optional

Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.

Additional properties

string

optional

Key-value pair for the total value of a metric. Key is the metric name and the value is the total value for that metric.