Get organization usage summary | Grist Octri Preview

1 parameter

orgIdintegerrequired

This can be an integer id, or a string subdomain (e.g. `gristlabs`), or `current` if the org is implied by the domain in the url

1 status code

200Usage summary

attachmentsobjectoptional

countsByDataLimitStatusobjectoptional

Count of documents grouped by data limit status

import { GristFullAPIOctriPreview } from "grist-octri-preview-sdk";

const client = new GristFullAPIOctriPreview({
  baseUrl: "https://docs.getgrist.com/api",
  auth: { apiKey: process.env.API_TOKEN! },
});

const result = await client.orgs.getUsage({ orgId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" });

{
  "attachments": {
    "limitExceeded": true,
    "totalBytes": 42
  },
  "countsByDataLimitStatus": {
    "approachingLimit": 1,
    "deleteOnly": 1,
    "gracePeriod": 1
  }
}

Request

Response