1{
2 "auth": {
3 "oauth2": {
4 "scopes": {
5 "https://www.googleapis.com/auth/analytics": {
6 "description": "View and manage your Google Analytics data"
7 },
8 "https://www.googleapis.com/auth/analytics.readonly": {
9 "description": "View your Google Analytics data"
10 }
11 }
12 }
13 },
14 "basePath": "/analytics/v2.4/",
15 "baseUrl": "https://www.googleapis.com/analytics/v2.4/",
16 "batchPath": "batch/analytics/v2.4",
17 "description": "Views and manages your Google Analytics data.",
18 "discoveryVersion": "v1",
19 "documentationLink": "https://developers.google.com/analytics/",
20 "etag": "\"Zkyw9ACJZUvcYmlFaKGChzhmtnE/j99ovJ40xXU1DDsOEorHf8wh9w4\"",
21 "icons": {
22 "x16": "https://www.google.com/images/icons/product/analytics-16.png",
23 "x32": "https://www.google.com/images/icons/product/analytics-32.png"
24 },
25 "id": "analytics:v2.4",
26 "kind": "discovery#restDescription",
27 "name": "analytics",
28 "ownerDomain": "google.com",
29 "ownerName": "Google",
30 "parameters": {
31 "alt": {
32 "default": "atom",
33 "description": "Data format for the response.",
34 "enum": [
35 "atom"
36 ],
37 "enumDescriptions": [
38 "Responses with Content-Type of application/atom+xml"
39 ],
40 "location": "query",
41 "type": "string"
42 },
43 "fields": {
44 "description": "Selector specifying which fields to include in a partial response.",
45 "location": "query",
46 "type": "string"
47 },
48 "key": {
49 "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
50 "location": "query",
51 "type": "string"
52 },
53 "oauth_token": {
54 "description": "OAuth 2.0 token for the current user.",
55 "location": "query",
56 "type": "string"
57 },
58 "prettyPrint": {
59 "default": "false",
60 "description": "Returns response with indentations and line breaks.",
61 "location": "query",
62 "type": "boolean"
63 },
64 "quotaUser": {
65 "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
66 "location": "query",
67 "type": "string"
68 },
69 "userIp": {
70 "description": "Deprecated. Please use quotaUser instead.",
71 "location": "query",
72 "type": "string"
73 }
74 },
75 "protocol": "rest",
76 "resources": {
77 "data": {
78 "methods": {
79 "get": {
80 "description": "Returns Analytics report data for a view (profile).",
81 "httpMethod": "GET",
82 "id": "analytics.data.get",
83 "parameterOrder": [
84 "ids",
85 "start-date",
86 "end-date",
87 "metrics"
88 ],
89 "parameters": {
90 "dimensions": {
91 "description": "A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.",
92 "location": "query",
93 "pattern": "(ga:.+)?",
94 "type": "string"
95 },
96 "end-date": {
97 "description": "End date for fetching report data. All requests should specify an end date formatted as YYYY-MM-DD.",
98 "location": "query",
99 "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}",
100 "required": true,
101 "type": "string"
102 },
103 "filters": {
104 "description": "A comma-separated list of dimension or metric filters to be applied to the report data.",
105 "location": "query",
106 "pattern": "ga:.+",
107 "type": "string"
108 },
109 "ids": {
110 "description": "Unique table ID for retrieving report data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.",
111 "location": "query",
112 "pattern": "ga:[0-9]+",
113 "required": true,
114 "type": "string"
115 },
116 "max-results": {
117 "description": "The maximum number of entries to include in this feed.",
118 "format": "int32",
119 "location": "query",
120 "type": "integer"
121 },
122 "metrics": {
123 "description": "A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified to retrieve a valid Analytics report.",
124 "location": "query",
125 "pattern": "ga:.+",
126 "required": true,
127 "type": "string"
128 },
129 "segment": {
130 "description": "An Analytics advanced segment to be applied to the report data.",
131 "location": "query",
132 "type": "string"
133 },
134 "sort": {
135 "description": "A comma-separated list of dimensions or metrics that determine the sort order for the report data.",
136 "location": "query",
137 "pattern": "(-)?ga:.+",
138 "type": "string"
139 },
140 "start-date": {
141 "description": "Start date for fetching report data. All requests should specify a start date formatted as YYYY-MM-DD.",
142 "location": "query",
143 "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}",
144 "required": true,
145 "type": "string"
146 },
147 "start-index": {
148 "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
149 "format": "int32",
150 "location": "query",
151 "minimum": "1",
152 "type": "integer"
153 }
154 },
155 "path": "data",
156 "scopes": [
157 "https://www.googleapis.com/auth/analytics",
158 "https://www.googleapis.com/auth/analytics.readonly"
159 ]
160 }
161 }
162 },
163 "management": {
164 "resources": {
165 "accounts": {
166 "methods": {
167 "list": {
168 "description": "Lists all accounts to which the user has access.",
169 "httpMethod": "GET",
170 "id": "analytics.management.accounts.list",
171 "parameters": {
172 "max-results": {
173 "description": "The maximum number of accounts to include in this response.",
174 "format": "int32",
175 "location": "query",
176 "type": "integer"
177 },
178 "start-index": {
179 "description": "An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
180 "format": "int32",
181 "location": "query",
182 "minimum": "1",
183 "type": "integer"
184 }
185 },
186 "path": "management/accounts",
187 "scopes": [
188 "https://www.googleapis.com/auth/analytics",
189 "https://www.googleapis.com/auth/analytics.readonly"
190 ]
191 }
192 }
193 },
194 "goals": {
195 "methods": {
196 "list": {
197 "description": "Lists goals to which the user has access.",
198 "httpMethod": "GET",
199 "id": "analytics.management.goals.list",
200 "parameterOrder": [
201 "accountId",
202 "webPropertyId",
203 "profileId"
204 ],
205 "parameters": {
206 "accountId": {
207 "description": "Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.",
208 "location": "path",
209 "required": true,
210 "type": "string"
211 },
212 "max-results": {
213 "description": "The maximum number of goals to include in this response.",
214 "format": "int32",
215 "location": "query",
216 "type": "integer"
217 },
218 "profileId": {
219 "description": "View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to.",
220 "location": "path",
221 "required": true,
222 "type": "string"
223 },
224 "start-index": {
225 "description": "An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
226 "format": "int32",
227 "location": "query",
228 "minimum": "1",
229 "type": "integer"
230 },
231 "webPropertyId": {
232 "description": "Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.",
233 "location": "path",
234 "required": true,
235 "type": "string"
236 }
237 },
238 "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals",
239 "scopes": [
240 "https://www.googleapis.com/auth/analytics",
241 "https://www.googleapis.com/auth/analytics.readonly"
242 ]
243 }
244 }
245 },
246 "profiles": {
247 "methods": {
248 "list": {
249 "description": "Lists views (profiles) to which the user has access.",
250 "httpMethod": "GET",
251 "id": "analytics.management.profiles.list",
252 "parameterOrder": [
253 "accountId",
254 "webPropertyId"
255 ],
256 "parameters": {
257 "accountId": {
258 "description": "Account ID for the views (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access.",
259 "location": "path",
260 "required": true,
261 "type": "string"
262 },
263 "max-results": {
264 "description": "The maximum number of views (profiles) to include in this response.",
265 "format": "int32",
266 "location": "query",
267 "type": "integer"
268 },
269 "start-index": {
270 "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
271 "format": "int32",
272 "location": "query",
273 "minimum": "1",
274 "type": "integer"
275 },
276 "webPropertyId": {
277 "description": "Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access.",
278 "location": "path",
279 "required": true,
280 "type": "string"
281 }
282 },
283 "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles",
284 "scopes": [
285 "https://www.googleapis.com/auth/analytics",
286 "https://www.googleapis.com/auth/analytics.readonly"
287 ]
288 }
289 }
290 },
291 "segments": {
292 "methods": {
293 "list": {
294 "description": "Lists advanced segments to which the user has access.",
295 "httpMethod": "GET",
296 "id": "analytics.management.segments.list",
297 "parameters": {
298 "max-results": {
299 "description": "The maximum number of advanced segments to include in this response.",
300 "format": "int32",
301 "location": "query",
302 "type": "integer"
303 },
304 "start-index": {
305 "description": "An index of the first advanced segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
306 "format": "int32",
307 "location": "query",
308 "minimum": "1",
309 "type": "integer"
310 }
311 },
312 "path": "management/segments",
313 "scopes": [
314 "https://www.googleapis.com/auth/analytics",
315 "https://www.googleapis.com/auth/analytics.readonly"
316 ]
317 }
318 }
319 },
320 "webproperties": {
321 "methods": {
322 "list": {
323 "description": "Lists web properties to which the user has access.",
324 "httpMethod": "GET",
325 "id": "analytics.management.webproperties.list",
326 "parameterOrder": [
327 "accountId"
328 ],
329 "parameters": {
330 "accountId": {
331 "description": "Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.",
332 "location": "path",
333 "required": true,
334 "type": "string"
335 },
336 "max-results": {
337 "description": "The maximum number of web properties to include in this response.",
338 "format": "int32",
339 "location": "query",
340 "type": "integer"
341 },
342 "start-index": {
343 "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.",
344 "format": "int32",
345 "location": "query",
346 "minimum": "1",
347 "type": "integer"
348 }
349 },
350 "path": "management/accounts/{accountId}/webproperties",
351 "scopes": [
352 "https://www.googleapis.com/auth/analytics",
353 "https://www.googleapis.com/auth/analytics.readonly"
354 ]
355 }
356 }
357 }
358 }
359 }
360 },
361 "revision": "20180417",
362 "rootUrl": "https://www.googleapis.com/",
363 "servicePath": "analytics/v2.4/",
364 "title": "Google Analytics API",
365 "version": "v2.4"
366}View as plain text