Google Analytics Data API

    • Accessing report data in Google Analytics via the analyticsdata.googleapis.com service requires adherence to specific terms of service regarding the creation of accounts and projects to avoid termination.

    • Google recommends using their provided client libraries to call this service, though using your own libraries is an option with provided service information.

    • Discovery documents are available in v1beta and v1alpha versions to describe the REST APIs for building client libraries and tools.

    • The service endpoint for all relative URIs is https://analyticsdata.googleapis.com .

    • Various REST resources like v1beta.properties , v1beta.properties.audienceExports , and several v1alpha resources provide methods for accessing different types of Google Analytics report data and managing audience exports and lists.

    Accesses report data in Google Analytics. Warning: Creating multiple Customer Applications, Accounts, or Projects to simulate or act as a single Customer Application, Account, or Project (respectively) or to circumvent Service-specific usage limits or quotas is a direct violation of Google Cloud Platform Terms of Service as well as Google APIs Terms of Service. These actions can result in immediate termination of your GCP project(s) without any warning.

    Service: analyticsdata.googleapis.com

    To call this service, we recommend that you use the Google-provided client libraries . If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

    Discovery document

    A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:

    Service endpoint

    A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

    • https://analyticsdata.googleapis.com

    REST Resource: v1beta.properties

    Methods
    batch Run Pivot Reports POST /v1beta/{property=properties/*}:batchRunPivotReports
    Returns multiple pivot reports in a batch.
    batch Run Reports POST /v1beta/{property=properties/*}:batchRunReports
    Returns multiple reports in a batch.
    check Compatibility POST /v1beta/{property=properties/*}:checkCompatibility
    This compatibility method lists dimensions and metrics that can be added to a report request and maintain compatibility.
    get Metadata GET /v1beta/{name=properties/*/metadata}
    Returns metadata for dimensions and metrics available in reporting methods.
    run Pivot Report POST /v1beta/{property=properties/*}:runPivotReport
    Returns a customized pivot report of your Google Analytics event data.
    run Realtime Report POST /v1beta/{property=properties/*}:runRealtimeReport
    Returns a customized report of realtime event data for your property.
    run Report POST /v1beta/{property=properties/*}:runReport
    Returns a customized report of your Google Analytics event data.

    REST Resource: v1beta.properties.audienceExports

    Methods
    create POST /v1beta/{parent=properties/*}/audienceExports
    Creates an audience export for later retrieval.
    get GET /v1beta/{name=properties/*/audienceExports/*}
    Gets configuration metadata about a specific audience export.
    list GET /v1beta/{parent=properties/*}/audienceExports
    Lists all audience exports for a property.
    query POST /v1beta/{name=properties/*/audienceExports/*}:query
    Retrieves an audience export of users.

    REST Resource: v1alpha.properties

    Methods
    get Property Quotas Snapshot GET /v1alpha/{name=properties/*/propertyQuotasSnapshot}
    Get all property quotas organized by quota category for a given property.
    run Funnel Report POST /v1alpha/{property=properties/*}:runFunnelReport
    Returns a customized funnel report of your Google Analytics event data.

    REST Resource: v1alpha.properties.audienceLists

    Methods
    create POST /v1alpha/{parent=properties/*}/audienceLists
    Creates an audience list for later retrieval.
    get GET /v1alpha/{name=properties/*/audienceLists/*}
    Gets configuration metadata about a specific audience list.
    list GET /v1alpha/{parent=properties/*}/audienceLists
    Lists all audience lists for a property.
    query POST /v1alpha/{name=properties/*/audienceLists/*}:query
    Retrieves an audience list of users.

    REST Resource: v1alpha.properties.recurringAudienceLists

    Methods
    create POST /v1alpha/{parent=properties/*}/recurringAudienceLists
    Creates a recurring audience list.
    get GET /v1alpha/{name=properties/*/recurringAudienceLists/*}
    Gets configuration metadata about a specific recurring audience list.
    list GET /v1alpha/{parent=properties/*}/recurringAudienceLists
    Lists all recurring audience lists for a property.

    REST Resource: v1alpha.properties.reportTasks

    Methods
    create POST /v1alpha/{parent=properties/*}/reportTasks
    Initiates the creation of a report task.
    get GET /v1alpha/{name=properties/*/reportTasks/*}
    Gets report metadata about a specific report task.
    list GET /v1alpha/{parent=properties/*}/reportTasks
    Lists all report tasks for a property.
    query POST /v1alpha/{name=properties/*/reportTasks/*}:query
    Retrieves a report task's content.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: