{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/analytics:googleapis-recommendationengine/recommendationengine-projects-locations-catalogs-list":{"get":{"operationId":"analytics_googleapis_recommendationengine_recommendationengine_projects_locations_catalogs_list","summary":"Lists all the catalog configurations associated with the project.","description":"GET /v1beta1/{+parent}/catalogs","tags":["analytics"],"parameters":[{"name":"pageSize","in":"query","required":false,"description":"Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.","schema":{"type":"integer","description":"Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000."}},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token, received from a previous `ListCatalogs` call. Provide this to retrieve the subsequent page.","schema":{"type":"string","description":"Optional. A page token, received from a previous `ListCatalogs` call. Provide this to retrieve the subsequent page."}},{"name":"parent","in":"query","required":true,"description":"Required. The account resource name with an associated location.","schema":{"type":"string","description":"Required. The account resource name with an associated location."}}],"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-recommendationengine/recommendationengine-projects-locations-catalogs-operations":{"get":{"operationId":"analytics_googleapis_recommendationengine_recommendationengine_projects_locations_catalogs_operations","summary":"Gets the latest state of a long-running operation. Clients can use this method to poll the operation result…","description":"GET /v1beta1/{+name}","tags":["analytics"],"parameters":[{"name":"name","in":"query","required":true,"description":"The name of the operation resource.","schema":{"type":"string","description":"The name of the operation resource."}}],"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-recommendationengine/recommendationengine-projects-locations-catalogs-catalog-ite":{"post":{"operationId":"analytics_googleapis_recommendationengine_recommendationengine_projects_locations_catalogs_catalog_ite","summary":"Updates a catalog item. Partial updating is supported. Non-existing items will be created.","description":"PATCH /v1beta1/{+name}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","body"],"properties":{"name":{"type":"string","description":"Required. Full resource name of catalog item, such as…"},"updateMask":{"type":"string","description":"Optional. Indicates which fields in the provided 'item' to update. If not set, will by default update all fields."},"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-recommendationengine/recommendationengine-projects-locations-catalogs-event-store":{"post":{"operationId":"analytics_googleapis_recommendationengine_recommendationengine_projects_locations_catalogs_event_store","summary":"Unregister an apiKey from using for predict method.","description":"DELETE /v1beta1/{+name}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Required. The API key to unregister including full resource path.…"}}}}}},"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-recommendationengine/recommendationengine-projects-locations-catalogs-catalog-ite-2":{"get":{"operationId":"analytics_googleapis_recommendationengine_recommendationengine_projects_locations_catalogs_catalog_ite_2","summary":"Gets a list of catalog items.","description":"GET /v1beta1/{+parent}/catalogItems","tags":["analytics"],"parameters":[{"name":"filter","in":"query","required":false,"description":"Optional. Use of this field is not supported by version v1beta1.","schema":{"type":"string","description":"Optional. Use of this field is not supported by version v1beta1."}},{"name":"pageSize","in":"query","required":false,"description":"Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default.","schema":{"type":"integer","description":"Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default."}},{"name":"pageToken","in":"query","required":false,"description":"Optional. The previous ListCatalogItemsResponse.next_page_token.","schema":{"type":"string","description":"Optional. The previous ListCatalogItemsResponse.next_page_token."}},{"name":"parent","in":"query","required":true,"description":"Required. The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog`.","schema":{"type":"string","description":"Required. The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog`."}}],"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-recommendationengine/recommendationengine-projects-locations-catalogs-catalog-ite-3":{"post":{"operationId":"analytics_googleapis_recommendationengine_recommendationengine_projects_locations_catalogs_catalog_ite_3","summary":"Creates a catalog item.","description":"POST /v1beta1/{+parent}/catalogItems","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"parent":{"type":"string","description":"Required. The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog`."},"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-recommendationengine/recommendationengine-projects-locations-catalogs-catalog-ite-4":{"post":{"operationId":"analytics_googleapis_recommendationengine_recommendationengine_projects_locations_catalogs_catalog_ite_4","summary":"Bulk import of multiple catalog items. Request processing may be synchronous. No partial updating supported.…","description":"POST /v1beta1/{+parent}/catalogItems:import","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"parent":{"type":"string","description":"Required. `projects/1234/locations/global/catalogs/default_catalog` If no updateMask is specified, requires catalogItems.create…"},"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-recommendationengine/recommendationengine-projects-locations-catalogs-operations-2":{"get":{"operationId":"analytics_googleapis_recommendationengine_recommendationengine_projects_locations_catalogs_operations_2","summary":"Lists operations that match the specified filter in the request. If the server doesn't support this method,…","description":"GET /v1beta1/{+name}/operations","tags":["analytics"],"parameters":[{"name":"filter","in":"query","required":false,"description":"The standard list filter.","schema":{"type":"string","description":"The standard list filter."}},{"name":"name","in":"query","required":true,"description":"The name of the operation's parent resource.","schema":{"type":"string","description":"The name of the operation's parent resource."}},{"name":"pageSize","in":"query","required":false,"description":"The standard list page size.","schema":{"type":"integer","description":"The standard list page size."}},{"name":"pageToken","in":"query","required":false,"description":"The standard list page token.","schema":{"type":"string","description":"The standard list page token."}},{"name":"returnPartialSuccess","in":"query","required":false,"description":"When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the…","schema":{"type":"boolean","description":"When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the…"}}],"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-recommendationengine/recommendationengine-projects-locations-catalogs-event-store-2":{"post":{"operationId":"analytics_googleapis_recommendationengine_recommendationengine_projects_locations_catalogs_event_store_2","summary":"Makes a recommendation prediction. If using API Key based authentication, the API Key must be registered…","description":"POST /v1beta1/{+name}:predict","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","body"],"properties":{"name":{"type":"string"},"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-recommendationengine/recommendationengine-projects-locations-catalogs-event-store-3":{"get":{"operationId":"analytics_googleapis_recommendationengine_recommendationengine_projects_locations_catalogs_event_store_3","summary":"List the registered apiKeys for use with predict method.","description":"GET /v1beta1/{+parent}/predictionApiKeyRegistrations","tags":["analytics"],"parameters":[{"name":"pageSize","in":"query","required":false,"description":"Optional. Maximum number of results to return per page. If unset, the service will choose a reasonable default.","schema":{"type":"integer","description":"Optional. Maximum number of results to return per page. If unset, the service will choose a reasonable default."}},{"name":"pageToken","in":"query","required":false,"description":"Optional. The previous `ListPredictionApiKeyRegistration.nextPageToken`.","schema":{"type":"string","description":"Optional. The previous `ListPredictionApiKeyRegistration.nextPageToken`."}},{"name":"parent","in":"query","required":true,"description":"Required. The parent placement resource name such as…","schema":{"type":"string","description":"Required. The parent placement resource name such as…"}}],"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-recommendationengine/recommendationengine-projects-locations-catalogs-event-store-4":{"post":{"operationId":"analytics_googleapis_recommendationengine_recommendationengine_projects_locations_catalogs_event_store_4","summary":"Register an API key for use with predict method.","description":"POST /v1beta1/{+parent}/predictionApiKeyRegistrations","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"parent":{"type":"string","description":"Required. The parent resource path. `projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store`."},"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-recommendationengine/recommendationengine-projects-locations-catalogs-event-store-5":{"get":{"operationId":"analytics_googleapis_recommendationengine_recommendationengine_projects_locations_catalogs_event_store_5","summary":"Writes a single user event from the browser. This uses a GET request to due to browser restriction of…","description":"GET /v1beta1/{+parent}/userEvents:collect","tags":["analytics"],"parameters":[{"name":"ets","in":"query","required":false,"description":"Optional. The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated…","schema":{"type":"string","description":"Optional. The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated…"}},{"name":"parent","in":"query","required":true,"description":"Required. The parent eventStore name, such as `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`.","schema":{"type":"string","description":"Required. The parent eventStore name, such as `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`."}},{"name":"uri","in":"query","required":false,"description":"Optional. The url including cgi-parameters but excluding the hash fragment. The URL must be truncated to 1.5K bytes to conservatively be…","schema":{"type":"string","description":"Optional. The url including cgi-parameters but excluding the hash fragment. The URL must be truncated to 1.5K bytes to conservatively be…"}},{"name":"userEvent","in":"query","required":false,"description":"Required. URL encoded UserEvent proto.","schema":{"type":"string","description":"Required. URL encoded UserEvent proto."}}],"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-recommendationengine/recommendationengine-projects-locations-catalogs-event-store-6":{"post":{"operationId":"analytics_googleapis_recommendationengine_recommendationengine_projects_locations_catalogs_event_store_6","summary":"Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped.…","description":"POST /v1beta1/{+parent}/userEvents:import","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"parent":{"type":"string","description":"Required. `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`"},"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-recommendationengine/recommendationengine-projects-locations-catalogs-event-store-7":{"get":{"operationId":"analytics_googleapis_recommendationengine_recommendationengine_projects_locations_catalogs_event_store_7","summary":"Gets a list of user events within a time range, with potential filtering. The method does not list unjoined…","description":"GET /v1beta1/{+parent}/userEvents","tags":["analytics"],"parameters":[{"name":"filter","in":"query","required":false,"description":"Optional. Filtering expression to specify restrictions over returned events. This is a sequence of terms, where each term applies some…","schema":{"type":"string","description":"Optional. Filtering expression to specify restrictions over returned events. This is a sequence of terms, where each term applies some…"}},{"name":"pageSize","in":"query","required":false,"description":"Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default.","schema":{"type":"integer","description":"Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default."}},{"name":"pageToken","in":"query","required":false,"description":"Optional. The previous ListUserEventsResponse.next_page_token.","schema":{"type":"string","description":"Optional. The previous ListUserEventsResponse.next_page_token."}},{"name":"parent","in":"query","required":true,"description":"Required. The parent eventStore resource name, such as `projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store`.","schema":{"type":"string","description":"Required. The parent eventStore resource name, such as `projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store`."}}],"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-recommendationengine/recommendationengine-projects-locations-catalogs-event-store-8":{"post":{"operationId":"analytics_googleapis_recommendationengine_recommendationengine_projects_locations_catalogs_event_store_8","summary":"Deletes permanently all user events specified by the filter provided. Depending on the number of events…","description":"POST /v1beta1/{+parent}/userEvents:purge","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"parent":{"type":"string","description":"Required. The resource name of the event_store under which the events are created. The format is…"},"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-recommendationengine/recommendationengine-projects-locations-catalogs-event-store-9":{"post":{"operationId":"analytics_googleapis_recommendationengine_recommendationengine_projects_locations_catalogs_event_store_9","summary":"Triggers a user event rejoin operation with latest catalog data. Events will not be annotated with detailed…","description":"POST /v1beta1/{+parent}/userEvents:rejoin","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"parent":{"type":"string","description":"Required. Full resource name of user event, such as `projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store`."},"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-recommendationengine/recommendationengine-projects-locations-catalogs-event-store-10":{"post":{"operationId":"analytics_googleapis_recommendationengine_recommendationengine_projects_locations_catalogs_event_store_10","summary":"Writes a single user event.","description":"POST /v1beta1/{+parent}/userEvents:write","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"parent":{"type":"string","description":"Required. The parent eventStore resource name, such as…"},"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"}}},"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"}}}}}}}