Technical Documentation
Technical Documentation
General
Creating an Account
To create an account on your affiliate program navigate to https://ro-affiliate.YOURAFFILIATEPROGRAM.com/registration and follow the login steps:
- Start with username, email and password.
- Choose option to create a Company or join an Existing Company (see 2.1).
2.1. Join an existing company using Account UID (Company Identificator).
- Create a new one. Choose whether it is a Personal or Company account.
The differences are only in the Company Name:
- Your account is ready. You may now fill in additional information, such as contact details, traffic source, payment methods.
- Fill in your contact details.
- Fill in your Traffic Source details.
The Traffic Type list is based on the operators list they have created. Should you need one that is not in the list, please contact the affiliate team.
- Fill in payment details.
- After additional information is filled in please await approval of your account. You will receive notification on your email address.
After you have been notified that the account has been approved, you can then go to: https://ro-affiliate.YOURAFFILIATEPROGRAM.com/login and use the username and password details given on sign up. (Also found in the notification email)
Upon log in and approval you will then see your dashboards.
To create an account on your affiliate program navigate to https://ro-affiliate.YOURAFFILIATEPROGRAM.com/registration and follow the login steps:
The instructions in this document are for Company Account Level. If you are logging in as an affiliate level, follow the same instructions as above BUT you will NOT have the filter of choosing 'Affiliate' in the system.
Account Settings
Found to the bottom left of the system, this allows a user to adjust their profile information, such as name, password, title, etc.
Click the avatar of the user, then Account Settings.
If you are logged as the master account, you will also have a Company shortcut in the bottom left as well.
Adjusting Payment Methods
This area is only for Company Level access.
Within ReferOn, a company can contain multiple methods for their affiliates allowing flexibility in payouts for example if some affiliates in a network need bank wire but others need cryptocurrency.
To set up your payment methods, follow the below instructions:
- The company level access or master user must first add the applicable payment methods via Account Settings - Payments, Company shortcut - Payment Methods or My Company - Edit - Payment Methods and clicking Add Payment Method.
- Add the associated details and click Save Payment Method.
- This method is now available, and can now be assigned to the affiliates in the company.
After submitting the above, it will redirect back to the Edit page. click Save and update individually or in bulk via Change Payment Method in the My Company screen for the accounts.
- Select the appropriate method.
- The method will then show in the My Company screen.
- To set a particular payment method as a default method, go to Company Information - Payment Methods and click Set Default Method.
Video
Release Version
Found to the bottom right of the screen, this displays the current version of the system.
Widgets
- Dashboard
- My Company/My Account
- Campaigns
- Media Items
They display the following metrics:
- First Time Deposits
- Deposit Amount
- Net Revenue
These are based on the date range selected (see Data Range Selector below) and show Current Period (CP) and Previous Period (PP) with a visualisation of the trend by metric.
The Dashboard has similar outputs but vary by tab - see Dashboard overview for more details.
Date Range Selector
This function can be found to the top right of most sections and is used to review your data from custom or set date ranges.
To select a custom range, select your first date and then the end date, lastly click Apply.
Adjusting this date range will update the widgets and Statistics shown.
After the first use, the date range will stay as your previous selection regardless if you sign out and sign back in.
Filter
This is found next to the Data Range Selector to the top right of the page and varies section by section. It will allow the user to filter the current screen by an assortment of factors.
You may also find a 'soft filter' search bar above the list shown in the center of the page.
Example filter options in Dashboard - Customer Activities page:
- Product
- Affiliate ID (For Company Level)
- Manager
- Traffic Type
- Brand
- Country
Statistics Toggle
The statistics toggle allows a user to quickly see statistics for the given view and is linked with the data range selector. For all areas it will show the following measures, with the grouping before depending on the page view:
- To help with data management, you may also choose to hide or show the columns in each page via the Column Chooser to the right of the screen. This also applies to the list page when statistics is not switched on as well.
- Every page can also be extracted in CSV via the ‘download’ button should additional data pulls be required.
- Personal - Ideal for single accounts. It will auto fill the Company Name as the First Name and Last Name.
- Company - Ideal for multi accounts. It will give the user a choice in Company Name.
Dashboard
Overview
The Dashboard provides high level overview of the data in the system, giving you the access to adjust date ranges and filters by a number of fields.
The Dashboard is split into 3 sections focusing on various outputs:
- Reward
- Total Rewards
- Revenue Share
- CPA
- CPC
- Fixed Fee
- Revenue
- Deposit amount
- Net Revenue
- Deposits by FTDs
- Customer Activities
- Reg Count
- Clicks
- FTDs
- NDCs
- Active Customers
Each dashboard shows the widgets and adaptable buttons as per the above the KPIs. The buttons then adapt the line graph, the 'by brand' graph and the 'by country' graph. Moreover, it showcases ‘Current Period’ (CP) to ‘Previous Period’ (PP) quick comparison in all widgets and charts. The ‘Previous Period’ will be the direct date range behind the current selected range, i.e. selecting Current Week would compare to the Week before that.
Scroll down below to see examples of each screen.
- Unlike other areas in the system, the widgets in the dashboard change depending on the sub-section you are currently in.
- Aside from column format, the Brands and Countries graphs can be shown in the following formats as well:
- Brands: Column and Donut
- Countries: Map, Column and Donut
- Filters for the Dashboard are as follows:
- Product
- Affiliates (Master Affiliate Access only)
- Traffic Types
- Brands
- Countries (player level)
Revenue
Reward
Customer Activities
My Company
Company Overview Page
This page is only available to those with Company Affiliate access. If you have standard affiliate access you will be shown the Affiliate Overview page instead.
This page provides the details of your individual company, including widgets.
You will see the following information on the page:
- Affiliate ID
- Affiliate Name
- Affiliate Username
- Company
- Manager
- Reward Plan
- Country
- Registration Date
- Skype
- Position
- Main Traffic Type
- Telegram
- Payment Method
The statistics toggle is available as well.
Creating Affiliates
Within the My Company window, you can then add more affiliates under your company via the 'Create affiliate' button. Avoiding the need to use the signup URL for the affiliate program.
Upon clicking this, you will see the window below:
Upon creation, the affiliate will need to be approved by the affiliate manager before access is granted and ultimately for rewards to be calculated.
Affiliate Overview Page
Upon clicking on an affiliate you will be shown the below window:
If you are using an affiliate account login, this will be starter page of access. You will NOT see payment details at this stage - those are stored at the Company level. For adjusting the payment method steps, follow this link: Technical Documentation
Much like the My Company page you will find the usual widgets and date range selectors in the Campaigns and Media Items tabs. However, in this case you will see the brands, campaigns, media items and marketing sources for the affiliates.
- You may wish to view Deactivated campaigns via the tab choice. By default, it will always show the Active tab.
- Similar to the previous page with the hover functions, you can also edit the affiliate information too via the top right button.
Clicking one of the campaigns will then show the media items underneath it, such as the below screen:
The below is discussed in more detail in the Affiliate Media section.
Media
Overview
The Media area is your central management area for all campaigns and media items.
You may select from the current list of campaigns or media items here, without the need of finding the specific link from other sections.
Campaigns
Here is where you can view all the current URLs or 'Campaigns' available in the system.
The following fields are shown:
- Campaign ID
- Campaign Name
- Banner Count
- URL
- Active Items
- Access
- Language
- Keywords
- Creation Date
- Product
Filters
The Filter on this page covers the following:
- Creation Period Date
- Count of media items
- Count of banners
- Product
- Campaign
- URL
- Language
- Access
To filter by brand, you can select one or multiple of the brand names at the top of the page.
Media Items
Here you will find all media items of the entire system. Showing the following fields:
- Media Item ID
- Media Item Name
- Media Item Type
- Brand
- Reward Plan
- Campaign Name
- Affiliate Name and ID
- Company
- Traffic Type
- Traffic Type Group
- Marketing Source
- Geo
- Creation Date
The Statistics toggle is also available.
Extracting a Tracking Link
Ensuring you are using the right link is very easy in ReferOn.
- Navigate to Media - Campaigns or My Company - Campaigns.
- From here, you will find all of the available campaigns that have been added to the system for the available brands for you.
From this page you can also change the date range selector to see your performance for all campaigns by FTDs, Deposit Amount and Net Revenue for the date range.
- From this window, you can choose to do a number of options:
- Use the quick search to find your campaign name
- Use the side filter
- Once you have found your campaign, select the Campaign Name:
- Select 'Create a media item':
- Fill in your desired:
- Select Affiliate (if at company level and via Media - Media Items)
- Name
- Description (optional)
- Marketing Source
- Traffic Type
- Geo
- Click Save
- Once created, scroll to the end and select the Copy icon and paste in the browser for tracking testing.
The output will resemble something like this: https:/ADSERVER.com/?mid=5081_139901
The 'mid' parameter is split into two parts:
- Affiliate ID
- Media Item ID
This makes it transparent on which campaign and affiliate a tracker is being used.
Alternatively, you may also jump straight to Media - Media Items and create media item from there as well, but you will need to fill in the campaign column when creating the media item.
Video
Extracting a Image Link
Varying slightly from the above, if you have uploaded banners and wish to extract the image link, you will need to follow the below steps;
- Create/Edit Media Item
- Click View code below the banner you have selected.
- Extract the associated codes from there, depending on your needs.
- Should you wish to use the campaign and tracker as a text link, you can continue to use the Copy Icon as per flow above.
Relative Path Functionality
This allows users to add relative URLs to an existing tracker. This is useful for adjusting the channel of the link, such specific sport pages without needing to create a new tracker.
This is not the same as common &redirectURL additions, which allows any URL to be used and redirected but instead allows subpages of the existing domain.
Example:
https://EXAMPLE.servclick1move.com/?mid=12345_1395807&relativepath=ar/game/plinko-v2
In the above example, the original campaign of Homepage AR will instead go to Plinko game on the brand.
Bulk Actions
There are a number of bulk actions that can be done on the Media Item page:
- Change Geo
- Change Traffic Type
- Change Marketing Source
Note: Change Marketing Source is only allowed for items within the same affiliate account. Greyed out option can only appear when using the Company Level and reviewing items across multiple accounts.
Marketing Sources
In addition to creating marketing sources on the fly via Media item creation. You may also manage your marketing sources in this section. You can easily edit, create and delete any marketing source tag for your trackers.
Postbacks (S2S Pixels)
Much like any other affiliate platform, ReferOn and it's backend can support postbacks.
To set up postbacks, you will need to contact your affiliate manager and provide the following information upfront:
- Notification URL(s) - Registration and Deposit URLs
- Test link. Normally these include ‘clickid’ but this is up to you.
The affiliate manager will then add these for you and run a test. Should you not receive the test upon their reply please check the URLs given are accurate.
Notes:
- You do not need to provide both Registration and Deposit notification URLs, but it is recommended.
- Ensure that the notification urls do contain a placement for clickids or alternative parameters. If there are any other parameters you need filling in, please run these by your affiliate manager for confirmation. Common examples include; currency, deposit value and payout.
- Ensure the test link is picking up a new ‘clickid’ on every click. This is best done via any link wrapping software.
- Clickids can be found as ‘dynamic variables’ in the Report in the interface as well as being shown in your own postback monitoring software.
Customers
Overview
This section allows you to view individual players under your accounts.
Output
This page shows the following details:
- CustomerID
- Geo
- Signup Date
- Affiliate
- Brand
- Campaign
- Media Item
- Reward Plan
Filters
You can filter by the following functions:
- Player signup date
- Affiliate
- Campaign
- Media item
- Brand
- Country
Reports
Overview
There is only one activity report in ReferOn, however, this is designed in this way so that you can have full transparency on what you are earning and what you are generating through a number of functions without the need of going to other areas in the system.
You can access this via the Reports side bar.
General
Use the grouping feature to extract the data on exactly the level you need:
- Program
- Product
- Company
- Affiliate
- Manager
- Brand
- Campaign
- Media Item
- Traffic Type Group
- Traffic Type
- Marketing Source
- Geo
- Customer ID
- Rewarding Plan
- Dynamic Variables
Filters
In addition, use the date range and filters to select further choices:
- Affiliate signup period (Master level only)
- Player Signup Period
- Affiliate
- Brand
- Campaign
- Media Item
- Country
- Traffic Type
- Product
- Customer
- Dynamic Variables
- Reward Plan
Singular or multiple items can be selected at the same time to allow for more flexible reporting.
The GEO column is equivalent to the IP and country of registration of the player.
Example 1 - where registrations exist:
- GEO of media item is selected as 'All Countries' and the tracker goes to GEO homepage.
- Player has VPN of DE
- Player follows links but selects CH as signup country.
- GEO of player in report is CH.
Example 2 - where clicks exist only:
- GEO of media item is selected as 'All Countries' and the tracker goes to GEO homepage.
- Player has VPN of DE
- Player follows links but does not sign up
- GEO is click of DE.
Date Range Selector
This mirrors the same functionality found throughout the system for this function.
Additional Splits
Moreover, you can show/hide columns and split the report by month, year or total.
Columns that are available are as follows:
Video
Examples
- I need to find my best performing geo in total for the date range:
- Select Geo only
- I need to find my best performing brand and campaign
- Select Brand and Campaign
- I need to find my marketing source information by reward by day
- Select Marketing Source and Rewarding Plan
- Select Split by Day
How to Create API Reports
Follow the below steps to create a template and API.
- Go to Reports - General
- Select your desired outputs, e.g. group bys, date range, columns and split bys
- Select Create Preset
- Insert a name and click Create preset
Click the Save icon to the bottom right, to keep it saved in your top 5 presets.
- Upon click you will then be shown the API screen:
Copy the API Link for instant access outside of ReferOn. This will instantly download a CSV upon use.Use restricted access if sharing with third parties.
- Upon saving, it can then be found via the Open icon (three dots) to the right. To bookmark it to the preset toolbar check the bookmark icon:
Payments
Grouping
The grouping functionalities allow you to easily pick the various groups of the report.
The grouping options are:
- Program
- Company
- Affiliate
- Brand
- Type
- Reward/Fixed Fee Name
- Manager
- Campaign
- Media Item
- Payment Method
Singular or multiple items can be selected at the same time to allow for more flexible reporting.
Date Range Selector
This mirrors the same functionality found throughout the system for this function.
Filters
The filters that are available for this section are as follows:
- Payment Date
- Minimum and Maximum Accounts
- Status
- Type
- Company
- Affiliate
- Managers
- Brands
- Payment Methods
- Reward Plan
Example:
