Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

AffiliateReport Type

Represents a single line in an affiliate report.


Properties

Name Type Description
AffiliateId
Integer The ID of the affiliate that generated the click or transaction.
AffiliateContactName
String The contact name of the affiliate that generated the click or transaction.
AffiliateBusinessName
String The business name of the affiliate that generated the click or transaction.
ImpressionsTotal
Integer The total number of impressions.
ImpressionsBot
Integer The number of impressions that were from known bots.
ClicksTotal
Integer The total number of clicks.
ClicksBot
Integer The number of clicks that were from known bots.
TransactionsPending
Integer The number of pending transactions.
TransactionsApproved
Integer The number of approved transactions.
TransactionsVoid
Integer The number of void transactions.
SaleValuePending
Decimal The total sale value of pending transactions.
SaleValueApproved
Decimal The total sale value of approved transactions.
SaleValueVoid
Decimal The total sale value of void transactions.
CommissionPending
Decimal The total commission amount of pending transactions.
CommissionApproved
Decimal The total commission amount of approved transactions.
CommissionVoid
Decimal The total commission amount of void transactions.
OverridePending
Decimal The total override fees of pending transactions.
OverrideApproved
Decimal The total override fees of approved transactions.
OverrideVoid
Decimal The total override fees of void transactions.

JSON XML

Example

{
    "AffiliateId": 1,
    "AffiliateContactName": "John Smith",
    "AffiliateBusinessName": "Example Pty Ltd",
    "ImpressionsTotal": 3000,
    "ImpressionsBot": 10,
    "ClicksTotal": 1000,
    "ClicksBot": 10,
    "TransactionsPending": 10,
    "TransactionsApproved": 5,
    "TransactionsVoid": 1,
    "SaleValuePending": 1000.00,
    "SaleValueApproved": 500.00,
    "SaleValueVoid": 100.00,
    "CommissionPending": 100.00,
    "CommissionApproved": 50.00,
    "CommissionVoid": 10.00,
    "OverridePending": 25.00,
    "OverrideApproved": 12.50,
    "OverrideVoid": 2.50
}
<MerchantReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Merchant">
    <AffiliateId>1</AffiliateId>
    <AffiliateContactName>John Smith</AffiliateContactName>
    <AffiliateBusinessName>Example Pty Ltd<AffiliateBusinessName>
    <ImpressionsTotal>3000</ImpressionsTotal>
    <ImpressionsBot>10</ImpressionsBot>
    <ClicksTotal>1000</ClicksTotal>
    <ClicksBot>10</ClicksBot>
    <TransactionsPending>10</TransactionsPending>
    <TransactionsApproved>5</TransactionsApproved>
    <TransactionsVoid>1</TransactionsVoid>
    <SaleValuePending>1000.00</SaleValuePending>
    <SaleValueApproved>500.00</SaleValueApproved>
    <SaleValueVoid>100.00</SaleValueVoid>
    <CommissionPending>100.00</CommissionPending>
    <CommissionApproved>50.00</CommissionApproved>
    <CommissionVoid>10.00</CommissionVoid>
    <OverridePending>25.00</OverridePending>
    <OverrideApproved>12.50</OverrideApproved>
    <OverrideVoid>2.50</OverrideVoid>
</MerchantReport>

Related Links