Method: properties.runRealtimeReport

L'API Realtime di Google Analytics restituisce un report personalizzato di dati sugli eventi in tempo reale per la tua proprietà. Questi report mostrano gli eventi e l'utilizzo degli ultimi 30 minuti.

Richiesta HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runRealtimeReport

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
property

string

Un identificatore della proprietà GA4 di Google Analytics i cui eventi vengono monitorati. Specificato nel percorso dell'URL e non nel corpo. Per scoprire di più, scopri dove trovare il tuo ID proprietà.

Esempio: Properties/1234

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "limit": string,
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "returnPropertyQuota": boolean
}
Campi
dimensions[]

object (Dimension)

Le dimensioni richieste e visualizzate.

metrics[]

object (Metric)

Le metriche richieste e visualizzate.

limit

string (int64 format)

Il numero di righe da restituire. Se il parametro limit non viene specificato, vengono restituite 10.000 righe. L'API restituisce un massimo di 100.000 righe per richiesta, indipendentemente da quante ne hai richieste.

dimensionFilter

object (FilterExpression)

La clausola relativa al filtro per le dimensioni. È necessario richiedere l'utilizzo delle dimensioni in questo filtro. Le metriche non possono essere utilizzate in questo filtro.

metricFilter

object (FilterExpression)

La clausola di filtro delle metriche. Applicato nella fase di post-aggregazione, in modo simile alla clausola SQL. Le metriche devono essere richieste per essere utilizzate in questo filtro. Le dimensioni non possono essere utilizzate in questo filtro.

metricAggregations[]

enum (MetricAggregation)

Aggregazione di metriche. I valori delle metriche aggregati verranno mostrati nelle righe in cui i valori dimensionValues sono impostati su "RESERVED_(MetricAggregation)".

orderBys[]

object (OrderBy)

Specifica l'ordine delle righe nella risposta.

returnPropertyQuota

boolean

Consente di attivare/disattivare la restituzione dello stato corrente della quota in tempo reale di questa proprietà Analytics. La quota viene restituita in PropertyQuota.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

La tabella del report in tempo reale sulle risposte corrispondente a una richiesta.

Rappresentazione JSON
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "propertyQuota": {
    object (PropertyQuota)
  }
}
Campi
dimensionHeaders[]

object (DimensionHeader)

Descrive le colonne delle dimensioni. Il numero di DimensionHeaders e l'ordine di DimensionHeaders corrisponde alle dimensioni presenti nelle righe.

metricHeaders[]

object (MetricHeader)

Descrive le colonne delle metriche. Il numero di MetricHeaders e l'ordine di MetricHeaders corrisponde alle metriche presenti nelle righe.

rows[]

object (Row)

Righe di combinazioni di valori di dimensioni e valori delle metriche nel report.

totals[]

object (Row)

Se richiesto, i valori totali delle metriche.

maximums[]

object (Row)

Se richiesto, i valori massimi delle metriche.

minimums[]

object (Row)

Se richiesti, i valori minimi delle metriche.

rowCount

integer

Il numero totale di righe nel risultato della query, indipendentemente dal numero di righe restituite nella risposta. Ad esempio, se una query restituisce 175 righe e include un limite = 50 nella richiesta API, la risposta conterrà rowCount = 175 ma solo 50 righe.

propertyQuota

object (PropertyQuota)

Lo stato della quota in tempo reale di questa proprietà Analytics, inclusa questa richiesta.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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