Sorting:
You can control the order of results returned by using the orderby and order_asc query parameters. By default, results are sorted by our EPC algorithm.
orderby (string, query parameter):
Specifies the property by which the results should be sorted.
Example:
?orderby=launchDatewill sort the results by thelaunchDateproperty.
order_asc (boolean, query parameter):
Determines the direction of the sorting.
Set to
truefor ascending order andfalsefor descending order.Example:
?orderby=launchDate&order_asc=truewill sort the results bylaunchDatein ascending order.
Available Sortable Properties
Property Name | Description |
| Sort by the date the offer was launched |
| Sort by the EPC (Earnings per Click) value |
| Sort by the total reward amount for the offer |
| Sort by the total revenue amount for the offer |
| Sort by the offer name |
Filtering:
General Structure
Filters are typically specified in the format filter.{FieldName}, where {FieldName} corresponds to the specific property you want to filter by. The field names are predefined based on the resource you are querying.
Available Filters
Filter Name | Filter Type | Description | Example |
| UUID | Filter results by a specific category ID |
|
| String | Filter results by category name |
|
| UUID | Filter results by placement ID |
|
| Boolean | Filter results to only include featured items ( |
|
| String | Search by keyword across |
|
| Enum | Filters based on enum values for progress states. Progress filter only available for PubMember API |
|
Multiple Filters:
You can apply multiple filters in a single query to narrow down results further.
Example:
https://api.[YOUR_TENANT].getgokart.ai/api/v1/offer-wall/offers?pub_member_id=123&filter.Progress=InProgress&filter.categoryId=123e4567-e89b-12d3-a456-426614174000
filters results that are both in progress and belong to a specific category
