Cuerpo

  • dataSource string Requerido

    El nombre de una fuente de datos de MongoDB Atlas vinculada. Suele ser "mongodb-atlas", aunque puede ser diferente en tu aplicación si elegiste un nombre diferente al crear la fuente de datos.

  • database string Requerido

    El nombre de una base de datos en la fuente de datos especificada.

  • Colección string Requerido

    El nombre de una colección en la base de datos especificada.

  • pipeline matriz[objeto] Requerido

    Una serie de etapas de agregación.

    Una etapa de agregación de MongoDB. Para obtener una lista de todas las etapas de agregación compatibles con la API de datos, consulte Disponibilidad de la etapa de canalización de agregación.

    Una etapa de agregación de MongoDB. Para obtener una lista de todas las etapas de agregación compatibles con la API de datos, consulte Disponibilidad de la etapa de canalización de agregación.

Cuerpo

  • dataSource string Requerido

    El nombre de una fuente de datos de MongoDB Atlas vinculada. Suele ser "mongodb-atlas", aunque puede ser diferente en tu aplicación si elegiste un nombre diferente al crear la fuente de datos.

  • database string Requerido

    El nombre de una base de datos en la fuente de datos especificada.

  • Colección string Requerido

    El nombre de una colección en la base de datos especificada.

  • pipeline matriz[objeto] Requerido

    Una serie de etapas de agregación.

    Una etapa de agregación de MongoDB. Para obtener una lista de todas las etapas de agregación compatibles con la API de datos, consulte Disponibilidad de la etapa de canalización de agregación.

    Una etapa de agregación de MongoDB. Para obtener una lista de todas las etapas de agregación compatibles con la API de datos, consulte Disponibilidad de la etapa de canalización de agregación.

Respuestas

  • Éxito

    Ocultar atributo de respuesta Mostrar atributo de respuesta Objeto
    • Documentos matriz[objeto] Requerido

      Una matriz que contiene el conjunto de resultados de la agregación.

      Un documento incluido en el conjunto de resultados de la agregación.

      Un documento incluido en el conjunto de resultados de la agregación.

    Ocultar atributo de respuesta Mostrar atributo de respuesta Objeto
    • Documentos matriz[objeto] Requerido

      Una matriz que contiene el conjunto de resultados de la agregación.

      Un documento incluido en el conjunto de resultados de la agregación.

      Un documento incluido en el conjunto de resultados de la agregación.

  • 400 aplicación/json

    La solicitud estaba mal formada o incompleta.

    Uno de:
  • 401 aplicación/json

    El usuario autenticado no tiene permiso para acceder a este punto final.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto

    Indica que ningún usuario coincidió con las credenciales de autenticación proporcionadas.

    • Error string

      Un mensaje que describe el error.

      El valor es invalid session: error finding user for endpoint.

    • error_code string

      El tipo de error.

      El valor es InvalidSession.

POST /acción/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 }
      }
    ]
  }'
Ejemplo de solicitud
[
  {
    "$groupBy": {
      "_id": "$status",
      "count": {
        "$sum": 1
      },
      "tasks": {
        "$push": "$text"
      }
    }
  },
  {
    "$sort": {
      "count": 1
    }
  }
]
Ejemplo de solicitud
[
  {
    "$groupBy": {
      "_id": "$status",
      "count": {
        "$sum": 1
      },
      "tasks": {
        "$push": "$text"
      }
    }
  },
  {
    "$sort": {
      "count": 1
    }
  }
]
Ejemplos de respuestas (200)
[
  {
    "$groupBy": {
      "_id": "$status",
      "count": {
        "$sum": 1
      },
      "tasks": {
        "$push": "$text"
      }
    }
  },
  {
    "$sort": {
      "count": 1
    }
  }
]
Ejemplos de respuestas (200)
[
  {
    "$groupBy": {
      "_id": "$status",
      "count": {
        "$sum": 1
      },
      "tasks": {
        "$push": "$text"
      }
    }
  },
  {
    "$sort": {
      "count": 1
    }
  }
]
Ejemplos de respuestas (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"
}
Ejemplos de respuestas (401)
{
  "error": "invalid session: error finding user for endpoint",
  "error_code": "InvalidSession",
  "link": "string"
}