List projection documents | Cessy Builder Docs

const url = 'https://cessy.ai/api/rest/tenant-id/app-id/projections/projectionName';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "projection": "userActivityProjection",
  "collection": "userActivities",
  "count": 1,
  "totalCount": 125,
  "documents": [
    {
      "userId": "usr_9f8d7a6b5c4e3d2f1a0b",
      "lastLogin": "2024-06-10T09:15:00Z",
      "actionsPerformed": 342,
      "active": true,
      "roles": [
        "admin",
        "editor"
      ]
    }
  ],
  "pagination": {
    "limit": 1,
    "offset": 0
  },
  "requestedLimit": 1,
  "truncated": true
}

Returns documents from a projection read model. Projection auth rules are applied before data is returned.

Authentication

AuthorizationBearer

Tenant/app API key or OAuth/JWT bearer token.

Path parameters

projectionNamestringRequired

Query parameters

limitintegerOptional1-1000Defaults to 50

offsetintegerOptional>=0Defaults to 0

sortstringOptional

asc, desc, or comma-separated field:direction entries, for example submittedAt:desc,lastName:asc.

filterstringOptional

JSON-encoded filter object. Supports equality, $eq,$ ne, $in,$ nin, $gt,$ gte, $lt,$ lte, $contains,$ startsWith, and $or.

JSON-encoded filter object. Supports equality, $eq, $ne, $in, $nin, $gt, $gte, $lt, $lte, $contains, $startsWith, and $or.

workspaceIdstringOptionalformat: "^ws_[A-Za-z0-9_-]+$"

Optional Workspace runtime selector for preview or validation calls. If supplied with X-CES-Workspace-ID, both values must match.

Response

Projection document page

projectionstring

collectionstring

countinteger

totalCountinteger

documentslist of maps from strings to any

paginationobject

requestedLimitinteger

truncatedboolean

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors