# Getting Started Signing in, device selection and account information # Dashboard (Home Screen) The Dashboard is the home screen you land on after signing in. It gathers the **live view of your business** onto one page: how many guests are connected right now, what your campaigns are returning, who your guests are, and whether legal logging is healthy. The data refreshes automatically **every 20 seconds**. > **How do I open this screen?** It opens straight after you sign in. From anywhere else, choose **Dashboard** in the left menu. ![Dashboard home screen](https://help.useroam.com/uploads/images/gallery/2026-08/index.png) The top of the page shows your business name, today's date and the *"Live — refreshes every 20 sec"* indicator. --- ## 1. Live summary cards The four cards in the top row show the current state: - **Guests online now:** the number of devices with an open session on your network. The fastest signal of how busy the venue is. - **Sessions today:** total sessions opened since the start of the day. - **Unique guests this week:** the number of *distinct* guests who connected this week (a returning guest counts once). - **Median dwell (30d):** the *median* — not the average — time guests stayed over the last 30 days. Using the median means one unusually long session cannot distort the figure. --- ## 2. Useroam AI · Autopilot A summary of the AI layer. The card header shows the operating mode (*ACTIVE · semi-automatic*) and the number of **suggestions awaiting approval**. Below it, Autopilot's recent actions are listed; each row is either **Done** or **Pending approval** — for example "noticed a rise in survey scores", "read 8 survey responses", "prepared a win-back for 66 dormant guests". The **Review suggestions** button takes you to **Bumerang → Useroam AI · Autopilot**, where you approve or reject the pending actions. > **What does semi-automatic mean?** Autopilot performs the analysis and preparation itself, but waits for your approval before anything is sent to a guest. --- ## 3. Bumerang performance strip Five summary figures for the marketing layer: - **Active campaigns:** how many campaigns are currently live. - **Sends · 30d:** messages sent to guests over the last 30 days. - **Clicks · 30d:** clicks on the links in those messages. - **Returning guests:** the number and share of guests who came back after a send. - **Net revenue · 30d:** the estimated net revenue attributed to campaigns. ### The Bumerang loop Shows the funnel from send to return: **Sends → Clicks → Returns**. The sentence underneath states the result plainly: *"X out of every 100 sends brought a guest back to your business."* The **Command centre** button opens the Bumerang summary page. ### Top campaigns Ranks the last 30 days' campaigns **by returns**, with campaign name, sends and returns on each row. This is where you see which offer actually works. --- ## 4. Visits and guest behaviour - **Visit trend:** a 30-day chart of unique visitors and sessions, with the period total below it. - **New / returning guests:** what share of your guests come back — the most direct measure of your loyalty work. The **Detailed analytics** button opens **Analytics and Reports → Visit Analytics**. - **Hour × day heatmap:** a heat map crossing the days of the week (Mon–Sun) with hours (0–21). Your busiest slot is named above it. Use it for staff planning and for choosing when to send campaigns. --- ## 5. Last 5 connections Lists the five most recent guests to sign in, with their phone numbers **masked** (for example `55******62`) and their status (*Logged in*). The **All connections** link opens the full list. --- ## 6. Guest profile - **Registered guest count** and the gender split (Male / Female / Not stated). - **Where do they come from?** The top 5 provinces of your registered guests, with counts. - **Registration channel:** how guests log in (SMS / WhatsApp) — it shows which portal module is actually being used. --- ## 7. Legal logging and system status - **5651 live log stream:** the real-time flow of logs from your device. If it reads *"Log data could not be retrieved"*, check the syslog configuration on the firewall. - **5651 signing:** the **Pending**, **Signed** and **To be signed** values (percentage and total quota, e.g. 0% · 10 GB) plus the **Next signing** countdown. If the quota is filling up, keep the 90% warning enabled under **Settings → Notifications**. - **License:** status (Active) and expiry date. - **Device:** the brand and address of the connected firewall (for example *Sophos 10.255.255.1*). --- > **Related pages:** **Bumerang → Summary**, **Analytics and Reports → Visit Analytics**, **Analytics and Reports → 5651 Logs**, **Settings → Device Settings**. # Device Selection The Device Selection screen lists the **firewall / location** records linked to your account. In multi-site businesses this is where you choose which location's panel you are working in; every setting you change applies to the selected device. > **How do I open this screen?** Open **Device Selection** from the account menu at the top right. Accounts with a single device continue straight to that device after signing in. ![Device Selection screen](https://help.useroam.com/uploads/images/gallery/2026-08/select-device.png) --- ## View and search - **Card / List** (on screen: *Kart / Liste*)**:** switches between a card view and a row list. The list view is faster to scan when you have many locations. - **Search:** filters instantly by device name or address. - **Previous / Next:** pages through the devices when they do not fit on one screen. The total is shown below as "1 result • 1–1". --- ## What the device card shows - **Device name:** the name you gave it in the panel (for example *Useroam Demo*). - **Device address:** the device's WAN / management IP address (for example `10.255.255.1`). - **Firewall:** the detected brand (for example *Sophos*). The installation guide and API integration follow from this brand. - **Read-only** label (on screen: *Salt-Okunur*): indicates you have view-only rights on this device and cannot make changes. Clicking a device reloads the panel with that device's data. --- ## New Device The **New Device** button creates a new firewall record. The system selects your license automatically; you fill in the **device type** (brands with an installation guide: Sophos, Fortinet, Palo Alto, Mikrotik, Ruijie), the **device address** (WAN IP) and, where required, **5651 Logging** and the **device serial number**. > **Next step:** after adding the device, follow the page for your brand under **Installation Guides** to configure the firewall side. The RADIUS secret and the portal template are on the **Settings → Device Settings** page. # My Profile (Account Info) The My Profile (Profilim) screen is where the signed-in user manages their own account: personal and company details, panel language, password and two-factor authentication. To manage other users, use **Settings → Administrators**. > **How do I open this screen?** Choose **My Profile (Profilim)** from the account menu at the top right. ![My Profile screen](https://help.useroam.com/uploads/images/gallery/2026-08/accounts-info.png) --- ## 1. My details (Bilgilerim) - **First name (Ad)** and **surname (Soyad)**. - **E-mail (E-Posta):** The address notifications are sent to. - **Panel Language:** *Türkçe* or *English*. Applies immediately and on every sign-in. - **Company address (Firma Adresi):** Used as the party address on contracts. - **KEP address (KEP Adresi):** Registered electronic address for legal notices in Türkiye. Optional. - **Mobile phone (Cep Telefonu):** The **Verify (Doğrula)** button sends a confirmation code to the number. The screen states which number is currently verified; to change it, enter the new number and press Verify again. - **Username (Kullanıcı Adı):** Your sign-in identity. It **cannot be changed**. Changes are written with **Save (Kaydet)**. --- ## 2. Change password (Şifre Değiştir) Three fields: **current password**, **new password** (at least 8 characters) and **new password again**. **Update password** applies the change. --- ## 3. 2FA management Two-factor authentication (an Authenticator app) hardens your account. The tab states whether it is currently active. If you have changed phone or lost access to your Authenticator, you can reset and set it up again: 1. Enter your password in the **current password (verification)** field. 2. Tick the **I confirm I want to reset 2FA** box. 3. Press **Reset 2FA**. After a reset you are asked for a **new QR code at your next sign-in**, which you scan into the Authenticator app again. --- ## 4. API keys The tab where tokens for REST API access are generated — documented on its own page. --- > **Related pages:** **Getting Started → API Keys**; **Settings → Administrators**, **Administrator Profiles**. # API Keys API Keys is the tab where you generate tokens for reaching Useroam's **REST API** from outside. Automation tools (n8n and the like), your own mobile app or an integration connect to the panel with a key generated here. > **How do I open this screen?** Open **My Profile (Profilim)** and switch to the **API Keys** tab. --- ## 1. Creating a key **New key** opens a dialog with three fields: - **Label:** Tells your keys apart — e.g. *n8n integration*, *Mobile App*, *Test*. When you need to revoke one, this is how you find it. - **IP whitelist:** Where the key may be used from. Accepts a single address, a network block (*10.0.0.0/24*) or a comma-separated list. **Every token is restricted to specific IPs** — filling this in is the main layer of security. - **Validity (days):** How many days until the key expires. **Create** generates the key; **Cancel** closes the dialog. > **Copy the key the moment it is created.** For security, tokens are never shown in full again; lose one and you have to generate a replacement. --- ## 2. The key list Generated keys are listed in a table: - **Label:** The name you gave it. - **Key:** The token, abbreviated. - **IP whitelist:** The allowed addresses. - **Created** and **Expires:** Generation and expiry dates. - **Last used:** When the key was last called. A key that has never been used is a forgotten integration — delete it. - **Usage:** Total number of calls. - **Status:** Whether the key is active. --- ## 3. Endpoint list Lower down the page, the API's endpoints are listed under **Endpoint** and **Description**. Use it to find where each kind of data lives, and follow the **How is it used?** link for the detailed reference. --- > **Related pages:** **Getting Started → My Profile (Account Info)**.