Understanding Lytics / Product Documentation / Account Management

Managing API Tokens

Creating and managing your own API tokens gives you fine-grained control over how your Lytics account and data is accessed. To get started, navigate to Account Settings from the account menu. Note that just like all other account settings, you must have administrator privileges to view and make changes. account menu

Viewing existing API tokens

Select API tokens to view your API tokens. If this is your first time creating an API token, you will see a message prompting you to create a new token.

Once you have created at least one API token, this page will display your tokens, their expiration dates, and the user who created each token.

Creating a new API Token

To create your first token, click the "Create API token" button and fill out the following fields on the sreen that appears:

  • Name (required): Token name
  • Description (optional): Though optional, it's helpful to add a description so each token's purpose is clear.
  • Expiration (required): Token expiration length. Current options include 90 days, 30 days, 7 days, and No expiration which meaning the token is perpetually valid unless manually deleted
  • Roles (required) - Each token can be tailored to have the precise access needed and no more. See Managing Roles for details about each option and select only the ones your token will absolutely need.

Click Generate token to create your token. You will be prompted with a one-time dialog window that contains the API token. Once you dismiss this dialog, it not possible to see it again so please make sure to copy and paste it somewhere secure.

It is also possible to create your own API tokens via the Lytics API.

Deleting an existing API token

When an API token is no longer needed or you otherwise wish to remove one or more tokens, simply click the trash can icon next to the token you wish to remove. Please note that is operation is not reversible and you will be prompted twice before each token is deleted. Anyone or anything depending on that token will break once the token is deleted.