聚合文档

发布 /action/aggregate
访问令牌 电子邮件和密码 Api key Custom jwt

运行聚合管道。

body

  • dataSource 字符串 必需

    链接的 MongoDB Atlas 数据源的名称。它通常为 "mongodb-atlas"，但如果您在创建数据源时选择了不同的名称，则在应用程序中可能具有不同的名称。

  • database 字符串 必需

    指定的数据源中的数据库名称。

  • 集合 字符串 必需

    指定的数据库中的集合名称。

  • 管道 大量[对象] 必需

    聚合阶段数组。

    MongoDB聚合阶段。有关数据API支持的所有聚合阶段的列表，请参阅 聚合管道阶段可用性 。

    MongoDB聚合阶段。有关数据API支持的所有聚合阶段的列表，请参阅 聚合管道阶段可用性 。

body

  • dataSource 字符串 必需

    链接的 MongoDB Atlas 数据源的名称。它通常为 "mongodb-atlas"，但如果您在创建数据源时选择了不同的名称，则在应用程序中可能具有不同的名称。

  • database 字符串 必需

    指定的数据源中的数据库名称。

  • 集合 字符串 必需

    指定的数据库中的集合名称。

  • 管道 大量[对象] 必需

    聚合阶段数组。

    MongoDB聚合阶段。有关数据API支持的所有聚合阶段的列表，请参阅 聚合管道阶段可用性 。

    MongoDB聚合阶段。有关数据API支持的所有聚合阶段的列表，请参阅 聚合管道阶段可用性 。

响应

  • 200

    Success

    隐藏响应属性 显示响应属性 对象
    • 文档 大量[对象] 必需

      包含聚合结果设立的大量。

      聚合结果设立包含的文档。

      聚合结果设立包含的文档。

    隐藏响应属性 显示响应属性 对象
    • 文档 大量[对象] 必需

      包含聚合结果设立的大量。

      聚合结果设立包含的文档。

      聚合结果设立包含的文档。
  • 400 application/json

    请求格式不正确或不完整。

    以下之一：
    ErrorNoAuthenticationSpecified对象 ErrorMissingAuthenticationParameter 对象
  • 401 application/json

    经过身份验证的用户没有访问权限此端点的权限。

    隐藏响应属性 显示响应属性 对象

    表示没有用户与提供的身份验证凭证匹配。

    • 错误 字符串

      描述错误的消息。

      值为 invalid session: error finding user for endpoint。

    • error_code 字符串

      错误类型。

      值为 InvalidSession。

    • 链接 字符串

      指向失败操作的日志条目的链接。
POST / 动作/aggregate 
curl -s "https://data.mongodb-api.com/app/$CLIENT_APP_ID/endpoint/data/v1/action/aggregate" \
  -X POST \
  -H "apiKey: $API_KEY" \
  -H 'Content-Type: application/ejson' \
  -H "Accept: application/json" \
  -d '{
    "dataSource": "mongodb-atlas",
    "database": "learn-data-api",
    "collection": "tasks",
    "pipeline": [
      {
        "$match": { "status": "complete" }
      },
      {
        "$group": {
          "_id": "$status",
          "count": { "$sum": 1 },
          "tasks": { "$push": "$text" }
        }
      },
      {
        "$sort": { "count": -1 }
      }
    ]
  }'
请求示例 
[
  {
    "$groupBy": {
      "_id": "$status",
      "count": {
        "$sum": 1
      },
      "tasks": {
        "$push": "$text"
      }
    }
  },
  {
    "$sort": {
      "count": 1
    }
  }
]
请求示例 
[
  {
    "$groupBy": {
      "_id": "$status",
      "count": {
        "$sum": 1
      },
      "tasks": {
        "$push": "$text"
      }
    }
  },
  {
    "$sort": {
      "count": 1
    }
  }
]
响应示例 (200) 
[
  {
    "$groupBy": {
      "_id": "$status",
      "count": {
        "$sum": 1
      },
      "tasks": {
        "$push": "$text"
      }
    }
  },
  {
    "$sort": {
      "count": 1
    }
  }
]
响应示例 (200) 
[
  {
    "$groupBy": {
      "_id": "$status",
      "count": {
        "$sum": 1
      },
      "tasks": {
        "$push": "$text"
      }
    }
  },
  {
    "$sort": {
      "count": 1
    }
  }
]
响应示例 (400) 
{
  "error": "no authentication methods were specified",
  "error_code": "InvalidParameter",
  "link": "string"
}
{
  "error": "must specify some form of authentication (either email+password, api-key, or jwt) in the request header or body",
  "error_code": "MissingParameter",
  "link": "string"
}
响应示例 (401) 
{
  "error": "invalid session: error finding user for endpoint",
  "error_code": "InvalidSession",
  "link": "string"
}