The platforms power is in its simplicity. Select a subject for detailed related to the topic.
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 a "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.
Create projects from the Home Page.
Creating a project: You'll need to have saved a payment method before you will be able to create a project. A project is where the logs will be stored, and can be created from the Home page, where you will often be directed when you log in. When you first create an account you will be taken to the billing page to save a payment method.
After creating a project: You will see a projects table to right on large screens, bottom on small. In the rows you will see cells for:
Name - click here to be taken to logs
WH - click here to create a new webhook
Users - click to manage a team
Keys - click to manage api keys for the project
Delete - click to delete logs, remove users, and delete project
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.
Creating API Keys: You can creat the api keys by clicking the link in table on the home screen. After creating a project you will see a "0" as a link. Click to add a key you can then use to post logs with.
After posting your logs, they will be shown on the dashboard page for that project. If you have a webhook set up, the webhook will be triggered as well.
The Api key must be present in an Authorization header: the body must contain a msg, and type. A message can be any string, and the type can be either "log" or "error". In addition, you may also pass an optional "sessionId" string, and a "data" field that can contain any object. Use a sessionId to track activity in a session and the data to pass state for things you are trying to log.
curl -X POST https://logida.app/api/log
-H "Content-Type: application/json"
-H "Authorization: api_key_goes_here"
-d '{
"message": "Fun And New",
"type": "log",
"clientId": "111",
"data": {
"moreData": {
"msg": "data is open to any structure you need to save"
}
}
}'Note: For more information on viewing logs created, see the Logs section of the docs.
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.
Viewing Logs: You can view logs from the Project logs page. You access it by clicking on the projects name, from the home page. From there you will be able to see logs coming in real time and filter by its type, message, client ID, and timestamps.
Posting a new log:: You will need to create an API key, and post a log using an http POST request.
curl -X POST https://logida.app/api/log
-H "Content-Type: application/json"
-H "Authorization: api_key_goes_here"
-d '{
"message": "Fun And New",
"type": "log",
"clientId": "111",
"data": {
"moreData": {
"msg": "data is open to any structure you need to save"
}
}
}'Note: For more information on creating logs, see the Api Keys section.
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 emailed a login link, and they will see the invite in their notifications' tray after logging in. 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.
When you are sent an invite: You will receive an invitation as an email. The email will contain the magic link, and the terms of service to use the platform. Following the login link will accept TOS and take you to the platform where you will be automatically logged in. In the upper right you will see a notification. Click the notification to open the notifications tray and accept the invite. As an invitee you will be given access to view logs generated by project API keys.
Creating a Webhook: 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 emailed a login link, and they will see the invite in their notifications' tray after logging in. 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.
Using a Webhook: You will receive an invitation as an email. The email will contain the magic link, and the terms of service to use the platform. Following the login link will accept TOS and take you to the platform where you will be automatically logged in. In the upper right you will see a notification. Click the notification to open the notifications tray and accept the invite. As an invitee you will be given access to view logs generated by project API keys.
Accessing Archives: You can access the Archives page by opening a project's logs and clicking the "Archives" button. Here, logs are organized by week since the project's creation. Each row includes options to download or delete that week's logs.
Downloading Backups: Each row has a button to download that week's logs as a CSV file.
Deleting Backups: If you no longer need a week's logs stored in our system, you can delete them one week at a time. Removing unneeded logs can reduce your bill, as you are charged for data stored on the system.
Re-Uploading Logs: To save on storage costs, you can delete logs you no longer need. As long as you've downloaded a backup first, you can re-upload them at any time to regain full insights and filtering. See the Upload section for more details.
Uploading Logs: You can access the upload screen by opening the project logs page and clicking "Upload."
Formatting: Uploaded files must be CSV formatted and match the structure of downloaded logs. To check the expected format, try downloading an existing batch of logs first.
Logs Testing: You can download a week's worth of logs by accessing the project logs page, then clicking archives. On this screen you will see rows for each week since the project's creation and a link to download the batch of logs. The formatting must match to upload properly again. See "Archives" to learn more.