Docs Page

The platforms power is in its simplicity. Select a subject for detailed related to the topic.

Accounts

You can create an account in one of two ways.

Email-registered Sign-up: Go to the Login/Register page, enter your email address, and submit. You will then receive an "email magic link" via email. The magic link is a unique login token that grants access to your account for 15 minutes. Please use it within this time frame as it can only be used once.

Invite-registered Sign-up: If you've been invited to join a project, follow the "magic link" provided by the inviter. You'll then see the invite in your notifications tray and can complete the sign-up process.

Note: For more information invites, see the Invites section.

Projects

Create projects from the Admin Page.

A project requires two essential details: A title and an account type. Please note that once set, the account type cannot be changed or downgraded. If you delete a project, it will automatically cancel any outstanding payment for the next month.

After creating a project: Navigate to the Admin Page and click on your project's name to access its API keys and members section. From here, you can generate API keys to enable API requests. For more information about inviting team members, refer to the Invites section of these documentation.

Note: For more information on using api keys see the Api Keys section. If you need more information about logs ina project see the Logs section.

Api Keys

Create Api Keys from the project admin page.

Api Keys are used to POST logs: After posting your logs, they will be shown on the dashboard page for that project

The Api key must be present in an Authorization header: the body most contain a msg, type, and utc type stamp.

Note: For more information on viewing logs created, see the Logs section of the docs.

Logs

Logs are created using the api key with a POST request.

Info: Info is meant for client information such as load times and user stories. Use this to get an idea of how the client is being used.

Error: Errors are meant to be inserted in your error and edge case handling. Use these to be notified about un expected behavior, and to track down hard to recreate bugs.

Note: For more information on creating logs, see the Api Keys section.

Invites

Only admins of a project have the ability to invite users.

How to invite: You can invite people to a project from the admin screen for the project. Enter their email address and click submit. The user will be sent an email to login and they will see the invite in their notifications tray. They do not need to have an existing account to be invited to a project—an account will be created for them automatically when they follow the link.

Note: If the person you invited doesn't have an account and doesn't follow the "magic link" you sent them in the invite, they will still be able to join the project. The notification to join will remain in their notifications tray.