Trends

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

Request Parameters
Parameter Name Required Data Type Format/Values (Default in bold) Description
filterCommissionDate Yes date YYYYMMDD or date range Filter results by the commission date or a range of dates.
enableFacets Yes boolean true or false or pipe seperated values of facet names Enable or disable facets for the trend data.
query No (All records will be returned if not used.) string What you searched 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.
filterBrand No string pipe seperated values Filter commission trend data by brands.
filterBrowser No string pipe seperated values Filter commission trend data by browsers.
filterBrowserType No string pipe seperated values Filter commission trend data by browser types.
filterBrowserVersion No string pipe seperated values Filter commission trend data by browser version.
filterCatalog No string pipe seperated values Filter trend data by the catalog it came from (US, UK, CA, local, coupons, travel).
filterCatalogId No string pipe seperated values Filter trend data by catalogId, find which products have been sold.
filterCategory No string pipe seperated values Filter commission trend data by categories.
filterCity No string pipe seperated values Filter commission trend data 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 Filter commission trend data by the countries they came from.
filterDeviceBrand No string pipe seperated values Filter commission trend data by the device brand in which they were made. (Used for mobile and tablets.)
filterDeviceModel No string pipe seperated values Filter commission trend data by the device model in which they were made. (Used for mobile and tablets.)
filterInterface No string pipe seperated values/ pa, pl, api or unknown Filter commission trend data by the interface which produced the commission.
filterKeyword No string pipe seperated values Filter commission trend data 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 commission trend data by merchant names.
filterOperatingSystem No float pipe seperated values Filter trend data by which operating system was used when the commission was made.
filterOperatingSystemVersion No float pipe seperated values Filter trend data by the operating systems version.
filterOrganic No boolean true or false Filter trend data by whether the commission is organic or not.
filterProductId No string pipe seperated values Filter commission trend data by productIds.
filterRegion No string pipe seperated values 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 Filter trend data by the screen resolution when commissions were made.
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.
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.
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.
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.
Build a Request