corpo, corpo

  • dataSource string Obrigatório

    O nome de uma fonte de dados vinculada do MongoDB Atlas. Normalmente é "mongodb-atlas", embora isso possa mudar em seu aplicativo se você tiver escolhido outro nome ao criar a fonte de dados.

  • database string Obrigatório

    O nome de um banco de dados na fonte de dados especificada.

  • collection string Obrigatório

    O nome de uma collection no banco de dados especificado.

  • gasoduto array[objeto] Obrigatório

    Uma variedade de estágios de agregação.

    Um estágio de agregação MongoDB . Para obter uma lista de todos os estágios de agregação compatíveis com a Data API, consulte Disponibilidade do estágio do aggregation pipeline.

    Um estágio de agregação MongoDB . Para obter uma lista de todos os estágios de agregação compatíveis com a Data API, consulte Disponibilidade do estágio do aggregation pipeline.

corpo, corpo

  • dataSource string Obrigatório

    O nome de uma fonte de dados vinculada do MongoDB Atlas. Normalmente é "mongodb-atlas", embora isso possa mudar em seu aplicativo se você tiver escolhido outro nome ao criar a fonte de dados.

  • database string Obrigatório

    O nome de um banco de dados na fonte de dados especificada.

  • collection string Obrigatório

    O nome de uma collection no banco de dados especificado.

  • gasoduto array[objeto] Obrigatório

    Uma variedade de estágios de agregação.

    Um estágio de agregação MongoDB . Para obter uma lista de todos os estágios de agregação compatíveis com a Data API, consulte Disponibilidade do estágio do aggregation pipeline.

    Um estágio de agregação MongoDB . Para obter uma lista de todos os estágios de agregação compatíveis com a Data API, consulte Disponibilidade do estágio do aggregation pipeline.

Respostas

  • Sucesso

    Ocultar atributo de resposta Mostrar atributo de resposta objeto
    • documentos array[objeto] Obrigatório

      Uma array que contém o conjunto de resultados da agregação.

      Um documento incluído no conjunto de resultados da agregação.

      Um documento incluído no conjunto de resultados da agregação.

    Ocultar atributo de resposta Mostrar atributo de resposta objeto
    • documentos array[objeto] Obrigatório

      Uma array que contém o conjunto de resultados da agregação.

      Um documento incluído no conjunto de resultados da agregação.

      Um documento incluído no conjunto de resultados da agregação.

  • 400 aplicação/json

    A solicitação estava malformada ou incompleta.

    Um dos seguintes:
  • 401 aplicação/json

    O usuário autenticado não tem permissão para acessar este endpoint.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto

    Indica que nenhum usuário correspondeu às credenciais de autenticação fornecidas.

    • Erro string

      Uma mensagem que descreve o erro.

      O valor é invalid session: error finding user for endpoint.

    • error_code string

      O tipo de erro.

      O valor é InvalidSession.

POST /ação/agregado
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 }
      }
    ]
  }'
exemplo de solicitação
[
  {
    "$groupBy": {
      "_id": "$status",
      "count": {
        "$sum": 1
      },
      "tasks": {
        "$push": "$text"
      }
    }
  },
  {
    "$sort": {
      "count": 1
    }
  }
]
exemplo de solicitação
[
  {
    "$groupBy": {
      "_id": "$status",
      "count": {
        "$sum": 1
      },
      "tasks": {
        "$push": "$text"
      }
    }
  },
  {
    "$sort": {
      "count": 1
    }
  }
]
Exemplos de resposta (200)
[
  {
    "$groupBy": {
      "_id": "$status",
      "count": {
        "$sum": 1
      },
      "tasks": {
        "$push": "$text"
      }
    }
  },
  {
    "$sort": {
      "count": 1
    }
  }
]
Exemplos de resposta (200)
[
  {
    "$groupBy": {
      "_id": "$status",
      "count": {
        "$sum": 1
      },
      "tasks": {
        "$push": "$text"
      }
    }
  },
  {
    "$sort": {
      "count": 1
    }
  }
]
Exemplos de resposta (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"
}
Exemplos de resposta (401)
{
  "error": "invalid session: error finding user for endpoint",
  "error_code": "InvalidSession",
  "link": "string"
}