Skip to main content

Filterting & Sorting

This GoKart API supports flexible filtering and sorting options to help refine and order results based on your requirements.

Written by GoKart Support

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.

  1. orderby (string, query parameter):

    • Specifies the property by which the results should be sorted.

    • Example: ?orderby=launchDate will sort the results by the launchDate property.

  2. order_asc (boolean, query parameter):

    • Determines the direction of the sorting.

    • Set to true for ascending order and false for descending order.

    • Example: ?orderby=launchDate&order_asc=true will sort the results by launchDate in ascending order.

Available Sortable Properties

Property Name

Description

launchDate

Sort by the date the offer was launched

epc

Sort by the EPC (Earnings per Click) value

reward

Sort by the total reward amount for the offer

revenue

Sort by the total revenue amount for the offer

name

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

categoryId

UUID

Filter results by a specific category ID

filter.categoryId=123e4567-e89b-12d3-a456-426614174000

categoryName

String

Filter results by category name

filter.categoryName=games

placementId

UUID

Filter results by placement ID

filter.placementId=9f3c2e18-7d45-4a91-b6d8-2b7c5e4d91fa

isFeatured

Boolean

Filter results to only include featured items (true/false)

filter.isFeatured=true

search

String

Search by keyword across offerName and headline

filter.search=Coins

Progress

Enum

Filters based on enum values for progress states. Progress filter only available for PubMember API

filter.Progress=InProgress

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

Did this answer your question?