Difference between revisions of "NATS5 Affiliate Management"

From TMM Wiki
Jump to navigationJump to search
(Created page with "abcd")
 
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
abcd
+
{{NATS5 Manual
 +
|show_affiliates_admin_section = true
 +
}}
 +
 
 +
__TOC__
 +
The Affiliates Management in NATS5 displays features that allow you to manage your affiliates, view their statistics, edit their permissions and details, and get other essential information.
 +
<br /><br />
 +
[[File:Affiliate-Management_General.png|800px]]
 +
 
 +
== Affiliate Search ==
 +
=== Advanced Search Bar ===
 +
The Affiliate Search bar, located at the top of the page, allows you to search for any existing affiliates within the system. To search for an affiliate can click on the Advanced Search Bar displayed above the table. From here you can either click through the displayed menus or type in your specific search and press enter.
 +
<br />
 +
 
 +
=== Sorting Affiliates ===
 +
[[File:Affiliate-Management_Sorting_Widget.jpg|border]]<br />
 +
Next to the search button on the search bar is the sorting button that displays the sorting widget, with all of the possible parameters to sort by. The widget also displays the order of the listed affiliates (Ascending or Descending), as well as how many affiliates per page will be displayed in the table. The Affiliates Table sorting options include:
 +
*'''Account Level, Username''': This option will first sort the table by the account levels/types, with the highest level being a full admin and the lowest level being an affiliate. Each of those levels will then be sorted by username.
 +
*'''Username''': This option will only sort by the affiliate's username.
 +
*'''Country''': This option will sort by the country of the affiliate (in alphabetical order).
 +
*'''Join Date''': This option will sort by the affiliate's join date.
 +
*'''Last Login''': This option will sort by the affiliate's last login date.
 +
<br />
 +
=== Dumps ===
 +
[[File:Affiliate-Management_Dumps.jpg|border]]<br />
 +
You can get a complete CSV Dump of affiliate data by clicking the right-most button next to the search bar and then clicking "CSV Dump". You can also get a complete dump of all of the affiliate's emails by clicking "Email Dump" instead. <br />
 +
 
 +
== Affiliates Table ==
 +
The Affiliates Table can be found below the "Affiliate Search" box on the Affiliates Admin main page. Within this table you will find important information about each affiliate, including:
 +
*'''Details''': This includes the affiliate's username, ID, full name, email, and level/account type.
 +
*'''Country''': Displays the affiliate's country.
 +
*'''Join/Last Login''': Displays the time and date the member joined, as well as their last login date.
 +
<br />
 +
 
 +
=== Affiliate Actions ===
 +
[[File:Affiliate-Management_Actions.jpg|border]]<br />
 +
To the right of each affiliate is a box labeled "Actions". If you click on this button, a list of possible actions will dropdown. These include:
 +
*'''Affiliate Overview''': This brings you to the Affiliate Overview page. For more information, please see our [[NATS5 Affiliate Overview]] wiki.
 +
*'''Override as Affiliate''': This lets you override as that affiliate. For more information, please see our [[NATS5 Affiliate Override]] wiki.
 +
*'''Message Affiliate''': Clicking this will display a messaging box, where you can send that affiliate a message. <br />
 +
[[File:Affiliate-Management_Action_Message.jpg|border|300px]]
 +
*'''Email Affiliate''': This will open up your emailing platform and set up an email template, where you can quickly email the affiliate.
 +
*'''Delete Affiliate''': This will delete the affiliate.
 +
 
 +
=== Bulk Actions ===
 +
 
 +
At the bottom of the Affiliates Table, you will find batch options for the affiliates.<br/>
 +
[[File:Affiliate-Management_Checkboxes.jpg|border|700px]]<br />
 +
Clicking the "All" button will check all of the affiliates on that page to perform a bulk update while clicking the "None" button will make sure none of the affiliates on that page are checked. The "Invert" button will check the unmarked affiliates and uncheck the marked affiliates. The available bulk update actions are:
 +
*'''Delete''': Deletes the selected affiliates.
 +
*'''Restore (Undelete)''': Restores previously deleted affiliates. 
 +
*'''Remove Account Rep''': Removes an affiliates account rep (if the affiliate has an account rep).
 +
*'''Assign Account Rep''': Assigns an affiliate account rep to the checked affiliates. The option to choose an affiliate account rep and a program will appear, and then the action can be performed.
 +
*'''Assign Referrer''': Assigns an affiliate referrer account to the checked affiliates. The option to choose an affiliate referrer and a program will appear, and then the action can be performed.
 +
*'''Assign Account Type''': Assigns an account to type to the specified checked affiliates. The option to choose an account type and an account type has to be selected before the action can be performed. These account types include Affiliate, Account Rep, Customer Service Rep, Site Partner, Sub Admin, TMM Admin, and Admin.
 +
 
 +
== Affiliate Terms of Service ==
 +
At the top right of this page, you will see a button "Affiliate T.O.S.". If clicked on, this will display the options for the Affiliate Terms of Service. You can set whether the affiliate needs to agree to the Terms of Service before viewing any statistics and payout, as well as reset the Terms of Service so the affiliates have to agree to them again if there is a change to the terms.
 +
<br />
 +
[[Category:NATS5]]

Latest revision as of 15:10, 7 August 2019

NATS 5
Affiliates Section
Affiliate Management
Affiliate Overview
Affiliate Override
Affiliate Groups
Affiliate Account Types
Affiliate Account Changes
Adding a Manual Sale
Members Section
Members Management
Adding a Member
View Member Details
Restricted Values
OpenID Connect
Mod Auth OpenIDC
    Adtool
GET /adtool/admin
GET /adtool/adtools
GET /adtool/adtool
GET /adtool/adtool-rules
GET /adtool/adtool-rule
GET /adtool/categories
GET /adtool/field-options
GET /adtool/field-types
GET /adtool/groups
GET /adtool/search
GET /adtool/templates
GET /adtool/types
GET /adtool/type
POST /adtool/adtool
POST /adtool/adtool-rule
POST /adtool/category
POST /adtool/field
POST /adtool/field-option
POST /adtool/group
POST /adtool/import
POST /adtool/type
PATCH /adtool/adtool
PATCH /adtool/adtool-group
PATCH /adtool/adtool-rule
PATCH /adtool/category
PATCH /adtool/field
PATCH /adtool/field-option
PATCH /adtool/group
PATCH /adtool/move
PATCH /adtool/restore-adtool
PATCH /adtool/restore-category
PATCH /adtool/restore-field
PATCH /adtool/restore-field-option
PATCH /adtool/restore-type
PATCH /adtool/type
DELETE /adtool/adtool
DELETE /adtool/adtool-rule
DELETE /adtool/category
DELETE /adtool/field
DELETE /adtool/field-option
DELETE /adtool/group
DELETE /adtool/type
    Affiliate
DELETE /affiliate/account-rep
DELETE /affiliate/account-type
DELETE /affiliate/affiliate
DELETE /affiliate/doc
DELETE /affiliate/group
DELETE /affiliate/permissions
GET /affiliate/account-changes
GET /affiliate/account-types
GET /affiliate/admin-settings
GET /affiliate/campaigns
GET /affiliate/current
GET /affiliate/current-permissions
GET /affiliate/docs
GET /affiliate/doc
GET /affiliate/groups
GET /affiliate/group
GET /affiliate/hits
GET /affiliate/link-styles
GET /affiliate/loginids
GET /affiliate/loginlog
GET /affiliate/manual-payout
GET /affiliate/news-sections
GET /affiliate/notes
GET /affiliate/notices
GET /affiliate/override
GET /affiliate/payout
GET /affiliate/payment-periods
GET /affiliate/payvia-types
GET /affiliate/payvia-type
GET /affiliate/permissions
GET /affiliate/programcampaigns
GET /affiliate/referrer
GET /affiliate/referring-urls
GET /affiliate/reps
GET /affiliate/rest-methods
GET /affiliate/search
GET /affiliate/search-limited
GET /affiliate/settings
GET /affiliate/skins
GET /affiliate/soap-functions
GET /affiliate/status
PATCH /affiliate/adminsettings
PATCH /affiliate/account-change
PATCH /affiliate/account-type
PATCH /affiliate/account-type-permissions
PATCH /affiliate/admin-setting
PATCH /affiliate/affiliate-account-type
PATCH /affiliate/affiliate-group
PATCH /affiliate/allsettings
PATCH /affiliate/account-rep
PATCH /affiliate/avatar
PATCH /affiliate/customs
PATCH /affiliate/defaults
PATCH /affiliate/details
PATCH /affiliate/override
PATCH /affiliate/password
PATCH /affiliate/payment-period
PATCH /affiliate/payvia
PATCH /affiliate/payvia-info
PATCH /affiliate/permissions
PATCH /affiliate/referrer
PATCH /affiliate/reset-api
PATCH /affiliate/reset-rss
PATCH /affiliate/reset-tos
PATCH /affiliate/rest-permissions
PATCH /affiliate/restore
PATCH /affiliate/restore-account-type
PATCH /affiliate/settings
PATCH /affiliate/soap-permissions
PATCH /affiliate/status
POST /affiliate/account-type
POST /affiliate/add
POST /affiliate/doc
POST /affiliate/group
POST /affiliate/invoice
POST /affiliate/manual-sale
POST /affiliate/note
    Biller
GET /biller/available
GET /biller/partner-available
GET /biller/billerdata
GET /biller/cascades
GET /biller/cascades-available
GET /biller/cascade-count
GET /biller/cascade-history
GET /biller/cascade-rules
GET /biller/cascade-rule
GET /biller/cascade-step-count
GET /biller/cascade-steps
GET /biller/cascade-detail
GET /biller/cascade-list
GET /biller/count
GET /biller/detail
GET /biller/fees
GET /biller/partner-fees
GET /biller/last_poll
GET /biller/partner-last-poll
GET /biller/list
GET /biller/partner-detail
GET /biller/partner-list
GET /biller/partner-shortnames
GET /biller/process_types
GET /biller/partner-process-types
GET /biller/shortnames
GET /biller/transaction_types
GET /biller/partner-transaction-types
GET /biller/taxes
POST /biller/add
POST /biller/cascade
POST /biller/cascade-rule
POST /biller/cascade-step
POST /biller/partner
PATCH /biller/cascade
PATCH /biller/cascade-rule
PATCH /biller/cascade-step
PATCH /biller/cascade-steps-reorder
PATCH /biller/fee
PATCH /biller/partner-fee
PATCH /biller/restore
PATCH /biller/restore-cascade
PATCH /biller/restore-partner
PATCH /biller/setting
PATCH /biller/partner-setting
PATCH /biller/tax
DELETE /biller/biller
DELETE /biller/cascade
DELETE /biller/cascade-rule
DELETE /biller/cascade-step
DELETE /biller/fee
DELETE /biller/partner-fee
DELETE /biller/partner
DELETE /biller/tax
    Codes
GET /codes/affiliate-codes
GET /codes/decode
GET /codes/linkcodes
GET /codes/strack
    Config
DELETE /config/setting
GET /config/section
GET /config/sections
PATCH /config/affiliate_default
PATCH /config/section
    Include
DELETE /include/include
DELETE /include/step
GET /include/include
GET /include/includes
GET /include/templates
PATCH /include/include
PATCH /include/restore
PATCH /include/step
POST /include/include
POST /include/step
    Mailing
DELETE /mailing/mailing
DELETE /mailing/mailing-rule
DELETE /mailing/queue
GET /mailing/mailing
GET /mailing/mailings
GET /mailing/mailing-rules
GET /mailing/mailing-rule
GET /mailing/queue
GET /mailing/removelist
PATCH /mailing/mailing
PATCH /mailing/mailing-rule
PATCH /mailing/removelist
PATCH /mailing/removelist-queue
PATCH /mailing/resend-queue
PATCH /mailing/restore-queue
PATCH /mailing/send-mailing
PATCH /mailing/send-test-mailing
POST /mailing/mailing
POST /mailing/mailing-rule
POST /mailing/removelist
    Maintenance
DELETE /maintenance/log
DELETE /maintenance/cache
GET /maintenance/admin-actions
GET /maintenance/log
GET /maintenance/logs
GET /maintenance/nats
GET /maintenance/report
GET /maintenance/report-progress
GET /maintenance/reports
GET /maintenance/server
GET /maintenance/table
GET /maintenance/tables
GET /maintenance/table-clean-count
GET /maintenance/table-clean-progress
PATCH /maintenance/log
PATCH /maintenance/report
PATCH /maintenance/table
    Member
GET /member/available_flags
GET /member/encryptusername
GET /member/authstring
GET /member/details
GET /member/flags
GET /member/loginlog
GET /member/matching
GET /member/notes
GET /member/notices
GET /member/restricted-values
GET /member/search
GET /member/suggestedcanceloffers
GET /member/surfer-actions
PATCH /member/details
PATCH /member/expiration
PATCH /member/expiremanual
PATCH /member/resend-transaction-email
PATCH /member/resend-transaction-postback
PATCH /member/restricted-value
PATCH /member/forget
PATCH /member/lock
PATCH /member/unlock
POST /member/flag
POST /member/login
POST /member/note
POST /member/restricted-value
DELETE /member/flag
DELETE /member/restricted-value
    Message
DELETE /message/message
DELETE /message/permanent
GET /message/count
GET /message/messages
GET /message/view
PATCH /message/read
PATCH /message/unread
PATCH /message/undelete
POST /message/message
    News
DELETE /news/entry
DELETE /news/section
GET /news/entry
GET /news/news
GET /news/sections
PATCH /news/entry
POST /news/entry
POST /news/section
    Notification
DELETE /notification/notification
DELETE /notification/permanent
GET /notification/count
GET /notification/notifications
GET /notification/view
PATCH /notification/read
PATCH /notification/unread
PATCH /notification/undelete
    Option
GET /option/options
GET /option/rule
PATCH /option/rule
PATCH /option/text
POST /option/rule
    Payment
DELETE /payment/invoice
DELETE /payment/payout-period
DELETE /payment/payvia-field
DELETE /payment/payvia-field-mc
DELETE /payment/payvia-rule
GET /payment/dump-format
GET /payment/dump-formats
GET /payment/invoices
GET /payment/payments
GET /payment/payment-dumps
GET /payment/payment-dump
GET /payment/payment-search
GET /payment/payvia
GET /payment/payvias
GET /payment/payvia-fields
GET /payment/payvia-field-mcs
GET /payment/payout-period
GET /payment/payout-periods
GET /payment/payvia-rules
GET /payment/payvia-rule
GET /payment/payviarule
PATCH /payment/copy-dump-format
PATCH /payment/default-payout-period
PATCH /payment/dump-format
PATCH /payment/duplicate-payvia
PATCH /payment/invoice
PATCH /payment/payment
PATCH /payment/payment-paid
PATCH /payment/payment-store
PATCH /payment/payment-unstore
PATCH /payment/payments
PATCH /payment/payments-unstore
PATCH /payment/payout-period
PATCH /payment/payout-period-affiliates
PATCH /payment/payvia
PATCH /payment/payvia-field
PATCH /payment/payvia-fields-reorder
PATCH /payment/payvia-field-mc
PATCH /payment/payvia-field-mcs-reorder
PATCH /payment/payvia-rule
PATCH /payment/payviarule
PATCH /payment/restore-payout-period
PATCH /payment/restore-payvia-field
PATCH /payment/restore-payvia-field-mc
POST /payment/check-dump
POST /payment/dump-format
POST /payment/import-dump
POST /payment/invoice
POST /payment/payout-period
POST /payment/payvia
POST /payment/payvia-field
POST /payment/payvia-field-mc
POST /payment/payvia-rule
    Program
DELETE /program/program
DELETE /program/payout-change
DELETE /program/payout-change-tier
GET /program/additional-payout-change-targets
GET /program/affiliate-available
GET /program/detail
GET /program/list
GET /program/options
GET /program/payout-changes
GET /program/redirect-available
GET /program/sites
GET /program/tours
GET /program/types
PATCH /program/default_payout
PATCH /program/details
PATCH /program/disable_affiliate
PATCH /program/disable_tour
PATCH /program/enable_affiliate
PATCH /program/enable_site
PATCH /program/enable_tour
PATCH /program/move-payout-change
PATCH /program/payout-change
PATCH /program/payout-change-tier
POST /program/new
POST /program/payout-change
POST /program/payout-change-tier
    Report
GET /report/affiliate-ratios
GET /report/hits
GET /report/hit-totals
GET /report/profitloss
GET /report/profit-loss
GET /report/fields
GET /report/focus
GET /report/focuses
GET /report/groups
GET /report/perspective
GET /report/perspectives
GET /report/report
GET /report/subscription
GET /report/surfer
GET /report/surferaction
GET /report/transactionpayouts
GET /report/transactions
GET /report/transaction
GET /report/report-widget
GET /report/widgets
GET /report/widget
GET /report/widget-info
GET /report/views
POST /report/focus
POST /report/group
POST /report/perspective
PATCH /report/focus
PATCH /report/focus-enabled
PATCH /report/focus-default
PATCH /report/focuses-reorder
PATCH /report/perspective
PATCH /report/perspective-group
PATCH /report/report-widget
PATCH /report/widget
DELETE /report/focus
    Reward
DELETE /reward/category
DELETE /reward/purchase
DELETE /reward/point
DELETE /reward/reward
GET /reward/categories
GET /reward/points
GET /reward/purchases
GET /reward/rewards
PATCH /reward/move-point
PATCH /reward/point
PATCH /reward/reward
PATCH /reward/ship-purchase
PATCH /reward/unship-purchase
POST /reward/category
POST /reward/point
POST /reward/reward
    Service
GET /service/check-functions
GET /service/condition
GET /service/countries
GET /service/country
GET /service/datetime
GET /service/languages
GET /service/periods
GET /service/ping
GET /service/project
GET /service/rule-condition-data
GET /service/rule-info
GET /service/stats-breakdowns
GET /service/timezone
GET /service/timestamp
POST /service/sendemail
    Site
GET /site/base-templates
GET /site/billers
GET /site/cookies
GET /site/coupon
GET /site/coupons
GET /site/coupon-revisions
GET /site/email-settings
GET /site/groups
GET /site/option
GET /site/options
GET /site/options-available
GET /site/option-fields
GET /site/option-rules
GET /site/option-rule
GET /site/option-type
GET /site/option-types
GET /site/programs
GET /site/redirect
GET /site/redirects
GET /site/redirect-rules
GET /site/redirect-rule
GET /site/site-list
GET /site/site
GET /site/site-notices
GET /site/site-partner
GET /site/site-partners
GET /site/site-type
GET /site/sites
GET /site/template
GET /site/templates
GET /site/template-sections
GET /site/template-sites
GET /site/tour
GET /site/tours
GET /site/tour-emails
GET /site/tour-notices
POST /site/coupon
POST /site/group
POST /site/option
POST /site/option-rule
POST /site/redirect
POST /site/redirect-rule
POST /site/site-partner
POST /site/site-tour
POST /site/copy-template
POST /site/tour
PATCH /site/cookie
PATCH /site/coupon
PATCH /site/duplicate-option
PATCH /site/email-settings
PATCH /site/group
PATCH /site/move
PATCH /site/option
PATCH /site/option-rule
PATCH /site/redirect
PATCH /site/redirect-rule
PATCH /site/reset-coupon
PATCH /site/restore-group
PATCH /site/restore-option
PATCH /site/restore-redirect
PATCH /site/restore-site
PATCH /site/restore-site-partner
PATCH /site/restore-tour
PATCH /site/site
PATCH /site/site-partner
PATCH /site/template
PATCH /site/tour
DELETE /site/cookie
DELETE /site/group
DELETE /site/option
DELETE /site/option-rule
DELETE /site/site
DELETE /site/site-partner
DELETE /site/redirect
DELETE /site/redirect-rule
DELETE /site/template
DELETE /site/tour
DELETE /site/tour-field
    Skin
DELETE /skin/skin
DELETE /skin/template
GET /skin/colors
GET /skin/export
GET /skin/skins
GET /skin/sections
GET /skin/templates
GET /skin/template
PATCH /skin/colors
PATCH /skin/flush
PATCH /skin/skin
PATCH /skin/template
POST /skin/copy-template
POST /skin/import
POST /skin/skin
POST /skin/template

The Affiliates Management in NATS5 displays features that allow you to manage your affiliates, view their statistics, edit their permissions and details, and get other essential information.

Affiliate-Management General.png

Affiliate Search

Advanced Search Bar

The Affiliate Search bar, located at the top of the page, allows you to search for any existing affiliates within the system. To search for an affiliate can click on the Advanced Search Bar displayed above the table. From here you can either click through the displayed menus or type in your specific search and press enter.

Sorting Affiliates

Affiliate-Management Sorting Widget.jpg
Next to the search button on the search bar is the sorting button that displays the sorting widget, with all of the possible parameters to sort by. The widget also displays the order of the listed affiliates (Ascending or Descending), as well as how many affiliates per page will be displayed in the table. The Affiliates Table sorting options include:

  • Account Level, Username: This option will first sort the table by the account levels/types, with the highest level being a full admin and the lowest level being an affiliate. Each of those levels will then be sorted by username.
  • Username: This option will only sort by the affiliate's username.
  • Country: This option will sort by the country of the affiliate (in alphabetical order).
  • Join Date: This option will sort by the affiliate's join date.
  • Last Login: This option will sort by the affiliate's last login date.


Dumps

Affiliate-Management Dumps.jpg
You can get a complete CSV Dump of affiliate data by clicking the right-most button next to the search bar and then clicking "CSV Dump". You can also get a complete dump of all of the affiliate's emails by clicking "Email Dump" instead.

Affiliates Table

The Affiliates Table can be found below the "Affiliate Search" box on the Affiliates Admin main page. Within this table you will find important information about each affiliate, including:

  • Details: This includes the affiliate's username, ID, full name, email, and level/account type.
  • Country: Displays the affiliate's country.
  • Join/Last Login: Displays the time and date the member joined, as well as their last login date.


Affiliate Actions

Affiliate-Management Actions.jpg
To the right of each affiliate is a box labeled "Actions". If you click on this button, a list of possible actions will dropdown. These include:

  • Affiliate Overview: This brings you to the Affiliate Overview page. For more information, please see our NATS5 Affiliate Overview wiki.
  • Override as Affiliate: This lets you override as that affiliate. For more information, please see our NATS5 Affiliate Override wiki.
  • Message Affiliate: Clicking this will display a messaging box, where you can send that affiliate a message.

Affiliate-Management Action Message.jpg

  • Email Affiliate: This will open up your emailing platform and set up an email template, where you can quickly email the affiliate.
  • Delete Affiliate: This will delete the affiliate.

Bulk Actions

At the bottom of the Affiliates Table, you will find batch options for the affiliates.
Affiliate-Management Checkboxes.jpg
Clicking the "All" button will check all of the affiliates on that page to perform a bulk update while clicking the "None" button will make sure none of the affiliates on that page are checked. The "Invert" button will check the unmarked affiliates and uncheck the marked affiliates. The available bulk update actions are:

  • Delete: Deletes the selected affiliates.
  • Restore (Undelete): Restores previously deleted affiliates.
  • Remove Account Rep: Removes an affiliates account rep (if the affiliate has an account rep).
  • Assign Account Rep: Assigns an affiliate account rep to the checked affiliates. The option to choose an affiliate account rep and a program will appear, and then the action can be performed.
  • Assign Referrer: Assigns an affiliate referrer account to the checked affiliates. The option to choose an affiliate referrer and a program will appear, and then the action can be performed.
  • Assign Account Type: Assigns an account to type to the specified checked affiliates. The option to choose an account type and an account type has to be selected before the action can be performed. These account types include Affiliate, Account Rep, Customer Service Rep, Site Partner, Sub Admin, TMM Admin, and Admin.

Affiliate Terms of Service

At the top right of this page, you will see a button "Affiliate T.O.S.". If clicked on, this will display the options for the Affiliate Terms of Service. You can set whether the affiliate needs to agree to the Terms of Service before viewing any statistics and payout, as well as reset the Terms of Service so the affiliates have to agree to them again if there is a change to the terms.