API Reference

Get offer counts

get
https://kigo-core-server-stage.kigodigital.net/api/v1/offers/counts

Returns the total count of offers matching the specified category, type, and
redemption type filters.

Query Params
categories
array of strings

An optional list of category names to filter the counts by (e.g. "dining", "ACTIVITIES").

categories
categories_ids
array of int32s

An optional list of category IDs to filter the counts by (unique per node). Takes precedence over
categories: when present and non-empty, the count is filtered by these IDs and categories is ignored.

categories_ids
offer_types
array of objects

An optional list of offer types to filter the counts by.

offer_types
offer_redemption_types
array of objects

An optional list of offer redemption types to filter the counts by.

offer_redemption_types
Allowed:
double

Optional geo filter latitude. Must be provided together with location_longitude and radius.

double

Optional geo filter longitude. Must be provided together with location_latitude and radius.

double

Optional geo filter radius (miles). Must be provided together with location_latitude and location_longitude.

int32

Optional physical location ID filter.

Responses

Updated 5 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?