Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 1.75 KB

README-ADMIN.md

File metadata and controls

48 lines (33 loc) · 1.75 KB

cometx admin

To use the cometx admin functions, you must be in an environment with Python installed.

First, install the cometx Python library:

pip install cometx --upgrade

Next, copy your COMET_API_KEY. Login into your Comet installation, and click on your image in the upper-righthand corner, select API Key, and click on key to copy:

image

Finally run the following:

export COMET_API_KEY=<COPY YOUR API KEY HERE>

cometx admin chargeback-report 2024-09

for the September 2024 chargeback report. Change the year or month as required.

Advanced

If your installation does not support Comet Smart Keys, or your host is at an unusual location, you can also use the --host flag as shown:

cometx admin chargeback-report 2024-09 --host https://another-url.com

The usage report contains the following fields in JSON format:

  • "numberOfUsers": total user entries in the report
  • "createdAt": date the report was generated,
  • "organizationId": The Comet org id

Each user entry in the report contains:

  • “username”: The user’s Comet username.
  • “email”: The user’s email address associated with Comet.
  • “created_at”: The date the user was created.
  • “deletedAt”: The date the user was deleted (for deleted users only).
  • “suspended”: boolean flag true/false to indicate if the user has been suspended.
  • “uiUsageCount”: Number of UI interactions a user has made.
  • “uiUsageUpdateTs”: Timestamp of the last update to uiUsageCount.
  • “sdkUsageCount”: Number of SDK interactions a user has made.
  • “sdkUsageUpdateTs”: Timestamp of the last update to sdkUsageCount.