Take our developer survey. We want your feedback so we can learn how to improve Google Analytics, and make it an even better tool for you.

Unsampled Reports: insert

Requires authorization

Create a new unsampled report. See an example.

Request

HTTP request

POST https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/unsampledReports

Parameters

Parameter name Value Description
Path parameters
accountId string Account ID to create the unsampled report for.
profileId string View (Profile) ID to create the unsampled report for.
webPropertyId string Web property ID to create the unsampled report for.

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/analytics
https://www.googleapis.com/auth/analytics.edit

Request body

In the request body, supply a management.unsampledReport resource with the following properties:

Property name Value Description Notes
Required Properties
end-date string The end date for the unsampled report. writable
metrics string The metrics for the unsampled report. writable
start-date string The start date for the unsampled report. writable
title string Title of the unsampled report. writable
Optional Properties
dimensions string The dimensions for the unsampled report. writable
filters string The filters for the unsampled report. writable
segment string The segment for the unsampled report. writable

Response

If successful, this method returns a management.unsampledReport resource in the response body.

Examples

Note: The code examples available for this method do not represent all supported programming languages (see the client libraries page for a list of supported languages).

Java

Uses the Java client library.

/*
 * Note: This code assumes you have an authorized Analytics service object.
 * See the Unsampled Reports Developer Guide for details.
 */

/*
 * This example creates a new unsampled report.
 */
UnsampledReport body = new UnsampledReport();
body.setTitle("A test report");
body.setStartDate("2013-01-01");
body.setEndDate("2013-03-31");
body.setMetrics("ga:pageviews,ga:bounces");
body.setDimensions("ga:browser");
body.setFilters("ga:bounces>=100");
body.setSegment("gaid:-1");
try {
  analytics.management().unsampledReports().insert("123456",
      "UA-123456-1",
      "7654321",
      body
      ).execute();
} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}

PHP

Uses the PHP client library.

/**
 * Note: This code assumes you have an authorized Analytics service object.
 * See the Unsampled Reports Developer Guide for details.
 */

/**
 * This request creates a new Unsampled Report.
 */

// Construct an unsampled report object.
$unsampledReport = new Google_Service_Analytics_UnsampledReport();
$unsampledReport->setTitle('A test report');
$unsampledReport['start-date'] = '2013-01-01';
$unsampledReport['end-date'] = '2013-03-31';
$unsampledReport->setMetrics('ga:pageviews,ga:bounces');
$unsampledReport->setDimensions('ga:browser');
$unsampledReport->setFilters('ga:bounces>=100');
$unsampledReport->setSegment('gaid:-1');

try {
  $analytics->management_unsampledReports->insert('123456', 'UA-123456-1',
      '7654321', $unsampledReport);

} catch (apiServiceException $e) {
  print 'There was an Analytics API service error '
      . $e->getCode() . ':' . $e->getMessage();

} catch (apiException $e) {
  print 'There was a general API error '
      . $e->getCode() . ':' . $e->getMessage();
}

Python

Uses the Python client library.

# Note: This code assumes you have an authorized Analytics service object.
# See the Unsampled Reports Developer Guide for details.


# This request creates an new unsampled report.
try:
  reports = analytics.management().unsampledReports().insert(
      accountId='123456',
      webPropertyId='UA-123456-1',
      profileId='7654321',
      body={
          'title': 'A test Report',
          'start-date': '2013-01-01',
          'end-date': '2013-01-31',
          'metrics': 'ga:pageviews,ga:bounces',
          'dimensions': 'ga:browser',
          'filters': 'ga:bounces>=100',
          'segment': 'gaid::-1'
      }
  ).execute()

except TypeError, error:
  # Handle errors in constructing a query.
  print 'There was an error in constructing your query : %s' % error

except HttpError, error:
  # Handle API errors.
  print ('There was an API error : %s : %s' %
         (error.resp.status, error.resp.reason))

JavaScript

Uses the JavaScript client library.

/*
 * Note: This code assumes you have an authorized Analytics client object.
 * See the Unsampled Reports Developer Guide for details.
 */

/*
 * This request creates an new unsampled report.
 */
function insertView() {
  var request = gapi.client.analytics.management.unsampledReports.insert(
    {
      'accountId': '123456',
      'webPropertyId': 'UA-123456-1',
      'profileId': '7654321',
      'resource': {
        'title': 'A test Report',
        'start-date': '2013-01-01',
        'end-date': '2013-01-31',
        'metrics': 'ga:pageviews,ga:bounces',
        'dimensions': 'ga:browser',
        'filters': 'ga:bounces>=100',
        'segment': 'gaid::-1'
      }
    });
  request.execute(function (response) { /* Handle the response. */ });
}