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

Clicks

Endpoint URL: http://api.prosperent.com/api/clicks
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 clicks.
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 click results by certain API Keys.
filterBrand No string pipe seperated values Filter click results by brands.
filterBrowser No string pipe seperated values or null Filter click results by browsers.
filterBrowserType No string pipe seperated values or null Filter your clicks by browser types.
filterBrowserVersion No string pipe seperated values or null Filter by which browser versions have had the most clicks.
filterCatalog No string pipe seperated values or null Filter click data by the catalog it came from (US, UK, CA, local, coupons, travel).
filterCatalogId No string pipe seperated values Filter click results by catalog ID, see which products are making you the most.
filterCategory No string pipe seperated values or null Filter your click results by categories.
filterCid No string pipe seperated values or null Filter your clicks results by CID.
filterCity No string pipe seperated values or null Filter click 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.
filterCountry No string pipe seperated values or null Filter your click results by the countries they came from.
filterDeviceBrand No string pipe seperated values or null Filter clicks by the device brand in which they were made. (Used for mobile and tablets.)
filterDeviceModel No string pipe seperated values or null Filter clicks by the device model in which they were made. (Used for mobile and tablets.)
filterHttpHost No string pipe seperated values or null Filter click results by the host that made the click came from.
filterInterface No string pipe seperated values/ pa, pl, api or unknown Filter results by the interface which produced the click.
filterIp No string pipe seperated values/ pa, pl, api or unknown Filter results by the IP which produced the click.
filterKeyword No string pipe seperated values Filter click results the keywords of the products.
filterLocation No string pipe seperated values Filter results by Location.
filterMerchant No string pipe seperated values Filter results by merchant names.
filterMerchantId No string pipe seperated values Filter by the merchant's ID. This ID is specific to one merchant across other networks.
filterNetwork No string pipe seperated values Filter results by Network.
filterOperatingSystem No string pipe seperated values or null Filter results by which operating system was used when you made the click.
filterOperatingSystemVersion No string pipe seperated values or null Filter results by the operating systems version.
filterOrganic No string pipe seperated values Filter clicks by whether they were organic or not.
filterProductId No string pipe seperated values Filter clicks by productIds.
filterQuery No string pipe seperated values or null Filter by the query that was used when the click happened.
filterReferrerHost No string pipe seperated values or null Filter clicks by where the referrer came from.
filterReferrerUri No string pipe seperated values Filter clicks by the URI of the referrer.
filterRegion No string pipe seperated values or null Filter clicks by the region they originated from.
filterRequestUri No string pipe seperated values Filter by the request URI at the time of the click.
filterScreenResolution No string 0x0 or null Filter by the screen resolution when the click was made.
filterSerpQuery No string pipe seperated values or null Filter by the SERP query that led to the click.
filterSid No string pipe seperated values or null Filter clicks by their Sub ID.
filterSubinterface No string 0x0 or null Filter by the SubInterface wich generated the click.
filterUnitId No string pipe seperated values or null Filter by the UnitId that led to the click.
sortBy No array • cid
• clickDate
• interface
• subinterface
• catalogId
• productId
• brand
• merchant
• merchantId
• keyword
• category
• sid
• unitId
• apiKey
• query
• catalog
• country
• region
• city
• organic
• referrerHost
• referrerUri
• serpQuery
• httpHost
• requestUri
• location
• browserType
• browser
• browserVersion
• operatingSystem
• operatingSystemVersion
• deviceBrand
• deviceModel
• screenResolution
• ip
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 • cid
• clickDate
• clickDateYmd
• interface
• subinterface
• catalogId
• productId
• brand
• merchant
• merchantId
• keyword
• category
• sid
• unitId
• apiKey
• query
• catalog
• country
• region
• city
• organic
• referrerHost
• referrerUri
• serpQuery
• httpHost
• requestUri
• location
• browserType
• browser
• browserVersion
• operatingSystem
• operatingSystemVersion
• deviceBrand
• deviceModel
• screenResolution
• ip
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 click 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 click data.
interface string The interface that produced the click (pa, pl, api or unknown).
subinterface int The subinterface that produced the click.
clickDate date time YYYY-MM-DD h:i:s The date and time that the click happened.
clickDateYmd date YYYYMMDD The same as clickDate just in YMD format without the time.
network string 0 The network of the product/coupon that was clicked.
catalogId string The catalogID of the product that was clicked.
productId string The productId of the product that was clicked.
brand string The brand of the product clicked.
merchant string The merchant of the product clicked.
merchantId string The ID of the merchant, this ID is specific to only one merchant.
keyword string The keyword of the product clicked.
category string The category of the product clicked.
sid string The SID of the site the click came from.
apiKey string The API Key used to query the API when the click was made.
query string The query used when the click was made.
catalog string The catalog the click was made from (US, UK, CA, Coupons, Travel, Local).
country string The country the click was made from.
region string The region the click was made from.
city string The city the click was made from.
referrerHost string The host that referred the clicker to your site.
referrerUri string The URI of the host that referred the clicker to your site.
organic boolean 1 (true) or 0 (false) Whether the click was organic or not.
serpQuery string The SERP query used when the click was made.
httpHost string The host site that the click 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 click.
browserVersion string The version of the browser used to make the click.
operatingSystem string The operating system used at the time of the click.
operatingSystemVersion string The version of the operating system used at the time of the click.
deviceBrand string The type of device used to make the click (mobileor tablets).
deviceModel string The model of device used to make the click (mobileor tablets).
screenResolution string 0x0 The screen resolution being used when the click 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.