| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.data.html">data</a> . <a href="analytics_v3.data.ga.html">ga</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 78 | <code><a href="#get">get(ids, start_date, end_date, metrics, sort=None, filters=None, samplingLevel=None, dimensions=None, max_results=None, output=None, segment=None, start_index=None, include_empty_rows=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 79 | <p class="firstline">Returns Analytics data for a view (profile).</p> |
| 80 | <h3>Method Details</h3> |
| 81 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 82 | <code class="details" id="get">get(ids, start_date, end_date, metrics, sort=None, filters=None, samplingLevel=None, dimensions=None, max_results=None, output=None, segment=None, start_index=None, include_empty_rows=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 83 | <pre>Returns Analytics data for a view (profile). |
| 84 | |
| 85 | Args: |
| 86 | ids: string, Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. (required) |
| 87 | start_date: string, Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo. (required) |
| 88 | end_date: string, End date for fetching Analytics data. Request can should specify an end date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is yesterday. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 89 | metrics: string, A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 90 | sort: string, A comma-separated list of dimensions or metrics that determine the sort order for Analytics data. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 91 | filters: string, A comma-separated list of dimension or metric filters to be applied to Analytics data. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 92 | samplingLevel: string, The desired sampling level. |
| 93 | Allowed values |
| 94 | DEFAULT - Returns response with a sample size that balances speed and accuracy. |
| 95 | FASTER - Returns a fast response with a smaller sample size. |
| 96 | HIGHER_PRECISION - Returns a more accurate response using a large sample size, but this may result in the response being slower. |
| 97 | dimensions: string, A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 98 | max_results: integer, The maximum number of entries to include in this feed. |
| 99 | output: string, The selected format for the response. Default format is JSON. |
| 100 | Allowed values |
| 101 | dataTable - Returns the response in Google Charts Data Table format. This is useful in creating visualization using Google Charts. |
| 102 | json - Returns the response in standard JSON format. |
| 103 | segment: string, An Analytics segment to be applied to data. |
| 104 | start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
| 105 | include_empty_rows: boolean, The response will include empty rows if this parameter is set to true, the default is true |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 106 | |
| 107 | Returns: |
| 108 | An object of the form: |
| 109 | |
| 110 | { # Analytics data for a given view (profile). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 111 | "sampleSize": "A String", # The number of samples used to calculate the result. |
| 112 | "itemsPerPage": 42, # The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. |
| 113 | "query": { # Analytics data request query parameters. |
| 114 | "filters": "A String", # Comma-separated list of dimension or metric filters. |
| 115 | "ids": "A String", # Unique table ID. |
| 116 | "samplingLevel": "A String", # Desired sampling level |
| 117 | "dimensions": "A String", # List of analytics dimensions. |
| 118 | "max-results": 42, # Maximum results per page. |
| 119 | "segment": "A String", # Analytics advanced segment. |
| 120 | "start-date": "A String", # Start date. |
| 121 | "metrics": [ # List of analytics metrics. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 122 | "A String", |
| 123 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 124 | "end-date": "A String", # End date. |
| 125 | "sort": [ # List of dimensions or metrics based on which Analytics data is sorted. |
| 126 | "A String", |
| 127 | ], |
| 128 | "start-index": 42, # Start index. |
| 129 | }, |
| 130 | "selfLink": "A String", # Link to this page. |
| 131 | "dataLastRefreshed": "A String", # The last refreshed time in seconds for Analytics data. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 132 | "profileInfo": { # Information for the view (profile), for which the Analytics data was requested. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 133 | "accountId": "A String", # Account ID to which this view (profile) belongs. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 134 | "webPropertyId": "A String", # Web Property ID to which this view (profile) belongs. |
| 135 | "profileName": "A String", # View (Profile) name. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 136 | "profileId": "A String", # View (Profile) ID. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 137 | "tableId": "A String", # Table ID for view (profile). |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 138 | "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. |
| 139 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 140 | "totalResults": 42, # The total number of rows for the query, regardless of the number of rows in the response. |
| 141 | "id": "A String", # Unique ID for this data response. |
| 142 | "nextLink": "A String", # Link to next page for this Analytics data query. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 143 | "kind": "analytics#gaData", # Resource type. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 144 | "sampleSpace": "A String", # Total size of the sample space from which the samples were selected. |
| 145 | "columnHeaders": [ # Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request. |
| 146 | { |
| 147 | "name": "A String", # Column name. |
| 148 | "dataType": "A String", # 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. |
| 149 | "columnType": "A String", # Column Type. Either DIMENSION or METRIC. |
| 150 | }, |
| 151 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 152 | "dataTable": { |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 153 | "rows": [ |
| 154 | { |
| 155 | "c": [ |
| 156 | { |
| 157 | "v": "A String", |
| 158 | }, |
| 159 | ], |
| 160 | }, |
| 161 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 162 | "cols": [ |
| 163 | { |
| 164 | "label": "A String", |
| 165 | "type": "A String", |
| 166 | "id": "A String", |
| 167 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 168 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 169 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 170 | "containsSampledData": True or False, # Determines if Analytics data contains samples. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 171 | "totalsForAllResults": { # 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. |
| 172 | "a_key": "A String", # 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. |
| 173 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 174 | "rows": [ # Analytics 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. |
| 175 | [ |
| 176 | "A String", |
| 177 | ], |
| 178 | ], |
| 179 | "previousLink": "A String", # Link to previous page for this Analytics data query. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 180 | }</pre> |
| 181 | </div> |
| 182 | |
| 183 | </body></html> |