Run Aggregation Query Document
firestore.run_aggregation_query_document
ActionDatabases & warehousesconnection required
Calls firestore v1 POST /v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:runAggregationQuery.
Runs an aggregation query.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Google Firestore
- Secret shape
- {"client_id", "client_secret", "refresh_token"}
- Config it needs
- project_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
4 fields, 4 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
database Database name or id. | string | Yes | — | — | — |
document Document name or id. | string | Yes | — | — | — |
documents_id1 Documents id1 name or id. | string | Yes | — | — | — |
body The RunAggregationQueryRequest resource, as the API defines it. | object | Yes | — | — | — |
Output
One shape.
result
Extra keys beyond the ones listed can appear.
| Field | Type | Example |
|---|---|---|
explainMetrics | object | — |
readTime | string | — |
result | object | — |
transaction | string | — |
{
"explainMetrics": {},
"readTime": "",
"result": {},
"transaction": ""
}See Run Aggregation Query Document run in a workflow.
In a technical demo we add the Google Firestore connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.