Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

MerchantReport Type

Represents a single line in a merchant report.

---

Properties

Name	Type	Description
MerchantId	Integer	The ID of the merchant that the click or transaction was generated for.
MerchantName	String	The campaign name of the merchant that the click or transaction was generated for.
MerchantAvatarUrl	Url	The address of the merchant's avatar image.
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.

JSON XML

Example

{
    "MerchantId": 1,
    "MerchantName": "Example Pty Ltd",
    "MerchantAvatarUrl": "https://c.cfjump.com/Avatars/0.png",
    "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
}

<MerchantReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Affiliate">
    <MerchantId>1</MerchantId>
    <MerchantName>Example Pty Ltd</MerchantName>
    <MerchantAvatarUrl>https://c.cfjump.com/Avatars/0.png</MerchantAvatarUrl>
    <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>
</MerchantReport>

Related Links

• GET Reports/Merchant Function
• MerchantReportArray Type