Skip to Content
AI Powered Docs! 🤖 These docs are translated with AI, so keep an eye out for minor quirks. We're always improving!
Frequently Asked QuestionsPartner Integration Guide

Partner Integration with Metrix

Overview

Metrix provides a comprehensive partner integration program for advertising networks, attribution platforms, and technology partners who want to send app install data, event data, and user information to external systems in real-time. This guide walks you through the integration process, technical requirements, and best practices.

Who Should Use This Guide?

  • Advertising Networks — Send conversion data back to your platform
  • Attribution Platforms — Receive install and event callbacks
  • Data Analytics Platforms — Collect raw events for analysis
  • CRM Systems — Sync user data automatically
  • Business Intelligence Tools — Real-time data warehouse integration
  • Third-party Service Providers — Integrate with Metrix to enhance your offerings

Partner Integration Process

Step 1: Onboarding Request

To begin the integration process, contact our Integration team with the following information:

ItemDetailsExample
Company NameLegal entity nameAcme Analytics
Contact PersonTechnical lead for integrationJohn Smith
Email & PhonePrimary contact informationjohn@acme.com, +1-555-0100
Integration TypeWhat kind of data you needInstall callbacks, event postbacks
Use CaseBrief description of your use caseReal-time attribution reporting
Expected VolumeEstimated daily events10M+ callbacks/day

Step 2: Technical Requirements

Our Integration team will work with you to define:

  1. Callback Endpoints — Your HTTPS URL(s) where Metrix sends data
  2. Required Parameters — Specific data fields you need
  3. Authentication — API keys, IP whitelisting, or other security measures
  4. Format — JSON, URL query parameters, or custom format
  5. Delivery Method — Real-time, batched, or hybrid

Step 3: Configuration & Testing

Once requirements are defined:

  1. Our team configures your integration in the Metrix dashboard
  2. You receive test credentials and documentation
  3. Testing phase begins with staging/test trackers
  4. Validation of data accuracy and completeness
  5. Production deployment and monitoring

Integration Setup Requirements

Required Information

1. Company Description

Provide a 3-4 word description of your company and services. This appears on:

  • Metrix partners listing page (public)
  • Metrix dashboard (internal)
  • Integration documentation

Example: “Leading real-time attribution platform”

2. Mobile Device Identifiers

Specify which device identifiers your system needs. Metrix can send:

IdentifierFormatPlatformExample
Google Advertising ID{gps_adid}Android38400000-8cf0-11bd-b23e-10b96e40000d
Android ID{android_id}Androidb9da30111528c740
Device Name{device_name}MobileSM-A505F
Device Brand{device_brand}MobileSamsung
Device Manufacturer{device_manufacturer}MobileSamsung

Best Practice: Request only identifiers you actually use to minimize data transmission.

3. Custom Parameters

If you send custom Click IDs or parameters during the click phase, provide the macro names:

Your ParameterMetrix Macro Format
Click ID{click_id}
Campaign ID{campaign_id}
Ad Set ID{ad_set_id}
Creative ID{creative_id}
Publisher ID{publisher_id}
Your Custom Field{your_field_name}

These parameters will be returned in callbacks so you can match conversions to original clicks.


Postback & Callback Configuration

Understanding Callbacks vs. Postbacks

In the Metrix ecosystem:

  • Callbacks — Real-time HTTP requests Metrix sends to your endpoint (data flows from Metrix → You)
  • Postbacks — Historical data sent via API or bulk export (used interchangeably with callbacks in partner contexts)

Main Postback URL Configuration

Provide your primary HTTPS endpoint where Metrix will send data. The URL should:

  • Use HTTPS only (encrypted)
  • Be accessible 24/7 (monitoring/alerting)
  • Have sufficient capacity for your expected volume
  • Support standard HTTP GET parameters
  • Return HTTP 2xx status on success
  • Handle retries gracefully

Example postback URLs:

https://callbacks.yourcompany.com/metrix/install https://api.yourcompany.com/v1/conversions/install https://events.yourcompany.com/install?api_key=YOUR_KEY

Available Standard Parameters

Metrix can include these parameters in all callbacks. Choose which ones you need:

Attribution & Campaign Data

  • {tracker_code} — Unique tracker identifier
  • {network_name} — Ad network name
  • {campaign_name} — Campaign name
  • {adgroup_name} — Ad group name
  • {creative_name} — Creative/ad name
  • {sub_id} — Sub-ID for custom tracking

Device & User Information

  • {android_id} — Android device identifier
  • {gps_adid} — Google Advertising ID
  • {device_name} — Device model name
  • {device_brand} — Device manufacturer
  • {device_manufacturer} — Device OEM
  • {ip_address} — User’s IP address
  • {user_agent} — User agent string
  • {metrix_user_id} — Metrix anonymous user ID

Geolocation Data

  • {country} — User’s country (ISO 3-letter code)
  • {city} — User’s city
  • {region} — User’s region/state

Timing Data

  • {created_at} — Event creation time (Unix ms)
  • {clicked_at} — Click time (Unix ms)
  • {installed_at} — Install time (Unix ms)

App Information

  • {app_name} — App package name
  • {app_version} — App version

Action Information

  • {action_name} — Type of action (install, event, fraud, click)
  • {rejection_reason} — Reason for fraud rejection (if applicable)
  • {event_slug} — Event identifier (for event callbacks)

Constructing Your Postback URL

Include only the parameters you need in your URL. Metrix will substitute actual values at callback time:

Example Installation Postback:

https://callbacks.yourcompany.com/install? tracker_code={tracker_code}& network_name={network_name}& campaign_name={campaign_name}& country={country}& installed_at={installed_at}& gps_adid={gps_adid}& ip_address={ip_address}& metrix_user_id={metrix_user_id}

Example Event Postback:

https://callbacks.yourcompany.com/event? event_slug={event_slug}& action_name={action_name}& tracker_code={tracker_code}& metrix_user_id={metrix_user_id}& created_at={created_at}

Example Fraud Detection Postback:

https://callbacks.yourcompany.com/fraud? tracker_code={tracker_code}& rejection_reason={rejection_reason}& action_name={action_name}& android_id={android_id}& created_at={created_at}

Event and Rejection Parameters

Events Postback

For event-level callbacks (purchases, registrations, etc.):

  • Use {action_name} to identify the action type
  • Use {event_slug} to identify the specific event
  • Include any custom event attributes (see callback parameters reference)

Example:

https://callbacks.yourcompany.com/event? action_name=purchase& event_slug={event_slug}& value={_revenue}

Rejected Installs (Fraud Detection)

When Metrix detects fraudulent installs:

  • {rejection_reason} contains the fraud reason
  • Possible values: anonymousIP, tooManyEngagements, clickInjection, deviceSpoof, emulator
  • These callbacks help you identify and prevent fraud

Example:

https://callbacks.yourcompany.com/fraud? action_name={action_name}& rejection_reason={rejection_reason}& tracker_code={tracker_code}& created_at={created_at}

Dynamic Callback URLs

Beyond the main configured postback URL, Metrix supports dynamic callback URLs attached directly to tracker links:

How It Works

Append the install_callback parameter to your tracker URL:

https://tracker.metrix.ir/link/bdjulq?install_callback=https://your-callback.com/install?source={network_name}&campaign={campaign_name}

When an install occurs on this tracker:

  1. Metrix processes the install
  2. Parameters are substituted into the callback URL
  3. Real-time callback is sent to your specified endpoint

Benefits

  • Per-tracker configuration — Different callbacks for different campaigns
  • No pre-configuration needed — Dynamically set at link time
  • Flexible routing — Send data to different systems based on source
  • A/B testing — Send to alternate endpoints for testing

Example Use Cases

Route data to different teams:

https://tracker.metrix.ir/link/abc123? install_callback=https://sales-team.company.com/install? campaign={campaign_name}&lead={metrix_user_id}

Send to multiple destinations:

https://tracker.metrix.ir/link/xyz789? install_callback=https://primary-api.company.com/install& install_callback_secondary=https://backup-api.company.com/install

Include custom parameters:

https://tracker.metrix.ir/link/def456? install_callback=https://crm.company.com/install? user_id={metrix_user_id}& custom_id={click_id}& source={network_name}

Monitoring & Support

Key Metrics to Monitor

  • Callback Success Rate — % of callbacks with 2xx response
  • Callback Latency — Time from event to callback received
  • Data Completeness — % of fields populated correctly
  • Retry Rate — How many retries are needed
  • Volume Tracking — Total callbacks vs. expected volume

Troubleshooting

IssueDiagnosisSolution
No callbacks receivedEndpoint unreachableVerify HTTPS, firewall, DNS
Intermittent callbacksNetwork instabilityImplement proper retry logic
Missing parametersParameter not included in URLUpdate callback URL with required parameters
Wrong valuesParameter name mismatchVerify exact parameter names from reference
Slow responsesEndpoint latencyOptimize server, use async processing
High reject rateInvalid requestsValidate request format, error logs

Documentation** — docs.metrix.ir


Best Practices for Partners

  1. Always Use HTTPS — All callbacks must be encrypted
  2. Implement Idempotency — Handle duplicate callbacks gracefully
  3. Set Appropriate Timeouts — Respond within 5-10 seconds
  4. Log Everything — Maintain audit trail for debugging
  5. Monitor Data Quality — Verify accuracy of received data
  6. Handle Retries — Implement exponential backoff
  7. Document Your API — Clearly define parameters and responses
  8. Test Thoroughly — Use staging before production
  9. Communicate Changes — Notify Metrix team of endpoint changes
  10. Plan for Scaling — Design for 10x current volume

Last updated on