Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

TrafficSourceArray Type

Represents zero or more affiliate traffic sources.


Array Elements

Type Description
TrafficSource Represents a single affiliate traffic source.

Remarks

If you use the GET Affiliates function to retrieve multiple affiliates, then the TrafficSources property of each Affiliate object will be NULL.

If you use the GET Affiliates/[id] function to retrieve a single affiliate, then the TrafficSources property will contain a TrafficSourceArray object.

Some properties may or may not be transmitted depending on the traffic source type.

The following properties will be transmitted for all traffic source types:

  • Type
  • Status

The following properties will only be transmitted if Type is "Website":

  • WebsiteDateCreated
  • WebsiteDateModified
  • WebsiteUrl
  • WebsiteName
  • WebsiteDescription
  • WebsiteCategory
  • WebsiteType
  • WebsiteWeeklyVisitors
  • WebsiteYearsOnline
  • WebsiteChannel
  • WebsiteVerified

The following properties will only be transmitted if Type is "Email List":

  • EmailListDateCreated
  • EmailListDateModified
  • EmailListName
  • EmailListDescription
  • EmailListCategory
  • EmailListSize
  • EmailListFrequency
  • EmailListOptIn

The following properties will only be transmitted if Type is "Social Media Page":

  • SocialMediaPageDateCreated
  • SocialMediaPageDateModified
  • SocialMediaPageType
  • SocialMediaPageUrl
  • SocialMediaPageName

The following properties will only be transmitted if Type is "Social Media Page" and SocialMediaPageType is "Facebook":

  • SocialMediaPageFacebookCategory
  • SocialMediaPageFacebookLikes

The following properties will only be transmitted if Type is "Social Media Page" and SocialMediaPageType is "Google+":

  • SocialMediaPageGooglePlusCircledBy

The following properties will only be transmitted if Type is "Social Media Page" and SocialMediaPageType is "Tumblr":

  • SocialMediaPageTumblrFollowers

The following properties will only be transmitted if Type is "Social Media Page" and SocialMediaPageType is "Twitter":

  • SocialMediaPageTwitterFollowers
  • SocialMediaPageTwitterFriends

The following properties will only be transmitted if Type is "Social Media Page" and SocialMediaPageType is "YouTube":

  • SocialMediaPageYouTubeDescription
  • SocialMediaPageYouTubeComments
  • SocialMediaPageYouTubeSubscribers
  • SocialMediaPageYouTubeVideos
  • SocialMediaPageYouTubeViews

JSON XML

Example

[
    {
        "Type": "Website",
        "Status": "Approved",
        "WebsiteDateCreated": "2000-01-01T00:00:00.000",
        "WebsiteDateModified": "2000-01-01T00:00:00.000",
        "WebsiteUrl": "https://www.example.com/",
        "WebsiteName": "Example Domain",
        "WebsiteDescription": "This domain is established to be used for illustrative examples in documents. You may use this domain in examples without prior coordination or asking for permission.",
        "WebsiteCategory": "Internet Services",
        "WebsiteType": "Content",
        "WebsiteWeeklyVisitors": 1001,
        "WebsiteYearsOnline": 10,
        "WebsiteChannel": "Content",
        "WebsiteVerified": true
	},
    {
        "Type": "Email List",
        "Status": "Pending",
        "EmailListDateCreated": "2000-01-01T00:00:00.000",
        "EmailListDateModified": "2000-01-01T00:00:00.000",
        "EmailListName": "Motorbike Enthusiasts",
        "EmailListDescription": "An email list of over 10,000 motorbike enthusiasts",
        "EmailListCategory": "Cars and Bikes",
        "EmailListSize": 5001,
        "EmailListFrequency": "Weekly",
        "EmailListOptIn": "Double"
    },
    {
        "Type": "Social Media Page",
        "Status": "Declined",
        "SocialMediaPageDateCreated": "2000-01-01T00:00:00.000",
        "SocialMediaPageDateModified": "2000-01-01T00:00:00.000",
        "SocialMediaPageType": "Facebook",
        "SocialMediaPageUrl": "https://www.facebook.com/example",
        "SocialMediaPageName": "Example Page",
        "SocialMediaPageFacebookCategory": "Electronics",
        "SocialMediaPageFacebookLikes": 1234
    }
]
<TrafficSourceArray xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Affiliate">
    <TrafficSource>
        <Type>Website</Type>
        <Status>Approved</Status>
        <WebsiteDateCreated>2000-01-01T00:00:00.000</WebsiteDateCreated>
        <WebsiteDateModified>2000-01-01T00:00:00.000</WebsiteDateModified>
        <WebsiteUrl>https://www.example.com</WebsiteUrl>
        <WebsiteName>Example Domain</WebsiteName>
        <WebsiteDescription>This domain is established to be used for illustrative examples in documents. You may use this domain in examples without prior coordination or asking for permission</WebsiteDescription>
        <WebsiteCategory>Internet Services</WebsiteCategory>
        <WebsiteType>Content</WebsiteType>
        <WebsiteWeeklyVisitors>1001</WebsiteWeeklyVisitors>
        <WebsiteYearsOnline>10</WebsiteYearsOnline>
        <WebsiteChannel>Content</WebsiteChannel>
        <WebsiteVerified>true</WebsiteVerified>
    </TrafficSource>
    <TrafficSource>
        <Type>Email List</Type>
        <Status>Pending</Status>
        <EmailListDateCreated>2000-01-01T00:00:00.000</EmailListDateCreated>
        <EmailListDateModified>2000-01-01T00:00:00.000</EmailListDateModified>
        <EmailListName>Motorbike Enthusiasts</EmailListName>
        <EmailListDescription>An email list of over 10,000 motorbike enthusiasts</EmailListDescription>
        <EmailListCategory>Cars and Bikes</EmailListCategory>
        <EmailListSize>5001</EmailListSize>
        <EmailListFrequency>Weekly</EmailListFrequency>
        <EmailListOptIn>Double</EmailListOptIn>
    </TrafficSource>
    <TrafficSource>
        <Type>Social Media Page</Type>
        <Status>Declined</Status>
        <SocialMediaPageDateCreated>2000-01-01T00:00:00.000</SocialMediaPageDateCreated>
        <SocialMediaPageDateModified>2000-01-01T00:00:00.000</SocialMediaPageDateModified>
        <SocialMediaPageType>Facebook</SocialMediaPageType>
        <SocialMediaPageUrl>https://www.facebook.com/example</SocialMediaPageUrl>
        <SocialMediaPageName>Example Page</SocialMediaPageName>
        <SocialMediaPageFacebookCategory>Electronics</SocialMediaPageFacebookCategory>
        <SocialMediaPageFacebookLikes>1234</SocialMediaPageFacebookLikes>
    </TrafficSource>
</TrafficSourceArray>

Related Links