sendings_recipients_statistics (timeseries)

Required permit	Rate limit tokens cost	Available intervals
Reporting:Api:Report:SendingsRecipientsStatistics	3	1h, 1d, 1w, 1mo

This report allows you to get information about sending recipients.

Fields

loyalty_club_id

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

ID of loyalty club.

sending_id

Type	Filterable
Integer

Internal ID of sending.

gender

Type	Filterable
Enum

Gender of member. See members report.

age

Type	Filterable
Enum

Age group of member. See members report.

place_id

Type	Filterable
Integer

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

Query without aggregations

Query returns series with numbers of recipients to which sending was sent.

{
    "interval": "1h",
    "range_timezone": "Europe/Oslo",
    "time_buckets": [
        "2025-08-27T10:00:00.000+02:00",
        "2025-08-27T11:00:00.000+02:00",
        "2025-08-27T12:00:00.000+02:00",
        "2025-08-27T13:00:00.000+02:00",
        "2025-08-27T14:00:00.000+02:00",
        "2025-08-27T15:00:00.000+02:00"
    ],
    "series": [
        {
            "label": {},
            "values": [
                51,
                50,
                60,
                38,
                40,
                28
            ]
        }
    ],
    "data_points": 6,
    "result_type": "timeseries"
}

Aggregations

sending_id

Fetch recipients aggregated by sending ID.

Labels

Key	Type	Description
sending_id	Integer	See in `Fields`

Example query response

{
    "interval": "1h",
    "range_timezone": "Europe/Oslo",
    "time_buckets": [
        "2025-08-27T10:00:00.000+02:00",
        "2025-08-27T11:00:00.000+02:00",
        "2025-08-27T12:00:00.000+02:00",
        "2025-08-27T13:00:00.000+02:00",
        "2025-08-27T14:00:00.000+02:00",
        "2025-08-27T15:00:00.000+02:00"
    ],
    "series": [
        {
            "label": {
                "sending_id": 15235
            },
            "values": [
                45,
                42,
                48,
                30,
                37,
                26
            ]
        },
        {
            "label": {
                "sending_id": 15432
            },
            "values": [
                3,
                3,
                2,
                3,
                1,
                null
            ]
        }
    ],
    "data_points": 11,
    "result_type": "timeseries"
}

gender

Fetch recipients aggregated by gender.

Labels

Key	Type	Description
gender	Enum	See in `Fields`

Example query response

{
    "interval": "1h",
    "range_timezone": "Europe/Oslo",
    "time_buckets": [
        "2025-08-27T10:00:00.000+02:00",
        "2025-08-27T11:00:00.000+02:00",
        "2025-08-27T12:00:00.000+02:00",
        "2025-08-27T13:00:00.000+02:00",
        "2025-08-27T14:00:00.000+02:00",
        "2025-08-27T15:00:00.000+02:00"
    ],
    "series": [
        {
            "label": {
                "gender": "man"
            },
            "values": [
                7,
                4,
                13,
                7,
                7,
                6
            ]
        },
        {
            "label": {
                "gender": "woman"
            },
            "values": [
                36,
                37,
                42,
                28,
                33,
                22
            ]
        }
    ],
    "data_points": 12,
    "result_type": "timeseries"
}

age

Fetch recipients aggregated by age group.

Labels

Key	Type	Description
age	Enum	See in `Fields`

Example query response

{
    "interval": "1h",
    "range_timezone": "Europe/Oslo",
    "time_buckets": [
        "2025-08-27T10:00:00.000+02:00",
        "2025-08-27T11:00:00.000+02:00",
        "2025-08-27T12:00:00.000+02:00",
        "2025-08-27T13:00:00.000+02:00",
        "2025-08-27T14:00:00.000+02:00",
        "2025-08-27T15:00:00.000+02:00"
    ],
    "series": [
        {
            "label": {
                "age": "15-19"
            },
            "values": [
                1,
                null,
                1,
                1,
                1,
                2
            ]
        },
        {
            "label": {
                "age": "20-24"
            },
            "values": [
                1,
                3,
                1,
                1,
                1,
                3
            ]
        }
    ],
    "data_points": 11,
    "result_type": "timeseries"
}

place_id

Fetch recipients aggregated by place_id (location).

Labels

Key	Type	Description
place_id	Integer	See in `Fields`

Example query response

{
    "interval": "1h",
    "range_timezone": "Europe/Oslo",
    "time_buckets": [
        "2025-08-27T10:00:00.000+02:00",
        "2025-08-27T11:00:00.000+02:00",
        "2025-08-27T12:00:00.000+02:00",
        "2025-08-27T13:00:00.000+02:00",
        "2025-08-27T14:00:00.000+02:00",
        "2025-08-27T15:00:00.000+02:00"
    ],
    "series": [
        {
            "label": {
                "place_id": 20355
            },
            "values": [
                1,
                1,
                null,
                null,
                null,
                null
            ]
        },
        {
            "label": {
                "place_id": 24137
            },
            "values": [
                1,
                null,
                null,
                null,
                2,
                1
            ]
        }
    ],
    "data_points": 5,
    "result_type": "timeseries"
}

sendings_recipients_statistics (timeseries)

Fields#

loyalty_club_id#

sending_id#

gender#

age#

place_id#

Query without aggregations#

Aggregations#

sending_id#

Labels#

Example query response#

gender#

Labels#

Example query response#

age#

Labels#

Example query response#

place_id#

Labels#

Example query response#

Fields

loyalty_club_id

sending_id

gender

age

place_id

Query without aggregations

Aggregations

sending_id

Labels

Example query response

gender

Labels

Example query response

age

Labels

Example query response

place_id

Labels

Example query response