NATS5 Report Types

From TMM Wiki
Jump to: navigation, search
NATS 5
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


This wiki will go over each base NATS report type in detail. There NATS5 Report Types include:

  • Profit & Loss: Shows your programs profit and loss.
    • Additional Payout: Subset of the Profit & Loss report. This details any extra payouts not in the previous report.
  • Transaction: Lists each biller's transactions.
  • Subscription: Details each member's subscriptions.
  • Surfer Actions: Lists actions taken by surfers through your sites or programs.
  • Affiliate Ratios: Provides an in-depth, visual view of various affiliate and affiliate ratio statistics.


Each of these all have customizable features that let you specify and refine the exact statistics you may wish to view. You can find information on how to customize your report in the NATS5 Customize a Report.

Profit & Loss Report

The Profit & Loss Report provides a visual graph using various statistics, as well as a comprehensive table breaking down these statistics in text form. This helps to maintain accurate records on your site's total profit and loss, as well as being able to see all separate statistics that comprise this total profit and loss-- allowing you to see where any inaccuracies your accounting may come from.

To view the Profit & Loss Report, click the Reporting Section on the left-hand navigation menu and click on the "Profit & Loss" section, then click "Profit & Loss".

Profit & Loss Graph

Information in the graph and table can be edited to contain various combinations of categories and information. For more information on how to do this, please see our NATS5 Customize a Report wiki.

By default, the Profit & Loss graph shows a day-by-day breakdown of relevant statistics for your sites, including:

  • Raw Hits: Total number of hits every single time a surfer clicks on your link codes.
  • Unique Hits: Total number of hits when a completely new surfer clicks on your link codes.
  • Total Joins: How many surfers have joined your site.
  • Total Income: Total dollar amount of income before payouts/biller fees.
  • Total Expenses: Total amount in dollars of all expenses. (Payouts + Fees + All Refunds)
  • Net: The total amount in dollars you have left over. (Total Income - Total Expenses)
Profit & Loss Table

Under the graph displays a table with some of the same information as well as some extra material. The default information includes the above information, as well as:

  • Raw Hit / Joins Ratio: The ratio between raw hits on a site to actual joins from that raw hit.
  • Unique Hits / Joins Ratio: The ratio between unique hits to actual joins from that unique hit.

NATS5 also offers the feature of being able to download a CSV dump for these statistics. To view this dump, simply click the button all the way to the right of the search bar and click "CSV Dump".


Additional Payout

The Additional Payout Report provides an in-depth view of any payouts categorized in the Profit & Loss Report as "Additional Payout". This report breaks down individual categories that comprise the additional payout using a graph that displays all statistics found in the table below based on dollar amount per day.

This report can prove useful for ensuring that your payouts for programs outside of basic programs are accurate -- this includes affiliate referral programs, account rep programs, partner payouts, etc. This table can be used to see houw costly these programs can be, as well as view a day-to-day breakdown of statistics not specified in the Profit & Loss report.

To vew the Additional Payout Report, go the Reporting Section on the left-hand navigation menu, click on "Profit & Loss" and then click "Additional Payout".

On the Additional Payout Report page, you will find a search box, a Payouts graph, and a table displaying any additional non-standard payouts in NATS. The serach box allows you to narrow down your results by using various parameters, including parameters from Date Range, Affiliate, Site/Option, and Tracking.

Additional Payout Graph

The Payouts graph provides a day-to-day breakdown of additional payouts you have or will make to affiliates, account representatives, or partners. These statistics include:

  • Affiliate Referral Payout: Displays the amount owed to affiliates who referred other affiliates.
  • Affiliate Referral Signup Payout: Displays the amount owed to referred affiliates who refer members to your sites.
  • Account Rep Payout: Displays the amount owed to your account representatives.
  • Partner Payout: Displays the amount owed to your site partner.
  • Correction Payout: Displays the dollar amount of any corrections that Too Much Media staff has made to your payments. Only TMM technicians can make corrections to your payments.
  • Tier Adjustment Payout: Displays the dollar amount of any adjustments made to payments because of referral tiers.
  • BYOA Payout: Displays any payments owed to affiliates from the Build Your Own Anything Module


The Additional Payout table below the graph contains the same information with exact values for the payments that you ahve made or will have to make. This includes the date that the additional payouts were built, as well as the total sum of all additional payouts that must be made.

Additional Payout Table


Transaction Report

The Transaction Report provides a list of any biller transaction that has been tracked by NATS. In this report, you will be able to view specific details about any transaction, including dollar figures, transaction type, and various transaction identification information. This helps to ensure that all transactions undertaken have been reflected in NATS, that all additions and deductions to the total transaction amount are accurate, and that your affiliate payouts are accurate as well.

To view you Transaction Report, go to the Reporting section on the left-hand navigation menu, click "Transaction", and on the drop-down menu, click "Transaction".

On the Transaction Report page, you will find a search box and a "Details" table. The search box allows you to narrow down your results by using various parameters, followed by an operator, and then the value itself.

Transactions Table

In the Details table, you will find various statistics related to any member transactions, including:

  • Server Time: The server time that the transaction was recorded.
  • Transaction ID: The ID used to track transaction statistics.
  • Biller Transaction ID: The transaction ID number used by the biller to track the transaction.
  • BillerID: The biller used to process the transaction.
  • Transaction Type: The type of transaction that took place. Includes rebills, initials, trials, refunds, etc.
  • Affiliate: The affiliate under which the member signed up.
  • MemberID: The username of the member who underwent the transaction.
  • Member Subscription ID: The subscription ID of the member who underwent the transaction.
  • Site: The site the member signed up for.
  • Amount:The total dollar amount that the transaction cost.
  • Process Type: The type in which the member performed the transaction.


Subscription Report

The Subscription Report provides in-depth details of each and every member subscription that is tracked in your NATS system. This allows you to search and view specifics about each member subscription, ensure its validity, and see specific dollar figures regarding each subscription.

To view your Subscription Report page, go to the Reporting section on the left-hand navigation menu, click "Subscription", and on the drop-down menu, click "Subscription".

Subscription Report Table


In the Subscription table, you will find various statistics related to subscriptions, including:

  • Member Subscription ID: The subscription ID number used to identify subscriptions in NATS.
  • Biller Subscription:
  • Biller: The biller that the member used to process their transaction.
  • Joined: The date the member joined.
  • Expires: The date the member's subscription is set to expire.
  • Coupon: The coupon that the member used during signup, if any.
  • Spent: The dollar amount of money the member has spent on subscriptions.
  • Cost: Any cost that you incurred as a result of the subscription (for example, biller fees).
  • Taxes: Any taxes taken from the member subscription by the biller.
  • Refunded: How much money has been refunded to a member (for example, refunds and credits).
  • Affiliate: Displays the affiliate that referred the specified member.
  • SiteID: Displays the site that the member is subscribed to.
  • Program: Displays the join program that the member signed up under.
  • Option: Displays the join optino that the member used to register.
  • Trial: Whether the member is under a trial membership, or a full membership.
  • Status: Whether the member's account is active, inactive, or never joined.


Surfer Actions Report

The Surfer Actions Report displays any actions taken by surfers visiting sites in your NATS installation and any relevant information regarding that action, such as where the action or error took place, what action was taken (transactions, cascades, errors, etc.) and the details of that action. This report can be used to view the actions that a surfer has taken on your site, as well as checking for errors that occurred during their surfing process and why/where that error occurred.

To view your Surfer Actions Report page, go to the Reporting section on the left-hand navigation menu, click "Surfer Actions", and on the drop-down menu, click "Surfer Actions".

Surfer Actions Report Table

The information provided in the Surfer Actions table is as follows:

  • Session: Displays a PHP-generated session ID for the action that took place.
  • Time: The time and date that the surfer action was recorded.
  • Site: The site this surfer action occurred on.
  • Program: The program this surfer's transactions are paid out under.
  • Actions: The action that the surfer took (i.e., cascades, transactions, errors).
  • Details: Provides additional information on the surfer action (transactions display the transaction number; errors display what caused the error).


Affiliate Ratios Report

The Affiliate Ratios Report provides a way to view or search for affiliates by performance. You can view affiliate income, expenses, and various affiliate statistics and ratios.

To view your Affiliate Ratios Report page, go to the Reporting section on the left-hand navigation menu, click "Affiliate Ratios", and on the drop-down menu, click "Affiliate Ratios".

Affiliate-Ratios Table.jpg

The information provided in the Affiliate Ratios table includes:

  • Breakdown: The name of the affiliate.
  • Impression:
  • Raw Hit / Joins Ratio: The ratio between raw hits to your site through this affiliate and those that joined.
  • Visitor:
  • Unique Hits / Joins Ratio: The ratio between unique hits and those that joined that site.
  • Total Income: Total dollar amount of income before payouts/biller fees.
  • Expenses: Total amount in dollars of all expenses. (Payouts + Fees + All Refunds)
  • Net: The total amount in dollars you have left over. (Total Income - Total Expenses)