← Help centre

Onyx — User Guide

For everyone working in a workspace day to day. What you can see and do is governed by your role and data scope — if a screen shows a "no permission" notice, that's by design; ask your admin.

Signing in

Your workspace URL + email + password (and a 6-digit authenticator code if you've enabled 2FA — see Settings → Security). You can also Continue with Google when the Google account uses the same e-mail as your membership, or sign in with a passkey registered under Settings → Security. Forgot password sends a one-hour reset link. The interface runs fully in English or Arabic (RTL); switch from the header. Light and dark themes follow the toggle.

Dashboard

KPIs (views, reach, engagement, engagement rate, followers, growth, posts) for the selected period, versus the previous period. The trend chart and platform donut break the same numbers down; platform cards show per-network summaries; top posts previews the leaders.

Filters — client, creator, campaign, platforms, content type, period — apply everywhere on the page and are carried in the URL, so a filtered view can be bookmarked or shared with a colleague. The freshness badge in the header shows when data last synced; a failing account shows there too.

Export to Excel queues a workbook of the current view (background — you're notified when the file is ready). Numbers in exports match the dashboard exactly.

Comparison

Comparison (sidebar): pick a dimension — creators, platforms or campaigns — then 2 to 6 entities. You get their KPIs side by side and one trend line per entity for the chosen period.

Posts

The post explorer lists every tracked publication with serial, platform, creator, views, engagement and publish date, under the same filter bar.

  • Expand a row for the per-platform breakdown of that content item — metrics per network, links to the originals, last refresh time, and screenshot evidence for manual entries.
  • Edit title/content type inline; bulk-set content type via the selection tray. Posts marked Manual carry the manual-data provenance badge.
  • Export posts to Excel queues the list as a workbook.

Manual entries

For platforms without a connected API. Posts → Manual entry: pick creator, platform, date, account- or post-level, enter the metric values, optionally attach a screenshot as evidence and a post link. CSV import handles bulk backfills and reports per-row errors. Depending on workspace settings, entries may need approval before they count.

Clients & campaigns

  • Clients: company records with contacts, status, an activity timeline and a financial summary (quoted / invoiced / paid / outstanding).
  • Campaigns: linked to a client, with participating creators, platforms, budget and auto-tagging rules (hashtags, mentions, keywords). Posts matching the rules within the campaign window are tagged automatically as they sync. The campaign page shows scoped analytics, tagged posts, budget vs spend and margin — and Campaign report queues a branded PDF for the campaign period in one click.

Finance

  • Quotations: line items (free-form), automatic totals with tax, send → accept → convert to invoice carries everything over.
  • Invoices: sequential numbers that are never reused; send, record (partial) payments, watch status move Draft → Sent → Partially paid → Paid — or Overdue automatically once the due date passes. Documents render as branded PDFs (Arabic fully supported) and can be emailed.
  • Expenses: record against campaigns, approval flow, mark paid; campaign profitability updates live.

Reports

Reports (sidebar): build a report — scope (workspace / client / campaign / creator), period, language (EN/AR), sections (cover, KPI summary, trends, platform breakdown, top posts, creator breakdown, disclaimer, commentary) and your written commentary. Templates save a section set for reuse; scheduled templates deliver weekly/monthly by email with the PDF attached.

Generated reports land in the library with a version number — regenerating the same scope+period makes a v2, never overwrites. A report shows Processing until its PDF is rendered (usually under a minute). If rendering fails you are notified and the row shows Failed — Retry renders it again in place; if it fails again, contact your admin or support. From the library: download the PDF, or Share — an expiring link (optional password) to a public page where your client downloads the PDF without an account. Every access of a shared link is logged.

If any manual data is inside the period, the PDF carries a manual-data disclaimer section automatically.

Followers & goals

Followers shows daily gains per account with a goal line. Set a goal (target and date) from the card menu; progress and the projected finish date update after every sync, and the table exports to Excel.

Saved views

Any dashboard filter combination can be saved from the filter bar (Save view). Views are yours alone; mark one as default and the dashboard opens with it.

Pipeline

Clients → Pipeline is the deal board. Drag a card between stages or use the card menu; the stage history stays on the client record. Custom fields your admin defined appear on every client card and in the list filters.

AI assistants

On the Scale plan, Settings → AI assistants connects Claude, ChatGPT, Cursor, Claude Code or any other assistant that supports remote MCP servers to your workspace. The assistant can read what your role allows — dashboards, posts, clients, invoices, reports — and can never create, change or delete anything. Ask it things like "which creator had the most views last month?" or "summarise the Ramadan campaign for the client". Disconnect an assistant any time from the same screen.

Notifications

The bell in the header lists unread notifications; open one to jump to the item, or Mark all read. Every notification is also emailed to you with a link back to the item (sync failures, expiring account access, overdue invoices, ready or failed reports, exports, follow-up reminders, trial and renewal notices). Switch any kind off, in-app or email, under your profile — or use the one-click unsubscribe link at the bottom of any of these e-mails, which switches off that kind only.

Help

This guide is always available from the ? icon in the header. For anything it doesn't answer, write to support@onyxksa.com.