{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/analytics:googleapis-admin/reports-activities-list":{"get":{"operationId":"analytics_googleapis_admin_reports_activities_list","summary":"Retrieves a list of activities for a specific customer's account and application such as the Admin console…","description":"GET /admin/reports/v1/activity/users/{userKey}/applications/{applicationName}","tags":["analytics"],"parameters":[{"name":"actorIpAddress","in":"query","required":false,"description":"The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the…","schema":{"type":"string","description":"The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the…"}},{"name":"agentInfoFilter","in":"query","required":false,"description":"Optional. Filters on agent info fields in the activity. This filter gets applied in conjunction(AND) with other filters. Example:…","schema":{"type":"string","description":"Optional. Filters on agent info fields in the activity. This filter gets applied in conjunction(AND) with other filters. Example:…"}},{"name":"applicationInfoFilter","in":"query","required":false,"description":"Optional. Used to filter on the `oAuthClientId` field present in [`ApplicationInfo`](#applicationinfo) message. **Usage** ```…","schema":{"type":"string","description":"Optional. Used to filter on the `oAuthClientId` field present in [`ApplicationInfo`](#applicationinfo) message. **Usage** ```…"}},{"name":"applicationName","in":"query","required":true,"description":"Application name for which the events are to be retrieved.","schema":{"type":"string","description":"Application name for which the events are to be retrieved."}},{"name":"customerId","in":"query","required":false,"description":"The unique ID of the customer to retrieve data for.","schema":{"type":"string","description":"The unique ID of the customer to retrieve data for."}},{"name":"deviceFilter","in":"query","required":false,"description":"Optional. Used to filter on the fields present in [`UserDeviceInfo`](#userdeviceinfo) message like `deviceId`, `deviceType`, and…","schema":{"type":"string","description":"Optional. Used to filter on the fields present in [`UserDeviceInfo`](#userdeviceinfo) message like `deviceId`, `deviceType`, and…"}},{"name":"endTime","in":"query","required":false,"description":"Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The…","schema":{"type":"string","description":"Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The…"}},{"name":"eventName","in":"query","required":false,"description":"The name of the event being queried by the API. Each `eventName` is related to a specific Google Workspace service or feature which the…","schema":{"type":"string","description":"The name of the event being queried by the API. Each `eventName` is related to a specific Google Workspace service or feature which the…"}},{"name":"filters","in":"query","required":false,"description":"The `filters` query string is a comma-separated list composed of event parameters manipulated by relational operators. Event parameters…","schema":{"type":"string","description":"The `filters` query string is a comma-separated list composed of event parameters manipulated by relational operators. Event parameters…"}},{"name":"groupIdFilter","in":"query","required":false,"description":"Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those…","schema":{"type":"string","description":"Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those…"}},{"name":"includeSensitiveData","in":"query","required":false,"description":"Optional. When set to `true`, this field allows sensitive user-generated content to be included in the returned audit logs. This parameter…","schema":{"type":"boolean","description":"Optional. When set to `true`, this field allows sensitive user-generated content to be included in the returned audit logs. This parameter…"}},{"name":"maxResults","in":"query","required":false,"description":"Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has…","schema":{"type":"integer","default":"1000","description":"Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has…"}},{"name":"networkInfoFilter","in":"query","required":false,"description":"Optional. Used to filter on the `regionCode` field present in [`NetworkInfo`](#networkinfo) message. **Usage** ```…","schema":{"type":"string","description":"Optional. Used to filter on the `regionCode` field present in [`NetworkInfo`](#networkinfo) message. **Usage** ```…"}},{"name":"orgUnitID","in":"query","required":false,"description":"ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit.…","schema":{"type":"string","default":"","description":"ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit.…"}},{"name":"pageToken","in":"query","required":false,"description":"The token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request…","schema":{"type":"string","description":"The token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request…"}},{"name":"resourceDetailsFilter","in":"query","required":false,"description":"Optional. The `resourceDetailsFilter` query string is an AND separated list composed of [Resource Details](#resourcedetails) fields…","schema":{"type":"string","description":"Optional. The `resourceDetailsFilter` query string is an AND separated list composed of [Resource Details](#resourcedetails) fields…"}},{"name":"startTime","in":"query","required":false,"description":"Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The…","schema":{"type":"string","description":"Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The…"}},{"name":"statusFilter","in":"query","required":false,"description":"Optional. Used to filter on the `statusCode` field present in [`Status`](#status) message. **Usage** ```…","schema":{"type":"string","description":"Optional. Used to filter on the `statusCode` field present in [`Status`](#status) message. **Usage** ```…"}},{"name":"userKey","in":"query","required":true,"description":"Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a…","schema":{"type":"string","description":"Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-admin/reports-activities-watch":{"post":{"operationId":"analytics_googleapis_admin_reports_activities_watch","summary":"Start receiving notifications for account activities. For more information, see Receiving Push Notifications.","description":"POST /admin/reports/v1/activity/users/{userKey}/applications/{applicationName}/watch","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["applicationName","userKey","body"],"properties":{"actorIpAddress":{"type":"string","description":"The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the…"},"applicationName":{"type":"string","enum":["access_transparency","admin","calendar","chat","drive","gcp","gplus","groups","groups_enterprise","jamboard","login","meet","mobile","rules","saml","token","user_accounts","context_aware_access","chrome","data_studio","keep","classroom"],"description":"Application name for which the events are to be retrieved."},"customerId":{"type":"string","description":"The unique ID of the customer to retrieve data for."},"endTime":{"type":"string","description":"Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The…"},"eventName":{"type":"string","description":"The name of the event being queried by the API. Each `eventName` is related to a specific Google Workspace service or feature which the…"},"filters":{"type":"string","description":"The `filters` query string is a comma-separated list composed of event parameters manipulated by relational operators. Event parameters…"},"groupIdFilter":{"type":"string","description":"`Deprecated`. This field is deprecated and is no longer supported. Comma separated group ids (obfuscated) on which user activities are…"},"maxResults":{"type":"integer","default":"1000","description":"Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has…"},"orgUnitID":{"type":"string","default":"","description":"`Deprecated`. This field is deprecated and is no longer supported. ID of the organizational unit to report on. Activity records will be…"},"pageToken":{"type":"string","description":"The token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request…"},"startTime":{"type":"string","description":"Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The…"},"userKey":{"type":"string","description":"Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-admin/admin-channels-stop":{"post":{"operationId":"analytics_googleapis_admin_admin_channels_stop","summary":"Stop watching resources through this channel.","description":"POST /admin/reports_v1/channels/stop","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-admin/reports-customer-usage-reports-get":{"get":{"operationId":"analytics_googleapis_admin_reports_customer_usage_reports_get","summary":"Retrieves a report which is a collection of properties and statistics for a specific customer's account. For…","description":"GET /admin/reports/v1/usage/dates/{date}","tags":["analytics"],"parameters":[{"name":"customerId","in":"query","required":false,"description":"The unique ID of the customer to retrieve data for.","schema":{"type":"string","description":"The unique ID of the customer to retrieve data for."}},{"name":"date","in":"query","required":true,"description":"Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the [ISO 8601…","schema":{"type":"string","description":"Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the [ISO 8601…"}},{"name":"pageToken","in":"query","required":false,"description":"Token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. For your follow-on requests…","schema":{"type":"string","description":"Token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. For your follow-on requests…"}},{"name":"parameters","in":"query","required":false,"description":"The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated…","schema":{"type":"string","description":"The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-admin/reports-entity-usage-reports-get":{"get":{"operationId":"analytics_googleapis_admin_reports_entity_usage_reports_get","summary":"Retrieves a report which is a collection of properties and statistics for entities used by users within the…","description":"GET /admin/reports/v1/usage/{entityType}/{entityKey}/dates/{date}","tags":["analytics"],"parameters":[{"name":"customerId","in":"query","required":false,"description":"The unique ID of the customer to retrieve data for.","schema":{"type":"string","description":"The unique ID of the customer to retrieve data for."}},{"name":"date","in":"query","required":true,"description":"Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the [ISO 8601…","schema":{"type":"string","description":"Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the [ISO 8601…"}},{"name":"entityKey","in":"query","required":true,"description":"Represents the key of the object to filter the data with. It is a string which can take the value `all` to get activity events for all…","schema":{"type":"string","description":"Represents the key of the object to filter the data with. It is a string which can take the value `all` to get activity events for all…"}},{"name":"entityType","in":"query","required":true,"description":"Represents the type of entity for the report.","schema":{"type":"string","enum":["gplus_communities"],"description":"Represents the type of entity for the report."}},{"name":"filters","in":"query","required":false,"description":"The `filters` query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a…","schema":{"type":"string","description":"The `filters` query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a…"}},{"name":"maxResults","in":"query","required":false,"description":"Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has…","schema":{"type":"integer","default":"1000","description":"Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has…"}},{"name":"pageToken","in":"query","required":false,"description":"Token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting…","schema":{"type":"string","description":"Token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting…"}},{"name":"parameters","in":"query","required":false,"description":"The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated…","schema":{"type":"string","description":"The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-admin/reports-user-usage-report-get":{"get":{"operationId":"analytics_googleapis_admin_reports_user_usage_report_get","summary":"Retrieves a report which is a collection of properties and statistics for a set of users with the account.…","description":"GET /admin/reports/v1/usage/users/{userKey}/dates/{date}","tags":["analytics"],"parameters":[{"name":"customerId","in":"query","required":false,"description":"The unique ID of the customer to retrieve data for.","schema":{"type":"string","description":"The unique ID of the customer to retrieve data for."}},{"name":"date","in":"query","required":true,"description":"Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the [ISO 8601…","schema":{"type":"string","description":"Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the [ISO 8601…"}},{"name":"filters","in":"query","required":false,"description":"The `filters` query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a…","schema":{"type":"string","description":"The `filters` query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a…"}},{"name":"groupIdFilter","in":"query","required":false,"description":"Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those…","schema":{"type":"string","description":"Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those…"}},{"name":"maxResults","in":"query","required":false,"description":"Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has…","schema":{"type":"integer","default":"1000","description":"Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has…"}},{"name":"orgUnitID","in":"query","required":false,"description":"ID of the organizational unit to report on. User activity will be shown only for users who belong to the specified organizational unit.…","schema":{"type":"string","default":"","description":"ID of the organizational unit to report on. User activity will be shown only for users who belong to the specified organizational unit.…"}},{"name":"pageToken","in":"query","required":false,"description":"Token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting…","schema":{"type":"string","description":"Token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting…"}},{"name":"parameters","in":"query","required":false,"description":"The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated…","schema":{"type":"string","description":"The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated…"}},{"name":"userKey","in":"query","required":true,"description":"Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a…","schema":{"type":"string","description":"Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}