문서 애그리게이션

POST /action/aggregate
AccessToken 이메일 & 비밀번호 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"
}