offers_usages_stats (statistics)

Required permit	Rate limit tokens cost	Available intervals
Reporting:Api:Report:OffersUsagesStats	2	5m, 1h, 1d, 1w, 1mo

This report allows you to get statistics related to usages of offers.

Fields

loyalty_club_id

Type	Filterable
Integer	(via `X-Customer` header)

ID of loyalty club.

offer_type

Type	Filterable
Enum

Type of offer.

This field is an enum, possible values are:

regular

birthday

exclusive

welcome

competition

reward

carbon_offset_item

parking

parking_exclusive

game_prize

informational

offer_id

Type	Filterable
Integer

Offer ID.

store_id

Type	Filterable
Integer

ID of store to which offer is assigned.

collection_id

Type	Filterable
Integer

ID of collection to which offer is assigned.

member_gender

Type	Filterable
String

Gender of member who used the offer. See members report.

member_age

Type	Filterable
String

Age of member who used the offer. See members report.

member_place_id

Type	Filterable
Integer

Place ID (location) of member. See members report.

member_city_place_id

Type	Filterable
Integer

City place ID (location) of member. See members report.

authorized

Type	Filterable
Boolean

Whether offer usage was authorized (e.g. using QR code).

authorization_type

Type	Filterable
String

Type of authorization (e.g. QR code).

Query without aggregations

Query returns series with offers usages events.

Labels

{
    "interval": "5m",
    "range_timezone": "Europe/Oslo",
    "series": [
        {
            "label": {},
            "value": 100
        },
    ],
    "data_points": 1,
    "result_type": "statistics"
}

Aggregations

member_gender

Labels

Key	Type	Description
member_gender	String	See in `Fields`

member_age

Labels

Key	Type	Description
member_age	Enum	See in `Fields`

member_city_place_id

Labels

Key	Type	Description
member_city_place_id	Integer	See in `Fields`

member_place_id

Labels

Key	Type	Description
member_place_id	Integer	See in `Fields`

authorized

Labels

Key	Type	Description
authorized	Boolean	See in `Fields`

authorization_type

Labels

Key	Type	Description
authorization_type	String	See in `Fields`

offers_usages_stats (statistics)

Fields#

loyalty_club_id#

offer_type#

offer_id#

store_id#

collection_id#

member_gender#

member_age#

member_place_id#

member_city_place_id#

authorized#

authorization_type#

Query without aggregations#

Labels#

Aggregations#

member_gender#

Labels#

member_age#

Labels#

member_city_place_id#

Labels#

member_place_id#

Labels#

authorized#

Labels#

authorization_type#

Labels#

Fields

loyalty_club_id

offer_type

offer_id

store_id

collection_id

member_gender

member_age

member_place_id

member_city_place_id

authorized

authorization_type

Query without aggregations

Labels

Aggregations

member_gender

Labels

member_age

Labels

member_city_place_id

Labels

member_place_id

Labels

authorized

Labels

authorization_type

Labels