What a partner's customers store

Says how many files, and how many bytes, your account keeps, in total and for each of your managed users, and how much of it is in Widgetic’s storage and how much in your own storage destination (setPartnerStorageDestination). Use it to see which customers store the most, or to charge them for it.

A file is counted for a managed user when it was filed under that user: by naming managed_user_id or managed_user_external_id when you upload it (uploadFile, or the metadata of a resumable upload), or because it was uploaded through that user’s editor session, which files everything under its user. The files that are not filed under anyone (your own, and the ones uploaded without naming a managed user) are the row whose managedUserId is null. Deleted files are not counted. To list the files of one managed user, use the managed_user_id filter of listUploads.

The answer is counted when you ask, so it is always current. The groups are ordered by size, the heaviest first, and page.hasMore says whether more follow.

The caller must be the person who administers the partner (an API key of that account works, with the partner:read scope), or a Widgetic administrator.

GET /partners/{partnerId}/storage/usage

TypeScript SDK

TypeScript

import { Configuration, PartnersApi } from '@widgetic/api-sdk-ts';

const partnersApi = new PartnersApi(new Configuration({ apiKey: 'YOUR_API_KEY' }));

// What each customer stores, the heaviest first:
const { data: usage } = await partnersApi.getPartnerStorageUsage({ partnerId });

console.log(usage.totals.totalBytes);
for (const customer of usage.managedUsers) {
  console.log(customer.externalId, customer.totalBytes);
}

200

{
  "success": true,
  "data": {
    "partnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "totals": null,
    "managedUsers": [
      "Example PartnerStorageUsageOfManagedUser"
    ],
    "page": null
  },
  "meta": {
    "page": 1,
    "size": 20,
    "total": 135,
    "limit": 20,
    "offset": 0,
    "hasNextPage": true,
    "hasPreviousPage": false,
    "nextCursor": "<string>",
    "warnings": [
      "<string>"
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

partnerId · string<uuid> · required

The partner whose storage to report on

Query Parameters

limit · integer · default: 50

How many managed users to list at most

Required range: 1 <= x <= 100

offset · integer · default: 0

How many managed users to skip

Required range: 0 <= x <= 100000

Response

200

application/json

What the partner's customers store

success · boolean · required

Always true on a success.

Example:

true

data · object · required

What a partner's customers store. totals is every file kept for the partner's account; managedUsers splits it by the managed user each file is filed under, the heaviest first.

Show child attributes

Example:

{
  "partnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "totals": null,
  "managedUsers": ["Example PartnerStorageUsageOfManagedUser"],
  "page": null
}

meta · object

Extra information about the answer: where a page sits in a list, the cursor of the next page, or warnings about a call that succeeded with a caveat.

Show child attributes