Documentation

Find the setup path, API detail, or product answer you need

Guides, references, and how-to instructions for every feature in Nimriz.

All documentation

Browse by product area

Each category groups the guides and references that support a specific Nimriz workflow.

Links

4 guides

Link creation and slugs

Create branded links, choose safe custom slugs, understand reserved paths, and manage expiration or fallback behavior before campaigns go live.

Read

Password-protected links

Require a password before redirect, decide when protected links fit, and troubleshoot visitor unlock prompts, cookies, and fallback behavior.

Read

UTM parameters

Add UTM fields and custom query parameters to links, use presets, and understand current vs historical reporting.

Read

Routing rules and A/B testing

Author per-link routing, run A/B experiments with full lifecycle control, and set up deep links.

Read

QR Codes

5 guides

QR Codes dashboard

Use the QR Codes area to manage saved QR assets, static QR codes, QR pages, Retail & GS1, and QR exports.

Read

Static QR codes

Create fixed QR codes, save them in your workspace, organize them into folders, and import or export static QR assets.

Read

Custom QR codes

Style, batch-download, automate, and troubleshoot link-backed QR codes, presets, logos, and regeneration behavior.

Read

QR pages

Create structured QR pages for business profiles, menus, coupons, ratings, feedback, social hubs, and app-store routing.

Read

Retail & GS1 QR codes

Create product-backed GS1 Digital Link QR and GS1 DataMatrix assets with standards-aware validation.

Read

Cards

1 guide

Virtual business cards

Create hosted digital contact cards with branded short links, QR codes, wallet actions, contact details, social profiles, and branded theming.

Read

Pages

4 guides

Custom micro-pages

Create structured hosted pages with bounded blocks, branded short links, QR codes, and privacy-aware engagement analytics.

Read

Document pages

Publish PDF-first hosted pages with branded short links, QR codes, inline preview, and privacy-aware download analytics.

Read

Event pages

Publish structured event pages with branded short links, QR codes, built-in RSVP collection, and calendar downloads.

Read

Lead capture gates

Set up hosted-page lead gates, choose fields, collect consent-aware submissions, and export leads as CSV for follow-up.

Read

Library

1 guide

Spaces and tags

Organize large link libraries with spaces and tags so filtering, reporting, exports, and campaign cleanup stay easier to manage.

Read

Analytics

4 guides

Analytics overview

How Nimriz logs click data, privacy modes, sanitized referrers, unique clicks, and realtime versus reporting.

Read

Analytics definitions

Understand how Nimriz defines clicks, QR scans, bots, referrers, geography, privacy modes, dashboard freshness, and reporting limits.

Read

Realtime analytics

Use the realtime event stream to verify campaign launches, debug redirects, inspect QR scans, and separate human traffic from bot activity.

Read

Conversion tracking

Capture post-click outcomes with the Conversion API, including leads, sales, refunds, cancellations, and attribution context.

Read

Exports

1 guide

Exports

Export your link catalog and click-level analytics data as CSV for reporting and integrations.

Read

Partners

11 guides

Nimriz Partners

Overview of the partner attribution and reconciliation suite, including what it does and does not include.

Read

Availability and access

Understand Professional and Enterprise availability, workspace access areas, and role permissions.

Read

Partner programs

Create programs with identity, destination, support, terms, application, metadata, and reconciliation context.

Read

Partner records

Manage partner identity, lifecycle, relationship status, contact metadata, tags, notes, and primary programs.

Read

Partner links

Assign partners to branded links and understand one-active-assignment, program defaults, and historical behavior.

Read

Attribution model

How click-time partner snapshots, conversion attribution, negative outcomes, and privacy posture work.

Read

Traffic reporting

Review partner clicks, selected traffic, bots, QR scans, links, sources, referrers, countries, and devices.

Read

Conversion reporting

Report on partner-attributed leads, sales, refunds, cancellations, reversals, revenue, and review context.

Read

Commission-ready exports

Export partner-attributed conversion rows for external reconciliation without payout ownership.

Read

Troubleshooting

Fix missing access, empty reports, missing conversion attribution, and export issues.

Read

Nimriz Partners FAQ

Answers about partner payouts, portals, application forms, assignment limits, backfills, reporting boundaries, and commission review workflows.

Read

Domains

3 guides

Domains and DNS

Domain types, status lifecycle, fallback behavior, API access policy, and deep link eligibility.

Read

Custom domain setup

Connect a branded short domain, publish the required DNS records, verify ownership, and troubleshoot setup before sharing campaign links.

Read

DNS verification

Learn how DNS verification works, where to publish provider-specific records, and what to check when a custom domain is stuck.

Read

Team & Access

4 guides

Organizations and workspaces

Understand organization and workspace hierarchy, role boundaries, domain grants, materialized access, and governance behavior.

Read

Workspace switching

Switch workspaces intentionally, understand the active workspace context, and fix access or membership issues without editing the wrong account.

Read

Team invites and roles

Invite teammates, choose workspace roles, understand the capability matrix, and handle expired or mismatched invitations.

Read

Workspace and profile deletion

Understand workspace deletion, personal profile deletion, the 30-day grace period, cancellation behavior, and what happens to access.

Read

Account & Security

4 guides

Account settings

Manage workspace name, profile details, email, password, appearance, and connected auth methods.

Read

Two-factor authentication

Set up TOTP two-factor authentication, manage recovery codes, handle workspace enforcement, and recover access when challenges fail.

Read

Audit logs

What actions are recorded, how to search and filter the audit log, and how to export it.

Read

Cookie preferences

Choose optional functional, analytics, and marketing cookies and understand how preferences apply.

Read

Integrations

17 guides

Integrations overview

How Nimriz uses destinations and actions to forward privacy-aware events to analytics tools, CDPs, and ad platforms.

Read

Google Analytics 4

Send Nimriz click and conversion events to Google Analytics 4 using the Measurement Protocol.

Read

Twilio Segment

Forward Nimriz events to Twilio Segment for downstream warehouse, CDP, and automation workflows.

Read

Amplitude

Send Nimriz click and conversion events to Amplitude for product and campaign analytics.

Read

Generic HTTP destination

Post Nimriz events to any compatible webhook or HTTP endpoint with custom headers and payload templates.

Read

Zapier

Connect Nimriz to Zapier with OAuth or API-key auth, instant triggers, link actions, and search steps.

Read

Make

Automate workflows with the Nimriz custom app on Make using invitation-based API-key auth, instant webhooks, and link modules.

Read

n8n integration setup

Build n8n automations with the Nimriz node using OAuth or API-key credentials, trigger nodes, and link operation nodes.

Read

Meta Pixel & Conversions API

Set up Meta Pixel tracking and the Conversions API for reviewed campaign links so ad measurement and retargeting stay better connected.

Read

Google Ads Conversion API

Send offline conversions and click attribution data to Google Ads so campaign reporting can connect ad clicks to downstream outcomes.

Read

LinkedIn Conversions API

Send conversion events server-side to LinkedIn so B2B campaign reporting can connect Nimriz clicks to downstream outcomes.

Read

TikTok Events API

Send conversion events server-side to TikTok so campaign reporting can connect short-link traffic to downstream outcomes.

Read

Ad Pixel Interstitial

Configure an opt-in interstitial pixel step for reviewed campaign link workflows.

Read

PostHog

Forward click and scan events from Nimriz to PostHog.

Read

Mixpanel event forwarding

Forward Nimriz click and QR scan events to Mixpanel so product and marketing teams can analyze campaign behavior with existing funnels.

Read

GTM server-side

Forward privacy-safe click and conversion events from Nimriz to your Google Tag Manager server container.

Read

Scheduled analytics reports

Automate delivery of workspace analytics summaries via email on a daily, weekly, or monthly schedule.

Read

Developers

8 guides

Integration patterns

Server-side calling, retries, idempotency, bulk imports, and conversion tracking patterns.

Read

API reference

Use the HTTPS API reference for link creation, slug checks, expirations, routing, conversions, QR workflows, analytics, and integrations.

Read

Destinations API reference

Use the Destinations API reference to manage integration destinations, actions, filters, mappings, and delivery settings programmatically.

Read

Authentication model

Understand Nimriz authentication methods, workspace API keys, SSO, identity linking, and authorization after login.

Read

API authentication

Generate, send, rotate, and revoke workspace API keys and partner install tokens for secure server-side API access.

Read

Rate limits and errors

Review API rate limits, retry guidance, customer-safe error codes, and response patterns for reliable automation.

Read

Webhook delivery and retries

Manage endpoints, verify signed deliveries, handle retries, replay events, and full event schemas.

Read

MCP server

Connect AI tools to Nimriz over MCP: client setup, authentication, available tools, and limits.

Read

Support

2 guides

Contact and support

Choose the right contact path for sales, support, security, abuse, legal, and integration questions.

Read

Troubleshooting

Diagnose redirect, domain, routing, password, analytics, API, and billing issues with focused checks and next-step guidance.

Read

Need 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.