{
  "opencollection": "1.0.0",
  "info": {
    "name": "Google Analytics Data API",
    "version": "v1alpha"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "properties",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Returns metadata for dimensions and metrics available in reporting methods",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://analyticsdata.googleapis.com/v1alpha/properties/:propertiesId/metadata",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Required. The resource name of the metadata to retrieve. This name field is specified in the URL path and not URL parameters. Property is a numeric Google Analytics property identifier. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Example: properties/1234/metadata Set the Property ID to 0 for dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics."
              },
              {
                "name": "propertiesId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth",
              "accessTokenUrl": "https://oauth2.googleapis.com/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics property identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata. For example if a custom metric with parameter name `levels_unlocked` is registered to a property, the Metadata response will contain `customEvent:levels_unlocked`. Universal metadata are dimensions an"
        },
        {
          "info": {
            "name": "Get all property quotas organized by quota category for a given property",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://analyticsdata.googleapis.com/v1alpha/properties/:propertiesId/propertyQuotasSnapshot",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Required. Quotas from this property will be listed in the response. Format: `properties/{property}/propertyQuotasSnapshot`"
              },
              {
                "name": "propertiesId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth",
              "accessTokenUrl": "https://oauth2.googleapis.com/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Get all property quotas organized by quota category for a given property. This will charge 1 property quota from the category with the most quota."
        },
        {
          "info": {
            "name": "Returns a customized funnel report of your Google Analytics event data",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://analyticsdata.googleapis.com/v1alpha/properties/:propertiesId:runFunnelReport",
            "params": [
              {
                "name": "property",
                "value": "",
                "type": "query",
                "description": "Optional. A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234"
              },
              {
                "name": "propertiesId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth",
              "accessTokenUrl": "https://oauth2.googleapis.com/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns a customized funnel report of your Google Analytics event data. The data returned from the API is as a table with columns for the requested dimensions and metrics. Funnel exploration lets you visualize the steps your users take to complete a task and quickly see how well they are succeeding or failing at each step. For example, how do prospects become shoppers and then become buyers? How do one time buyers become repeat buyers? With this information, you can improve inefficient or abando"
        },
        {
          "info": {
            "name": "Returns a customized report of your Google Analytics event data",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://analyticsdata.googleapis.com/v1alpha/properties/:propertiesId:runReport",
            "params": [
              {
                "name": "property",
                "value": "",
                "type": "query",
                "description": "Required. A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234"
              },
              {
                "name": "propertiesId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth",
              "accessTokenUrl": "https://oauth2.googleapis.com/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a table with columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on your property, such as active users or event count. Dimensions break down metrics across some common criteria, such as country or event name."
        },
        {
          "info": {
            "name": "Lists all audience lists for a property",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://analyticsdata.googleapis.com/v1alpha/properties/:propertiesId/audienceLists",
            "params": [
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Optional. The maximum number of audience lists to return. The service may return fewer than this value. If unspecified, at most 200 audience lists will be returned. The maximum value is 1000 (higher values will be coerced to the maximum)."
              },
              {
                "name": "pageToken",
                "value": "",
                "type": "query",
                "description": "Optional. A page token, received from a previous `ListAudienceLists` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAudienceLists` must match the call that provided the page token."
              },
              {
                "name": "parent",
                "value": "",
                "type": "query",
                "description": "Required. All audience lists for this property will be listed in the response. Format: `properties/{property}`"
              },
              {
                "name": "propertiesId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth",
              "accessTokenUrl": "https://oauth2.googleapis.com/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Lists all audience lists for a property. This method can be used for you to find and reuse existing audience lists rather than creating unnecessary new audience lists. The same audience can have multiple audience lists that represent the list of users that were in an audience on different days. See [Creating an Audience List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Lists with examples. This method is available at b"
        },
        {
          "info": {
            "name": "Creates an audience list for later retrieval",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://analyticsdata.googleapis.com/v1alpha/properties/:propertiesId/audienceLists",
            "params": [
              {
                "name": "parent",
                "value": "",
                "type": "query",
                "description": "Required. The parent resource where this audience list will be created. Format: `properties/{property}`"
              },
              {
                "name": "propertiesId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth",
              "accessTokenUrl": "https://oauth2.googleapis.com/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Creates an audience list for later retrieval. This method quickly returns the audience list's resource name and initiates a long running asynchronous request to form an audience list. To list the users in an audience list, first create the audience list through this method and then send the audience resource name to the `QueryAudienceList` method. See [Creating an Audience List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audie"
        },
        {
          "info": {
            "name": "Gets configuration metadata about a specific audience list",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://analyticsdata.googleapis.com/v1alpha/properties/:propertiesId/audienceLists/:audienceListsId",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Required. The audience list resource name. Format: `properties/{property}/audienceLists/{audience_list}`"
              },
              {
                "name": "audienceListsId",
                "value": "",
                "type": "path"
              },
              {
                "name": "propertiesId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth",
              "accessTokenUrl": "https://oauth2.googleapis.com/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Gets configuration metadata about a specific audience list. This method can be used to understand an audience list after it has been created. See [Creating an Audience List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Lists with examples. This method is available at beta stability at [audienceExports.get](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties.audienceExports/get). To"
        },
        {
          "info": {
            "name": "Retrieves an audience list of users",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://analyticsdata.googleapis.com/v1alpha/properties/:propertiesId/audienceLists/:audienceListsId:query",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Required. The name of the audience list to retrieve users from. Format: `properties/{property}/audienceLists/{audience_list}`"
              },
              {
                "name": "audienceListsId",
                "value": "",
                "type": "path"
              },
              {
                "name": "propertiesId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth",
              "accessTokenUrl": "https://oauth2.googleapis.com/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Retrieves an audience list of users. After creating an audience, the users are not immediately available for listing. First, a request to `CreateAudienceList` is necessary to create an audience list of users, and then second, this method is used to retrieve the users in the audience list. See [Creating an Audience List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Lists with examples. Audiences in Google Analytics 4 all"
        },
        {
          "info": {
            "name": "Lists all recurring audience lists for a property",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://analyticsdata.googleapis.com/v1alpha/properties/:propertiesId/recurringAudienceLists",
            "params": [
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Optional. The maximum number of recurring audience lists to return. The service may return fewer than this value. If unspecified, at most 200 recurring audience lists will be returned. The maximum value is 1000 (higher values will be coerced to the maximum)."
              },
              {
                "name": "pageToken",
                "value": "",
                "type": "query",
                "description": "Optional. A page token, received from a previous `ListRecurringAudienceLists` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRecurringAudienceLists` must match the call that provided the page token."
              },
              {
                "name": "parent",
                "value": "",
                "type": "query",
                "description": "Required. All recurring audience lists for this property will be listed in the response. Format: `properties/{property}`"
              },
              {
                "name": "propertiesId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth",
              "accessTokenUrl": "https://oauth2.googleapis.com/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Lists all recurring audience lists for a property. This method can be used for you to find and reuse existing recurring audience lists rather than creating unnecessary new recurring audience lists. The same audience can have multiple recurring audience lists that represent different dimension combinations; for example, just the dimension `deviceId` or both the dimensions `deviceId` and `userId`. This method is introduced at alpha stability with the intention of gathering feedback on syntax and c"
        },
        {
          "info": {
            "name": "Creates a recurring audience list",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://analyticsdata.googleapis.com/v1alpha/properties/:propertiesId/recurringAudienceLists",
            "params": [
              {
                "name": "parent",
                "value": "",
                "type": "query",
                "description": "Required. The parent resource where this recurring audience list will be created. Format: `properties/{property}`"
              },
              {
                "name": "propertiesId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth",
              "accessTokenUrl": "https://oauth2.googleapis.com/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Creates a recurring audience list. Recurring audience lists produces new audience lists each day. Audience lists are users in an audience at the time of the list's creation. A recurring audience list ensures that you have audience list based on the most recent data available for use each day. If you manually create audience list, you don't know when an audience list based on an additional day's data is available. This recurring audience list automates the creation of an audience list when an add"
        },
        {
          "info": {
            "name": "Gets configuration metadata about a specific recurring audience list",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://analyticsdata.googleapis.com/v1alpha/properties/:propertiesId/recurringAudienceLists/:recurringAudienceListsId",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Required. The recurring audience list resource name. Format: `properties/{property}/recurringAudienceLists/{recurring_audience_list}`"
              },
              {
                "name": "propertiesId",
                "value": "",
                "type": "path"
              },
              {
                "name": "recurringAudienceListsId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth",
              "accessTokenUrl": "https://oauth2.googleapis.com/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Gets configuration metadata about a specific recurring audience list. This method can be used to understand a recurring audience list's state after it has been created. For example, a recurring audience list resource will generate audience list instances for each day, and this method can be used to get the resource name of the most recent audience list instance. This method is introduced at alpha stability with the intention of gathering feedback on syntax and capabilities before entering beta. "
        },
        {
          "info": {
            "name": "Lists all report tasks for a property",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://analyticsdata.googleapis.com/v1alpha/properties/:propertiesId/reportTasks",
            "params": [
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Optional. The maximum number of report tasks to return."
              },
              {
                "name": "pageToken",
                "value": "",
                "type": "query",
                "description": "Optional. A page token, received from a previous `ListReportTasks` call. Provide this to retrieve the subsequent page."
              },
              {
                "name": "parent",
                "value": "",
                "type": "query",
                "description": "Required. All report tasks for this property will be listed in the response. Format: `properties/{property}`"
              },
              {
                "name": "propertiesId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth",
              "accessTokenUrl": "https://oauth2.googleapis.com/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Lists all report tasks for a property."
        },
        {
          "info": {
            "name": "Initiates the creation of a report task",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://analyticsdata.googleapis.com/v1alpha/properties/:propertiesId/reportTasks",
            "params": [
              {
                "name": "parent",
                "value": "",
                "type": "query",
                "description": "Required. The parent resource where this report task will be created. Format: `properties/{propertyId}`"
              },
              {
                "name": "propertiesId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth",
              "accessTokenUrl": "https://oauth2.googleapis.com/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Initiates the creation of a report task. This method quickly returns a report task and initiates a long running asynchronous request to form a customized report of your Google Analytics event data. A report task will be retained and available for querying for 72 hours after it has been created. A report task created by one user can be listed and queried by all users who have access to the property."
        },
        {
          "info": {
            "name": "Gets report metadata about a specific report task",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://analyticsdata.googleapis.com/v1alpha/properties/:propertiesId/reportTasks/:reportTasksId",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Required. The report task resource name. Format: `properties/{property}/reportTasks/{report_task}`"
              },
              {
                "name": "propertiesId",
                "value": "",
                "type": "path"
              },
              {
                "name": "reportTasksId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth",
              "accessTokenUrl": "https://oauth2.googleapis.com/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Gets report metadata about a specific report task. After creating a report task, use this method to check its processing state or inspect its report definition."
        },
        {
          "info": {
            "name": "Retrieves a report task's content",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://analyticsdata.googleapis.com/v1alpha/properties/:propertiesId/reportTasks/:reportTasksId:query",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Required. The report source name. Format: `properties/{property}/reportTasks/{report}`"
              },
              {
                "name": "propertiesId",
                "value": "",
                "type": "path"
              },
              {
                "name": "reportTasksId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth",
              "accessTokenUrl": "https://oauth2.googleapis.com/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Retrieves a report task's content. After requesting the `CreateReportTask`, you are able to retrieve the report content once the report is ACTIVE. This method will return an error if the report task's state is not `ACTIVE`. A query response will return the tabular row & column values of the report."
        }
      ]
    }
  ],
  "bundled": true
}