offers_collections (records)

Required permit	Rate limit tokens cost
Reporting:Api:Report:OffersCollections	1

This report allows you to get information about collections in your loyalty club.

Fields

id

Type	Filterable	Can change?
Integer

Collection ID

loyalty_club_id

Type	Filterable	Can change?
Integer	(via `X-Customer` header)

ID of loyalty club.

clicks_count

Type	Filterable	Can change?
Integer

Number of clicks done on offers in the collection.

grants_count

Type	Filterable	Can change?
Integer

Number of times when offer within collection was granted to a member.

likes_count

Type	Filterable	Can change?
Integer

Number of times offer in the collection was liked.

seen_count

Type	Filterable	Can change?
Integer

Number of times offer in the collection was seen.

Seen is counted by checking how many times the offer image was downloaded.

usages_count

Type	Filterable	Can change?
Integer

Number of times offer in the collection has been used.

Query without aggregations

Query returns list of sendings.

{
    "records": [
        {
          "id": 42,
          "loyalty_club_id": 43,
          "clicks_count": 2,
          "grants_count": 0,
          "likes_count": 3,
          "seen_count": 10,
          "usages_count": 2,
        }
    ],
    "pagination": {
        "next_page_info": "CNOW-AE"
    },
    "result_type": "records"
}

offers_collections (records)

Fields#

id#

loyalty_club_id#

clicks_count#

grants_count#

likes_count#

seen_count#

usages_count#

Query without aggregations#