Note: When using this endpoint, you will need your accessKey. Please login to see it

Commissions

Endpoint URL: http://api.prosperent.com/api/commissions
HTTP Method: GET or POST

Request Parameters
Parameter Name Required Data Type Format/Values (Default in bold) Description
accessKey Yes string Log in to view your accessKey Use the accessKey to view your commissions.
filterCommissionDate Yes date YYYYMMDD or date range Filter results by the commission date or a range of dates.
query No (All records will be returned if not used.) string What to search for.
relevancyThreshold No float 0.7 (decimal between 0 and 1) Sets the relevancy threshold for the query param. Lower values will return more results, but not as relevant, while higher values will return less results, but more relevant. Note: Lower thresholds = slower API request times.
filterApiKey No string pipe seperated values Filter commission results by certain API Keys.
filterBrand No string pipe seperated values Filter commission results by brands.
filterBrowser No string pipe seperated values or null Filter commissions results by browsers.
filterBrowserType No string pipe seperated values or null Filter your commissions by browser types.
filterBrowserVersion No string pipe seperated values or null Filter by which browser versions have paid off the most.
filterCatalog No string pipe seperated values or null Filter commission data by the catalog it came from (US, UK, CA, local, coupons, travel).
filterCatalogId No string pipe seperated values Filter commission results by catalog ID, see which products are making you the most.
filterCategory No string pipe seperated values or null Filter your commission results by categories.
filterCity No string pipe seperated values or null Filter commission results by the city they originated in.
filterClickDate No date YYYYMMDD or date range Filter results by the date a click occurred or a range of dates.
filterCommissionId No string pipe seperated values Filter your commission results by commission IDs.
filterCommissionType No string pipe seperated values/ mine or referral Filter commission results by the type of commissions.
filterCountry No string pipe seperated values or null Filter your commission results by the countries they came from.
filterCpcGroup No string pipe seperated values Filter commission results by the CPC groups.
filterCurrentTransactionStatus No string pipe seperated values/ new, extended, adjusted, locked, closed or unknown Filter your commissions by their current transaction status.
filterDeviceBrand No string pipe seperated values or null Filter commissions by the device brand in which they were made. (Used for mobile and tablets.)
filterDeviceModel No string pipe seperated values or null Filter commissions by the device model in which they were made. (Used for mobile and tablets.)
filterHttpHost No string pipe seperated values or null Filter commission results by the host that made the commission came from.
filterInterface No string pipe seperated values/ pa, pl, api or unknown Filter results by the interface which produced the commission.
filterKeyword No string pipe seperated values Filter commission results the keywords of the products.
filterMerchantId No int pipe seperated values Filter by the merchant's ID. This ID is specific to one merchant across other networks.
filterMerchant No string pipe seperated values Filter results by merchant names.
filterOperatingSystem No string pipe seperated values or null Filter results by which operating system was used when you made the commission.
filterOperatingSystemVersion No string pipe seperated values or null Filter results by the operating systems version.
filterOrganic No boolean true or false Filter by whether the commission is organic or not.
filterPaymentId No string pipe seperated values or null Filter by the paymentID of a commission.
filterPaymentAmount No float 0.00 or range Filter by the payment amount of a commission.
filterProductId No string pipe seperated values Filter commissions by productIds.
filterQuery No string pipe seperated values or null Filter by the query that was used to earn the commission.
filterReferrerHost No string pipe seperated values or null Filter commissions by where the referrer came from.
filterReferrerUri No string pipe seperated values Filter commissions by the URI of the referrer.
filterRegion No string pipe seperated values or null Filter commissions by the region they originated from.
filterRequestUri No string pipe seperated values Filter by the request URI at the time of the commission.
filterScreenResolution No string 0x0 or null Filter by the screen resolution when the commission was made.
filterSerpQuery No string pipe seperated values or null Filter by the SERP query that led to the commission.
filterSid No string pipe seperated values or null Filter commissions by their Sub ID.
filterSubinterface No string 0x0 or null Filter by the SubInterface wich generated the click.
minPaymentAmount No float 0.00 Filters commission results that have a greater payment amount than the amount entered.
maxPaymentAmount No float 0.00 Filters commission results that have a lower payment amount than the amount entered.
minDaysToSale No integer 0 Filters results where the days to sale are greater than the amount entered.
maxDaysToSale No integer 0 Filters results where the days to sale are less than the amount entered.
sortBy No array • apiKey
• averageDaysToSale
• averagePaymentAmount
• brand
• browser
• browserType
• browserVersion
• catalogId
• category
• city
• clickDate
• clickDateYmd
• commissionDate
• commissionDateYmd
• commissionType
• country
• currentTransactionStatus
• daysToSale
• deviceBrand
• deviceModel
• groupCount
• httpHost
• interface
• keyword
• merchantId
• merchant
• operatingSystem
• operatingSystemVersion
• organic
• paymentAmount
• paymentId
• productId
• query
• referrerHost
• referrerUri
• region
• requestUri
• screenResolution
• serpQuery
• sid
• totalPaymentAmount
Sort results by the sort method in either ascending or descending order.

Append either of the following to change the sort direction:
asc
• desc
groupBy No string • all
• apiKey
• brand
• browser
• browserType
• browserVersion
• category
• catalogId
• city
• clickDate
• clickDateYmd
• commissionDate
• commissionDateYmd
• commissionType
• country
• cpcGroup
• currentTransactionStatus
• daysToSale
• deviceBrand
• deviceModel
• httpHost
• interface
• merchantId
• merchant
• operatingSystem
• operatingSystemVersion
• organic
• paymentId
• productId
• query
• referrerHost
• requestUri
• region
• screenResolution
• serpQuery
• sid
• subinterface
• userId
Group results by one of the attributes.
limit No integer 10 Amount of results you want to receive from the API call.
page No integer 1 Enter a page number to get the next set of results.
enableFacets No boolean true or false or pipe seperated values of facet names Enable or disable facets for the commission data.
Response Fields
Field Name Data Type Format Description
errors array Will show any errors that may have occured, otherwise it will be empty.
warnings array Will show any warnings that may have occured, otherwise it will be empty.
data array Displays the commission data.
commissionId string The ID of the commission, specific to only one commission.
interface string The interface that produced the commission (pa, pl, api or unknown).
commissionType string The type of commission (mine or referral).
paymentAmount float 0.00 The amount of commission.
currentTransactionStatus string The current status of the transaction (new, extended, adjusted, locked, closed or unknown).
commissionDate date time YYYY-MM-DD h:i:s The date and time that the commissions happened.
commissionDateYmd date YYYYMMDD The same as commissionDate just in YMD format without the time.
clickDate date time YYYY-MM-DD h:i:s The date and time of the click that lead to the commission.
clickDateYmd date YYYYMMDD Same as clickDate but in YMD format and only shows the date.
daysToSale integer 0 The amount of days from the click to commission.
catalogId string The catalogID of the product that was purchased.
productId string The productId of the product that was purchased.
brand string The brand of the product purchased.
merchantId int The merchant ID for the product purchased.
merchant string The merchant of the product purchased.
keyword string The keyword of the product purchased.
category string The category of the product purchased.
sid string The SID of the site the commission came from.
apiKey string The API Key used to query the API when the commission was made.
query string The query used when the commission was made.
country string The country the commission was made from.
region string The region the commission was made from.
city string The city the commission was made from.
referrerHost string The host that referred the purchaser to your site.
referrerUri string The URI of the host that referred the purchaser to your site.
organic boolean 1 (true) or 0 (false) Whether the commission was organic or not.
serpQuery string The SERP query used when the commission was made.
httpHost string The host site that the commission came from (the root domain of your site).
requestUri string The URI of the hostsite that made the request.
browser string The browser used to make the purchase.
browserVersion string The version of the browser used to make the purchase.
operatingSystem string The operating system used at the time of the purchase.
operatingSystemVersion string The version of the operating system used at the time of the purchase.
deviceBrand string The type of device used to make the purchase (mobileor tablets).
deviceModel string The model of device used to make the purchase (mobileor tablets).
screenResolution string 0x0 The screen resolution being used when the purchase was made.
facets array The facets that are active and their counts and values.
[facetName] array The name of the facet.
count integer The amount of products found for each facet value.
value string The value of the facet, for instance, the merchant name.
page integer 0 The page number of the result set.
limit integer 0 The limit you have set.
totalRecords integer 0 Total records for the page of results.
totalRecordsAvailable integer 0 Total records available to you.
totalRecordsFound integer 0 Total records available in our data feed that match your search.