| 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.mcf.html">mcf</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 78 | <code><a href="#get">get(ids, start_date, end_date, metrics, filters=None, sort=None, max_results=None, start_index=None, samplingLevel=None, dimensions=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 79 | <p class="firstline">Returns Analytics Multi-Channel Funnels data for a view (profile).</p> |
| 80 | <h3>Method Details</h3> |
| 81 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 82 | <code class="details" id="get">get(ids, start_date, end_date, metrics, filters=None, sort=None, max_results=None, start_index=None, samplingLevel=None, dimensions=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 83 | <pre>Returns Analytics Multi-Channel Funnels 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. 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) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 89 | metrics: string, A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric must be specified. (required) |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 90 | filters: string, A comma-separated list of dimension or metric filters to be applied to the Analytics data. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 91 | sort: string, A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 92 | max_results: integer, The maximum number of entries to include in this feed. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 93 | start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 94 | samplingLevel: string, The desired sampling level. |
| 95 | Allowed values |
| 96 | DEFAULT - Returns response with a sample size that balances speed and accuracy. |
| 97 | FASTER - Returns a fast response with a smaller sample size. |
| 98 | HIGHER_PRECISION - Returns a more accurate response using a large sample size, but this may result in the response being slower. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 99 | dimensions: string, A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 100 | |
| 101 | Returns: |
| 102 | An object of the form: |
| 103 | |
| 104 | { # Multi-Channel Funnels data for a given view (profile). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 105 | "totalResults": 42, # The total number of rows for the query, regardless of the number of rows in the response. |
| 106 | "sampleSpace": "A String", # Total size of the sample space from which the samples were selected. |
| 107 | "selfLink": "A String", # Link to this page. |
| 108 | "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. |
| 109 | "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. |
| 110 | }, |
| 111 | "profileInfo": { # Information for the view (profile), for which the Analytics data was requested. |
| 112 | "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. |
| 113 | "tableId": "A String", # Table ID for view (profile). |
| 114 | "profileName": "A String", # View (Profile) name. |
| 115 | "webPropertyId": "A String", # Web Property ID to which this view (profile) belongs. |
| 116 | "accountId": "A String", # Account ID to which this view (profile) belongs. |
| 117 | "profileId": "A String", # View (Profile) ID. |
| 118 | }, |
| 119 | "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. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 120 | [ |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 121 | { # A union object representing a dimension or metric value. Only one of "primitiveValue" or "conversionPathValue" attribute will be populated. |
| 122 | "conversionPathValue": [ # A conversion path dimension value, containing a list of interactions with their attributes. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 123 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 124 | "interactionType": "A String", # Type of an interaction on conversion path. Such as CLICK, IMPRESSION etc. |
| 125 | "nodeValue": "A String", # Node value of an interaction on conversion path. Such as source, medium etc. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 126 | }, |
| 127 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 128 | "primitiveValue": "A String", # A primitive dimension value. A primitive metric value. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 129 | }, |
| 130 | ], |
| 131 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 132 | "kind": "analytics#mcfData", # Resource type. |
| 133 | "sampleSize": "A String", # The number of samples used to calculate the result. |
| 134 | "containsSampledData": True or False, # Determines if the Analytics data contains sampled data. |
| 135 | "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. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 136 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 137 | "dataType": "A String", # Data type. Dimension and metric values data types such as INTEGER, DOUBLE, CURRENCY, MCF_SEQUENCE etc. |
| 138 | "columnType": "A String", # Column Type. Either DIMENSION or METRIC. |
| 139 | "name": "A String", # Column name. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 140 | }, |
| 141 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 142 | "id": "A String", # Unique ID for this data response. |
| 143 | "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. |
| 144 | "query": { # Analytics data request query parameters. |
| 145 | "sort": [ # List of dimensions or metrics based on which Analytics data is sorted. |
| 146 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 147 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 148 | "max-results": 42, # Maximum results per page. |
| 149 | "metrics": [ # List of analytics metrics. |
| 150 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 151 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 152 | "segment": "A String", # Analytics advanced segment. |
| 153 | "start-date": "A String", # Start date. |
| 154 | "start-index": 42, # Start index. |
| 155 | "ids": "A String", # Unique table ID. |
| 156 | "samplingLevel": "A String", # Desired sampling level |
| 157 | "dimensions": "A String", # List of analytics dimensions. |
| 158 | "end-date": "A String", # End date. |
| 159 | "filters": "A String", # Comma-separated list of dimension or metric filters. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 160 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 161 | "nextLink": "A String", # Link to next page for this Analytics data query. |
| 162 | "previousLink": "A String", # Link to previous page for this Analytics data query. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 163 | }</pre> |
| 164 | </div> |
| 165 | |
| 166 | </body></html> |