offers_events_stats (statistics)

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

This report allows you to get statistics related to offers.

Fields

loyalty_club_id

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

ID of loyalty club.

event_type

Type	Filterable
Enum

Type of offer event.

This field is an enum, possible values are:

used

unique_used - produced when member uses the offer for the first time

granted

unique_granted - produced when offer is granted to member for the first time

seen

unique_seen - produced when offer member sees the offer for the first time

clicked

unique_clicked - produced when offer is clicked by the member for the first time

liked

unliked

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.

application

Type	Filterable
String	-

Represents slug of API application (product/source) used when generating the event.

platform

Type	Filterable
Enum	-

Represents platform used when generating the event. It is generating based on application field.

This field is an enum, possible values are:

android

ios

website

webforms

other

Query without aggregations

Query returns series with offers events labeled by event_type.

Labels

Key	Type	Description
event_type	Enum	See in `Fields`

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

Aggregations

offer_type

Labels

Key	Type	Description
offer_type	Enum	See in `Fields`
event_type	Enum	See in `Fields`

store_id

Labels

Key	Type	Description
store_id	Integer	See in `Fields`
event_type	Enum	See in `Fields`

collection_id

Labels

Key	Type	Description
collection_id	Integer	See in `Fields`
event_type	Enum	See in `Fields`

platform

Labels

Key	Type	Description
platform	Enum	See in `Fields`
event_type	Enum	See in `Fields`

offers_events_stats (statistics)

Fields#

loyalty_club_id#

event_type#

offer_type#

offer_id#

store_id#

collection_id#

application#

platform#

Query without aggregations#

Labels#

Aggregations#

offer_type#

Labels#

store_id#

Labels#

collection_id#

Labels#

platform#

Labels#

Fields

loyalty_club_id

event_type

offer_type

offer_id

store_id

collection_id

application

platform

Query without aggregations

Labels

Aggregations

offer_type

Labels

store_id

Labels

collection_id

Labels

platform

Labels