NATS5 Site Overview

From TMM Wiki
Jump to: navigation, search
NATS 5
Sites Section
Site Management
Adding a Site
Site Overview
Site Partners
Site Templates
Site Groups
Site Coupons
Site Coupon Overview
Join Option Overview
Tour Overview
Adding a Tour
Site Redirect Overview
Members Section
Members Management
Adding a Member
View Member Details
Restricted Values

    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 Site Overview contains all the information about a site, join options, enabled program and its tours. The site overview can be accessed from the Site Management page by clicking on the site's name, or clicking the "Actions" button and clicking "Overview".

Details Tab

Site-Overview Details.jpg

The Details Tab contains specific information about your site and is where you can edit site options, member email site settings, and ATVOD verification site settings. The information in this tab includes:

  • Site Name: The name of your site.
  • Short Name: The short name of your site.
  • Site Type: The type of the site.
  • Site Launch: The launch date of the site.
  • Default Linkdomain: The domain used to link codes and tracking URL's.
  • Default URL: The URL of the site.


Site Options

  • Featured Site: Set whether the site is a featured site.
  • Hidden: Set whether the site is hidden on the Site table in the Site Management page.
  • Mobile Tour: Select a mobile tour (if there is one available).
  • Groups: Displays the groups that the site is in. This can be updated by clicking the "Update" link next to the groups, where a widget with a list of the available site groups will be listed and the site can be enabled to these sets. You can also create a new gropu in this widget. For more information on Site Groups, please see our NATS5 Site Groups wiki.
  • Re-Use Active Usernames: If this is not set and a member signs up with the same username as another member, they will not be able to sign up and will have to choose a different username.
  • Disable Storing Personal Member Information: If this setting is set to "Yes" and a member signs up to this site, none of the member's contact details or personal information will be shown in the member overview.
  • Site Global Expire Time: The amount of milliseconds before a cookie expires.
  • Cookie Precedence: Define which Expire time is used for this site.


Member Email Site Settings

These settings will be used when sending emails to a member for that particular site.

Affiliate Email Site Settings


These settings will be used when sending emails to a affiliates associated to specific members of a particular site.

ATVOD Verification Site Settings


The following will be used when setting up the ATVOD signup process in your installation. For more information about ATVOD Verification, please see our ATVOD Verification Process wiki.


Tours Tab

The Tours tab contains information and details about all of the tours belonging to your site. Such details include the name of your tour, its ID, its short name, the type of tour, its linkdomain, and the tour URL.
Site-Overview Tours.jpg
The Tours tab is also an area where you can quickly add a new tour. To do so, click the "Add New Tour" button above the Tours table.

For more information about adding new tours to a site, please see our NATS5 Tour Setup wiki.


Programs Tab

The Programs Tab is where you can find a list of all of your programs, and which tours are enabled within each program. To enable program, click on the checkbox next to the program under each tour, and the tour will be enabled for that program.
You can also enable a tour for each program by clicking the "Enable All" button under the tour name. This will automatically check each checkbox and enable that tour for each program.
Site-Overview Programs.jpg


Join Options Tab

The Join Options Tab displays general information about all of your join options for that site.
Site-Overview Join Options Tab.jpg

To see the all the details for each option, including Biller settings and display Rules, click the option text to view the NATS5 Join Option Overview.

To show deleted join options, as well as active join options, click the "Filter" button and choose the "Show Deleted" option. Otherwise, the filtering will be defaulted to only showing active join options.


Adding a Join Option

To add a new join option for your site, click the "Add Site Option" button and you will be redirected to the page to fill in information for your new join option.
Site-Overview Add Join Option.jpg

This page displays some site details, biller details, and option details that are to be filled in. These option details include:

  • Join Form Text: The name or title of your join option.
  • Initial Cost: The initial cost the surfer will have to pay when signing up to your site using this join option. The member will have to pay that initial cost for a certain amount of days.
  • Recurring Cost: The recurring cost the member will have to pay for a fixed amount of days.
  • Default Options: The default options that you can set for the members and the join option on the site. These are:
    • Disallow for Old Members: This will make sure that members that have already signed up are unable to access this join option.
    • Hide on Join Form: This will not display this join option on the join form when a member attempts to sign up.
    • Active by Default: This will automatically make the member sign up using this join option, and activate this join option by default.


An important part of your join option is the biller details at the bottom of the page. In order for your join option to actually function when a surfer attempts to sign up using this option, you will need to fill in the required biller information so the transaction can be processed and the join option can function properly.
The required fields that will need to be filled in will have an * or ** next to them.

Once finished, click the "Add Option" button and you will be redirected to the Join Option Overview for the new join option.


Adding a No Cost Option

No Cost Registration is a feature in NATS that allows you to set up a free join option for a site. This join option will create an active member in NATS for your site without going to a biller page. This way, you will be able to offer a free membership option while avoiding potential biller charges, as there are no biller option codes that would allow a No Cost Registration.

To add a No Cost Option, click the "Add No Cost Option" button next to the "Add Site Option" button.
Site-Overview Add NCR.jpg

This page only displays some site details and Option details that you will fill in to create your No Cost Registration option. You will need to fill in the Join Form Text, which will be the name or title of your No Cost Registration option, and the amount of days for the Registration Period, which is how many days this option will be active for a member.
Again, the default options include Disallow for Old Members, Hide on Join Form, and Active by Default.
Because this is a No Cost Option, no biller information needs to be added or filled in, as there are no biller transactions involved.

Once finished, click the "Add Option" button and you will be redirected to the Join Option Overview for the new join option.

Partners Tab

The Partners Tab displays all of the site partners, or affiliates who receive an allocated percentage of a site's revenue.
Site-Overview Partners.jpg

The Site Partners table displays the following information:

  • Affiliate
  • Start Date
  • End Date
  • Percentage
  • Expenses
  • Income/Profit
  • Flat Adjustment
  • Flat Percentage


To add a new Site Partner, click the "Add Site Partner" button and you will be redirected to a new page where you may fill out all of the necessary fields to create a new Site Partner.
The table can be specifically filtered to only display specific site partners, as well as show or hide disabled site partners. This can be done by clicking the "Filter" button next to the "Add Site Partner" button.

For more information about Site Partners, please see our NATS5 Site Partner wiki.


Members Tab

The Members Tab displays all of the members that have signed up to your membership site.
Site-Overview Members.jpg

The Members table in the Members Tab is the same table as the table in the Member Management, but with the "Site = (your site name)" filter automatically added to the table.
You can still add more filters by typing into the search bar at the top of the page. However, the "Site" filter cannot be removed since you are still on the site overview for your specific site.

For more information on the Members table, please see our NATS5 Member Management wiki.


Linkcodes Tab

The Linkcodes Tab displays information regarding the site's various links and tour NATS codes for your site.
Site-Overview Linkcodes.jpg

This page displays the default site and tour NATS linkcode, as well as generic example links such as the default tracking link, the qualified click link, and the join form link. These links are listed under the "Generic / Plain Examples". Along with the generic examples, these same link are displayed as "PHP Examples".

For more information about linkcodes, please see our NATS5 LinkCodes wiki.


Cascades Tab

The Cascades Tab displays the cascades that are enabled for your site.
Site-Overview Cascades.jpg

To manage and view all your cascades in NATS, click the "click here" link at the top of the cascades table.
To view the Cascade Overview, you can either click on the Cascade name itself or click the "Actions" button to the right of the cascade and click "Cascade Overview".

For more information on cascades, please see our NATS5 Cascade Overview wiki.

Redirects Tab

The Redirects tab shows you a list of all of your redirects for this site.

Site-Overview Redirects.jpg

The Redirects table displays the redirect ID, how much traffic the site is active for, the options of the redirect, the new site, tour, and program that a surfer will be redirected to, and the URL that the surfer will be redirected to.


Adding a Site Redirect

To add a site redirect, click on the "Add Site Redirect" button at the top right of the Redirects Tab. You will be taken to the adding page, where you can choose either a new program or a new site and tour to redirect your site to.

Site-Overview Add Redirect.jpg

You may also choose between redirecting to the tour URL or a completely new URL. Options for this redirect include being enabled by default, tracking the new redirect, disabling the original hit on the original site, and maintaining a query string. You may set how much traffic the redirect will be active for by percentage, so not all traffic has to be redirected to the new site.

For more information on Redirects, please see our NATS5 Redirect Overview wiki.