{"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-firestore/firestore-projects-databases-bulk-delete-documents":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_bulk_delete_documents","summary":"Bulk deletes a subset of documents from Google Cloud Firestore. Documents created or updated after the…","description":"POST /v1/{+name}:bulkDeleteDocuments","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","body"],"properties":{"name":{"type":"string","description":"Required. Database to operate. Should be of the form: `projects/{project_id}/databases/{database_id}`."},"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-firestore/firestore-projects-databases-clone":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_clone","summary":"Creates a new database by cloning an existing one. The new database must be in the same cloud region or…","description":"POST /v1/{+parent}/databases:clone","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"parent":{"type":"string","description":"Required. The project to clone the database in. Format is `projects/{project_id}`."},"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-firestore/firestore-projects-databases-list":{"get":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_list","summary":"List all the databases in the project.","description":"GET /v1/{+parent}/databases","tags":["analytics"],"parameters":[{"name":"parent","in":"query","required":true,"description":"Required. A parent name of the form `projects/{project_id}`","schema":{"type":"string","description":"Required. A parent name of the form `projects/{project_id}`"}},{"name":"showDeleted","in":"query","required":false,"description":"If true, also returns deleted resources.","schema":{"type":"boolean","description":"If true, also returns deleted resources."}}],"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-firestore/firestore-projects-databases-create":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_create","summary":"Create a database.","description":"POST /v1/{+parent}/databases","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"databaseId":{"type":"string","description":"Required. The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63…"},"parent":{"type":"string","description":"Required. A parent name of the form `projects/{project_id}`"},"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-firestore/firestore-projects-locations-backups-get":{"get":{"operationId":"analytics_googleapis_firestore_firestore_projects_locations_backups_get","summary":"Gets information about a backup.","description":"GET /v1/{+name}","tags":["analytics"],"parameters":[{"name":"name","in":"query","required":true,"description":"Required. Name of the backup to fetch. Format is `projects/{project}/locations/{location}/backups/{backup}`.","schema":{"type":"string","description":"Required. Name of the backup to fetch. Format is `projects/{project}/locations/{location}/backups/{backup}`."}}],"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-firestore/firestore-projects-databases-documents-patch":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_documents_patch","summary":"Updates or inserts a document.","description":"PATCH /v1/{+name}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","body"],"properties":{"currentDocument.exists":{"type":"boolean","description":"When set to `true`, the target document must exist. When set to `false`, the target document must not exist."},"currentDocument.updateTime":{"type":"string","description":"When set, the target document must exist and have been last updated at that time. Timestamp must be microsecond aligned."},"mask.fieldPaths":{"type":"string","description":"The list of field paths in the mask. See Document.fields for a field path syntax reference."},"name":{"type":"string","description":"The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`."},"requestOptions.requestTags":{"type":"string","description":"Optional. The request tags for the request. Request tags are user-provided strings used for usage monitoring, cost management, and…"},"updateMask.fieldPaths":{"type":"string","description":"The list of field paths in the mask. See Document.fields for a field path syntax reference."},"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-firestore/firestore-projects-locations-backups-delete":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_locations_backups_delete","summary":"Deletes a backup.","description":"DELETE /v1/{+name}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Required. Name of the backup to delete. format is `projects/{project}/locations/{location}/backups/{backup}`."}}}}}},"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-firestore/firestore-projects-databases-export-documents":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_export_documents","summary":"Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such…","description":"POST /v1/{+name}:exportDocuments","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","body"],"properties":{"name":{"type":"string","description":"Required. Database to export. Should be of the form: `projects/{project_id}/databases/{database_id}`."},"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-firestore/firestore-projects-databases-import-documents":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_import_documents","summary":"Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The…","description":"POST /v1/{+name}:importDocuments","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","body"],"properties":{"name":{"type":"string","description":"Required. Database to import into. Should be of the form: `projects/{project_id}/databases/{database_id}`."},"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-firestore/firestore-projects-databases-restore":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_restore","summary":"Creates a new database by restoring from an existing backup. The new database must be in the same cloud…","description":"POST /v1/{+parent}/databases:restore","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"parent":{"type":"string","description":"Required. The project to restore the database in. Format is `projects/{project_id}`."},"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-firestore/firestore-projects-databases-backup-schedules-list":{"get":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_backup_schedules_list","summary":"List backup schedules.","description":"GET /v1/{+parent}/backupSchedules","tags":["analytics"],"parameters":[{"name":"parent","in":"query","required":true,"description":"Required. The parent database. Format is `projects/{project}/databases/{database}`.","schema":{"type":"string","description":"Required. The parent database. Format is `projects/{project}/databases/{database}`."}}],"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-firestore/firestore-projects-databases-backup-schedules-create":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_backup_schedules_create","summary":"Creates a backup schedule on a database. At most two backup schedules can be configured on a database, one…","description":"POST /v1/{+parent}/backupSchedules","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"parent":{"type":"string","description":"Required. The parent database. Format `projects/{project}/databases/{database}`"},"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-firestore/firestore-projects-databases-change-streams-list":{"get":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_change_streams_list","summary":"Lists all change streams in a database.","description":"GET /v1/{+parent}/changeStreams","tags":["analytics"],"parameters":[{"name":"parent","in":"query","required":true,"description":"Required. The parent database to list change streams from. Format is `projects/{project}/databases/{database}`.","schema":{"type":"string","description":"Required. The parent database to list change streams from. Format is `projects/{project}/databases/{database}`."}}],"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-firestore/firestore-projects-databases-change-streams-create":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_change_streams_create","summary":"Creates a new change stream for the database.","description":"POST /v1/{+parent}/changeStreams","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"changeStreamId":{"type":"string","description":"Required. The ID to use for the change stream, which will become the final component of the change stream's resource name. This value…"},"parent":{"type":"string","description":"Required. The parent database to create the change stream for. Format is `projects/{project}/databases/{database}`."},"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-firestore/firestore-projects-databases-collection-groups-fields-list":{"get":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_collection_groups_fields_list","summary":"Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only…","description":"GET /v1/{+parent}/fields","tags":["analytics"],"parameters":[{"name":"filter","in":"query","required":false,"description":"The filter to apply to list results. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly…","schema":{"type":"string","description":"The filter to apply to list results. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly…"}},{"name":"pageSize","in":"query","required":false,"description":"The number of results to return.","schema":{"type":"integer","description":"The number of results to return."}},{"name":"pageToken","in":"query","required":false,"description":"A page token, returned from a previous call to FirestoreAdmin.ListFields, that may be used to get the next page of results.","schema":{"type":"string","description":"A page token, returned from a previous call to FirestoreAdmin.ListFields, that may be used to get the next page of results."}},{"name":"parent","in":"query","required":true,"description":"Required. A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`","schema":{"type":"string","description":"Required. A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`"}}],"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-firestore/firestore-projects-databases-collection-groups-indexes-list":{"get":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_collection_groups_indexes_list","summary":"Lists composite indexes.","description":"GET /v1/{+parent}/indexes","tags":["analytics"],"parameters":[{"name":"filter","in":"query","required":false,"description":"The filter to apply to list results.","schema":{"type":"string","description":"The filter to apply to list results."}},{"name":"pageSize","in":"query","required":false,"description":"The number of results to return.","schema":{"type":"integer","description":"The number of results to return."}},{"name":"pageToken","in":"query","required":false,"description":"A page token, returned from a previous call to FirestoreAdmin.ListIndexes, that may be used to get the next page of results.","schema":{"type":"string","description":"A page token, returned from a previous call to FirestoreAdmin.ListIndexes, that may be used to get the next page of results."}},{"name":"parent","in":"query","required":true,"description":"Required. A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`","schema":{"type":"string","description":"Required. A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`"}}],"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-firestore/firestore-projects-databases-collection-groups-indexes-creat":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_collection_groups_indexes_creat","summary":"Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status…","description":"POST /v1/{+parent}/indexes","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"parent":{"type":"string","description":"Required. A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`"},"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-firestore/firestore-projects-databases-documents-batch-get":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_documents_batch_get","summary":"Gets multiple documents. Documents returned by this method are not guaranteed to be returned in the same…","description":"POST /v1/{+database}/documents:batchGet","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["database","body"],"properties":{"database":{"type":"string","description":"Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`."},"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-firestore/firestore-projects-databases-documents-batch-write":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_documents_batch_write","summary":"Applies a batch of write operations. The BatchWrite method does not apply the write operations atomically…","description":"POST /v1/{+database}/documents:batchWrite","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["database","body"],"properties":{"database":{"type":"string","description":"Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`."},"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-firestore/firestore-projects-databases-documents-begin-transaction":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_documents_begin_transaction","summary":"Starts a new transaction.","description":"POST /v1/{+database}/documents:beginTransaction","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["database","body"],"properties":{"database":{"type":"string","description":"Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`."},"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-firestore/firestore-projects-databases-documents-commit":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_documents_commit","summary":"Commits a transaction, while optionally updating documents.","description":"POST /v1/{+database}/documents:commit","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["database","body"],"properties":{"database":{"type":"string","description":"Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`."},"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-firestore/firestore-projects-databases-documents-list-documents":{"get":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_documents_list_documents","summary":"Lists documents.","description":"GET /v1/{+parent}/{collectionId}","tags":["analytics"],"parameters":[{"name":"collectionId","in":"query","required":true,"description":"Optional. The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`. This is optional, and when not…","schema":{"type":"string","description":"Optional. The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`. This is optional, and when not…"}},{"name":"mask.fieldPaths","in":"query","required":false,"description":"The list of field paths in the mask. See Document.fields for a field path syntax reference.","schema":{"type":"string","description":"The list of field paths in the mask. See Document.fields for a field path syntax reference."}},{"name":"orderBy","in":"query","required":false,"description":"Optional. The optional ordering of the documents to return. For example: `priority desc, __name__ desc`. This mirrors the `ORDER BY` used…","schema":{"type":"string","description":"Optional. The optional ordering of the documents to return. For example: `priority desc, __name__ desc`. This mirrors the `ORDER BY` used…"}},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of documents to return in a single response. Firestore may return fewer than this value.","schema":{"type":"integer","description":"Optional. The maximum number of documents to return in a single response. Firestore may return fewer than this value."}},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token, received from a previous `ListDocuments` response. Provide this to retrieve the subsequent page. When paginating,…","schema":{"type":"string","description":"Optional. A page token, received from a previous `ListDocuments` response. Provide this to retrieve the subsequent page. When paginating,…"}},{"name":"parent","in":"query","required":true,"description":"Required. The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or…","schema":{"type":"string","description":"Required. The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or…"}},{"name":"readTime","in":"query","required":false,"description":"Perform the read at the provided time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time…","schema":{"type":"string","description":"Perform the read at the provided time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time…"}},{"name":"recursive","in":"query","required":false,"description":"Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a…","schema":{"type":"boolean","description":"Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a…"}},{"name":"requestOptions.requestTags","in":"query","required":false,"description":"Optional. The request tags for the request. Request tags are user-provided strings used for usage monitoring, cost management, and…","schema":{"type":"string","description":"Optional. The request tags for the request. Request tags are user-provided strings used for usage monitoring, cost management, and…"}},{"name":"showMissing","in":"query","required":false,"description":"If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it.…","schema":{"type":"boolean","description":"If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it.…"}},{"name":"transaction","in":"query","required":false,"description":"Perform the read as part of an already active transaction.","schema":{"type":"string","description":"Perform the read as part of an already active transaction."}}],"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-firestore/firestore-projects-databases-documents-create-document":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_documents_create_document","summary":"Creates a new document.","description":"POST /v1/{+parent}/{collectionId}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["collectionId","parent","body"],"properties":{"collectionId":{"type":"string","description":"Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`."},"documentId":{"type":"string","description":"The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service."},"mask.fieldPaths":{"type":"string","description":"The list of field paths in the mask. See Document.fields for a field path syntax reference."},"parent":{"type":"string","description":"Required. The parent resource. For example: `projects/{project_id}/databases/{database_id}/documents` or…"},"requestOptions.requestTags":{"type":"string","description":"Optional. The request tags for the request. Request tags are user-provided strings used for usage monitoring, cost management, and…"},"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-firestore/firestore-projects-databases-documents-execute-pipeline":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_documents_execute_pipeline","summary":"Executes a pipeline query.","description":"POST /v1/{+database}/documents:executePipeline","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["database","body"],"properties":{"database":{"type":"string","description":"Required. Database identifier, in the form `projects/{project}/databases/{database}`."},"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-firestore/firestore-projects-databases-documents-list-collection-ids":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_documents_list_collection_ids","summary":"Lists all the collection IDs underneath a document.","description":"POST /v1/{+parent}:listCollectionIds","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"parent":{"type":"string","description":"Required. The parent document. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example:…"},"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-firestore/firestore-projects-databases-documents-listen":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_documents_listen","summary":"Listens to changes. This method is only available via gRPC or WebChannel (not REST).","description":"POST /v1/{+database}/documents:listen","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["database","body"],"properties":{"database":{"type":"string","description":"Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`."},"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-firestore/firestore-projects-databases-documents-partition-query":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_documents_partition_query","summary":"Partitions a query by returning partition cursors that can be used to run the query in parallel. The…","description":"POST /v1/{+parent}:partitionQuery","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"parent":{"type":"string","description":"Required. The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents`. Document resource names are…"},"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-firestore/firestore-projects-databases-documents-rollback":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_documents_rollback","summary":"Rolls back a transaction.","description":"POST /v1/{+database}/documents:rollback","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["database","body"],"properties":{"database":{"type":"string","description":"Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`."},"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-firestore/firestore-projects-databases-documents-run-aggregation-query":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_documents_run_aggregation_query","summary":"Runs an aggregation query. Rather than producing Document results like Firestore.RunQuery, this API allows…","description":"POST /v1/{+parent}:runAggregationQuery","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"parent":{"type":"string","description":"Required. The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or…"},"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-firestore/firestore-projects-databases-documents-run-query":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_documents_run_query","summary":"Runs a query.","description":"POST /v1/{+parent}:runQuery","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"parent":{"type":"string","description":"Required. The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or…"},"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-firestore/firestore-projects-databases-documents-write":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_documents_write","summary":"Streams batches of document updates and deletes, in order. This method is only available via gRPC or…","description":"POST /v1/{+database}/documents:write","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["database","body"],"properties":{"database":{"type":"string","description":"Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. This is only required in the first message."},"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-firestore/firestore-projects-databases-operations-cancel":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_operations_cancel","summary":"Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the…","description":"POST /v1/{+name}:cancel","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","body"],"properties":{"name":{"type":"string","description":"The name of the operation resource to be cancelled."},"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-firestore/firestore-projects-databases-operations-list":{"get":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_operations_list","summary":"Lists operations that match the specified filter in the request. If the server doesn't support this method,…","description":"GET /v1/{+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-firestore/firestore-projects-databases-user-creds-list":{"get":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_user_creds_list","summary":"List all user creds in the database. Note that the returned resource does not contain the secret value itself.","description":"GET /v1/{+parent}/userCreds","tags":["analytics"],"parameters":[{"name":"parent","in":"query","required":true,"description":"Required. A parent database name of the form `projects/{project_id}/databases/{database_id}`","schema":{"type":"string","description":"Required. A parent database name of the form `projects/{project_id}/databases/{database_id}`"}}],"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-firestore/firestore-projects-databases-user-creds-create":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_user_creds_create","summary":"Create a user creds.","description":"POST /v1/{+parent}/userCreds","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"parent":{"type":"string","description":"Required. A parent name of the form `projects/{project_id}/databases/{database_id}`"},"userCredsId":{"type":"string","description":"Required. The ID to use for the user creds, which will become the final component of the user creds's resource name. This value should be…"},"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-firestore/firestore-projects-databases-user-creds-disable":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_user_creds_disable","summary":"Disables a user creds. No-op if the user creds are already disabled.","description":"POST /v1/{+name}:disable","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","body"],"properties":{"name":{"type":"string","description":"Required. A name of the form `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}`"},"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-firestore/firestore-projects-databases-user-creds-enable":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_user_creds_enable","summary":"Enables a user creds. No-op if the user creds are already enabled.","description":"POST /v1/{+name}:enable","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","body"],"properties":{"name":{"type":"string","description":"Required. A name of the form `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}`"},"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-firestore/firestore-projects-databases-user-creds-reset-password":{"post":{"operationId":"analytics_googleapis_firestore_firestore_projects_databases_user_creds_reset_password","summary":"Resets the password of a user creds.","description":"POST /v1/{+name}:resetPassword","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","body"],"properties":{"name":{"type":"string","description":"Required. A name of the form `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}`"},"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-firestore/firestore-projects-locations-list":{"get":{"operationId":"analytics_googleapis_firestore_firestore_projects_locations_list","summary":"Lists information about the supported locations for this service. This method lists locations based on the…","description":"GET /v1/{+name}/locations","tags":["analytics"],"parameters":[{"name":"extraLocationTypes","in":"query","required":false,"description":"Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.","schema":{"type":"string","description":"Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage."}},{"name":"filter","in":"query","required":false,"description":"A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is…","schema":{"type":"string","description":"A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is…"}},{"name":"name","in":"query","required":true,"description":"The resource that owns the locations collection, if applicable.","schema":{"type":"string","description":"The resource that owns the locations collection, if applicable."}},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of results to return. If not set, the service selects a default.","schema":{"type":"integer","description":"The maximum number of results to return. If not set, the service selects a default."}},{"name":"pageToken","in":"query","required":false,"description":"A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.","schema":{"type":"string","description":"A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page."}}],"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-firestore/firestore-projects-locations-backups-list":{"get":{"operationId":"analytics_googleapis_firestore_firestore_projects_locations_backups_list","summary":"Lists all the backups.","description":"GET /v1/{+parent}/backups","tags":["analytics"],"parameters":[{"name":"filter","in":"query","required":false,"description":"An expression that filters the list of returned backups. A filter expression consists of a field name, a comparison operator, and a value…","schema":{"type":"string","description":"An expression that filters the list of returned backups. A filter expression consists of a field name, a comparison operator, and a value…"}},{"name":"parent","in":"query","required":true,"description":"Required. The location to list backups from. Format is `projects/{project}/locations/{location}`. Use `{location} = '-'` to list backups…","schema":{"type":"string","description":"Required. The location to list backups from. Format is `projects/{project}/locations/{location}`. Use `{location} = '-'` to list backups…"}}],"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"}}}}}}}