Link creation and slugs
Create links, choose safe custom slugs, and understand expiration and fallback behavior.
ReadDocumentation
Find the setup path, API detail, or product answer you need
Guides, references, and how-to instructions for every feature in Nimriz.
Quick starts
Common paths through the docs
Start with the guide closest to what you are trying to set up.
Create your first link
Build a branded short link and understand safe slug behavior.
Connect a domain
Publish DNS records and verify a branded short domain.
Understand analytics
Learn how clicks, scans, privacy mode, and realtime reporting fit together.
Use the API
Review server-side link creation, slug checks, updates, routing, and conversions.
All documentation
Browse by product area
Each category groups the guides and references that support a specific Nimriz workflow.
Links
5 guides
Password-protected links
Require a password before redirect and troubleshoot unlock prompts and cookie issues.
ReadUTM parameters
Add UTM fields and custom query parameters to links, use presets, and understand current vs historical reporting.
ReadRouting rules and A/B testing
Author per-link routing, run A/B experiments with full lifecycle control, and set up deep links.
ReadCustom QR codes
Style, batch-download, automate, and troubleshoot QR codes, presets, logos, and regeneration behavior.
ReadCards & Pages
5 guides
Virtual business cards
Create hosted digital contact cards with branded short links and QR codes. Add contact details, social profiles, and branded theming.
ReadCustom micro-pages
Create structured hosted pages with bounded blocks, branded short links, QR codes, and privacy-safe engagement analytics.
ReadDocument pages
Publish PDF-first hosted pages with branded short links, QR codes, inline preview, and privacy-safe download analytics.
ReadEvent pages
Publish structured event pages with branded short links, QR codes, built-in RSVP collection, and calendar downloads.
ReadLead capture gates
Collect name, email, phone, or company before revealing a hosted page, then export leads as CSV.
ReadLibrary
1 guide
Spaces and tags
Organize links into spaces and apply tags for flexible filtering, reporting, and exports.
ReadAnalytics
5 guides
Analytics overview
How Nimriz logs click data, the seven analytics sub-pages, privacy modes, and how realtime differs from reporting.
ReadAnalytics definitions
Understand clicks, QR scans, bots, referrers, geo, privacy mode, and dashboard freshness.
ReadRealtime analytics
Use the live event stream to verify campaigns, debug redirects, and understand bot traffic.
ReadConversion tracking
Capture post-click outcomes with the Conversion API: leads, sales, refunds, and more.
ReadExports
Export your link catalog and click-level analytics data as CSV for reporting and integrations.
ReadNimriz Partners
11 guides
Nimriz Partners
Overview of the partner attribution and reconciliation suite, including what it does and does not include.
ReadAvailability and access
Understand Professional and Enterprise availability, workspace access areas, and role permissions.
ReadPartner programs
Create programs with identity, destination, support, terms, application, metadata, and reconciliation context.
ReadPartner records
Manage partner identity, lifecycle, relationship status, contact metadata, tags, notes, and primary programs.
ReadPartner links
Assign partners to branded links and understand one-active-assignment, program defaults, and historical behavior.
ReadAttribution model
How click-time partner snapshots, conversion attribution, negative outcomes, and privacy posture work.
ReadTraffic reporting
Review partner clicks, selected traffic, bots, QR scans, links, sources, referrers, countries, and devices.
ReadConversion reporting
Report on partner-attributed leads, sales, refunds, cancellations, reversals, revenue, and review context.
ReadCommission-ready exports
Export partner-attributed conversion rows for external reconciliation without payout ownership.
ReadTroubleshooting
Fix missing access, empty reports, missing conversion attribution, and export issues.
ReadFAQ
Answers about payouts, portals, application forms, assignment limits, backfills, and commission review.
ReadDomains
3 guides
Domains and DNS
Domain types, status lifecycle, fallback behavior, API access policy, and deep link eligibility.
ReadCustom domain setup
Connect a branded short domain, publish the required DNS records, and verify it step by step.
ReadDNS verification
How verification works, provider-specific record instructions, and what to check when stuck.
ReadTeam & Access
4 guides
Organizations and workspaces
Org and workspace hierarchy, roles, domain grants, materialized access, and governance.
ReadWorkspace switching
Switch workspaces intentionally, understand active context, and fix access issues.
ReadTeam invites and roles
Invite teammates, understand the full capability matrix, and handle expired or mismatched invites.
ReadWorkspace and profile deletion
Workspace and personal deletion, the 30-day grace period, and how to cancel.
ReadAccount & Security
3 guides
Account settings
Manage workspace name, profile details, email, password, appearance, and connected auth methods.
ReadTwo-factor authentication
Set up TOTP, manage recovery codes, and handle workspace 2FA enforcement.
ReadAudit logs
What actions are recorded, how to search and filter the audit log, and how to export it.
ReadIntegrations
16 guides
Integrations overview
How Nimriz uses the catalog, destinations, and actions to forward events to your analytics tools, CDPs, and ad platforms.
ReadGoogle Analytics 4
Send Nimriz click and conversion events to Google Analytics 4 using the Measurement Protocol.
ReadTwilio Segment
Forward Nimriz events to Twilio Segment for downstream warehouse, CDP, and automation workflows.
ReadAmplitude
Send Nimriz click and conversion events to Amplitude for product and campaign analytics.
ReadGeneric HTTP destination
Post Nimriz events to any compatible webhook or HTTP endpoint with custom headers and payload templates.
ReadZapier
Connect Nimriz to Zapier with instant triggers, link actions, and search steps using the native Zapier app.
ReadMake
Automate workflows with the Nimriz custom app on Make using instant webhook triggers and link modules.
Readn8n
Build automations with the official Nimriz community node for n8n, including trigger and operations nodes.
ReadMeta Pixel & Conversions API
Set up Meta Pixel tracking and Conversions API to measure ad performance and retarget users.
ReadGoogle Ads Conversion API
Send offline conversions and click data to Google Ads for better campaign attribution.
ReadLinkedIn Conversions API
Send conversion events server-side to LinkedIn to measure campaign performance.
ReadTikTok Events API
Send conversion events server-side to TikTok to measure campaign performance.
ReadPostHog
Forward click and scan events from Nimriz to PostHog.
ReadMixpanel
Forward click and scan events from Nimriz to Mixpanel.
ReadGTM server-side
Forward raw click and conversion events from Nimriz to your Google Tag Manager server container.
ReadScheduled analytics reports
Automate delivery of workspace analytics summaries via email on a daily, weekly, or monthly schedule.
ReadDevelopers
7 guides
Integration patterns
Server-side calling, retries, idempotency, bulk imports, and conversion tracking patterns.
ReadAPI reference
Full HTTPS API reference: link creation, slug checks, expirations, routing, and conversions.
ReadDestinations API reference
API reference for managing destinations and actions programmatically.
ReadAuth model
Authentication methods, workspace API keys, SSO, and authorization after login.
ReadAPI authentication
Generate, send, rotate, and revoke workspace API keys and partner install tokens.
ReadRate limits and errors
Error codes, retry guidance, and the customer-safe error glossary.
ReadWebhooks
Manage endpoints, verify signed deliveries, handle retries, replay events, and full event schemas.
ReadSupport
1 guide
Troubleshooting
Diagnose redirects, domains, routing, password, analytics, and API issues step by step.
ReadNeed a hand finding the right guide?
Contact support for help with setup, or create a free account and follow the product-backed docs as you go.