API OverviewAPI Reference
developer.placewise.comapp.placewise.complacewise.com
API OverviewAPI Reference
developer.placewise.comapp.placewise.complacewise.com
IndexPublic APIManagement APIUsers APIOperations APIMessaging APIReporting API
ML APIData API
IndexPublic APIManagement APIUsers APIOperations APIMessaging APIReporting API
ML APIData API
  1. Offers
  • Introduction
  • Filter parameter specification
  • Data formats
    • Records
    • Timeseries
    • Statistics
  • Reports
    • Members
      • members (records)
      • members_count (records)
      • members_grouped_count (records)
      • member_balance (timeseries)
      • members_count_snapshot (timeseries)
      • members_count_history (timeseries)
    • Sendings
      • sendings (records)
      • sendings_events_history (timeseries)
      • sendings_recipients_statistics (timeseries)
      • sendings_links (records)
      • sendings_links_stats (records)
      • sendings_stats (statistics)
      • Examples
        • sendings - find sending by reporting_id
        • sendings_events_history - show sending events
        • sendings_recipients_statistics - show recipients by age groups
        • sendings_stats - show statistics for campaign
        • sendings_events_history - show sending events for campaign
        • sendings_stats - show statistics for all campaigns
        • sendings_events_history - show sending events for all campaigns
    • Links
      • links_visits_history (timeseries)
    • Offers
      • offers (records)
      • offers_collections (records)
      • offers_events_history (timeseries)
      • offers_usages_history (timeseries)
      • offers_events_stats (statistics)
      • offers_usages_stats (statistics)
    • Transactions
  • Geo API
    • Find Locations Coordinates
      POST
    • List places
      POST
    • Show place
      GET
  • Metadata
    POST
  • Field metadata
    POST
  • Query (records)
    POST
  • Query (timeseries)
    POST
  • Query (records) export
    POST
  • Query (timeseries) export
    POST
  • Tenants query (records) export
    POST
  • Tenants query (timeseries) export
    POST
  1. Offers

offers_usages_history (timeseries)

Required permitRate limit tokens costAvailable intervals
Reporting:Api:Report:OffersUsagesHistory35m, 1h, 1d, 1w, 1mo
This report allows you to get events related with usages of offers.

Fields#

loyalty_club_id#

TypeFilterable
Integer (via X-Customer header)
ID of loyalty club.

offer_type#

TypeFilterable
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#

TypeFilterable
Integer
Offer ID.

store_id#

TypeFilterable
Integer
ID of store to which offer is assigned.

collection_id#

TypeFilterable
Integer
ID of collection to which offer is assigned.

member_gender#

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

member_age#

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

member_place_id#

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

member_city_place_id#

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

authorized#

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

authorization_type#

TypeFilterable
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",
    "time_buckets": [
        "2025-08-27T09:25:00.000+02:00",
        "2025-08-27T09:30:00.000+02:00",
        "2025-08-27T09:35:00.000+02:00",
        "2025-08-27T09:40:00.000+02:00",
        "2025-08-27T09:45:00.000+02:00",
        "2025-08-27T09:50:00.000+02:00",
        "2025-08-27T09:55:00.000+02:00",
        "2025-08-27T10:00:00.000+02:00",
        "2025-08-27T10:05:00.000+02:00",
        "2025-08-27T10:10:00.000+02:00",
        "2025-08-27T10:15:00.000+02:00",
        "2025-08-27T10:20:00.000+02:00",
        "2025-08-27T10:25:00.000+02:00",
        "2025-08-27T10:30:00.000+02:00",
        "2025-08-27T10:35:00.000+02:00",
        "2025-08-27T10:40:00.000+02:00",
        "2025-08-27T10:45:00.000+02:00",
        "2025-08-27T10:50:00.000+02:00",
        "2025-08-27T10:55:00.000+02:00",
        "2025-08-27T11:00:00.000+02:00",
        "2025-08-27T11:05:00.000+02:00",
        "2025-08-27T11:10:00.000+02:00",
        "2025-08-27T11:15:00.000+02:00",
        "2025-08-27T11:20:00.000+02:00",
        "2025-08-27T11:25:00.000+02:00",
        "2025-08-27T11:30:00.000+02:00",
        "2025-08-27T11:35:00.000+02:00",
        "2025-08-27T11:40:00.000+02:00",
        "2025-08-27T11:45:00.000+02:00",
        "2025-08-27T11:50:00.000+02:00",
        "2025-08-27T11:55:00.000+02:00",
        "2025-08-27T12:00:00.000+02:00",
        "2025-08-27T12:05:00.000+02:00",
        "2025-08-27T12:10:00.000+02:00",
        "2025-08-27T12:15:00.000+02:00",
        "2025-08-27T12:20:00.000+02:00",
        "2025-08-27T12:25:00.000+02:00",
        "2025-08-27T12:30:00.000+02:00",
        "2025-08-27T12:35:00.000+02:00",
        "2025-08-27T12:40:00.000+02:00",
        "2025-08-27T12:45:00.000+02:00",
        "2025-08-27T12:50:00.000+02:00",
        "2025-08-27T12:55:00.000+02:00",
        "2025-08-27T13:00:00.000+02:00",
        "2025-08-27T13:05:00.000+02:00",
        "2025-08-27T13:10:00.000+02:00",
        "2025-08-27T13:15:00.000+02:00",
        "2025-08-27T13:20:00.000+02:00",
        "2025-08-27T13:25:00.000+02:00",
        "2025-08-27T13:30:00.000+02:00",
        "2025-08-27T13:35:00.000+02:00",
        "2025-08-27T13:40:00.000+02:00",
        "2025-08-27T13:45:00.000+02:00",
        "2025-08-27T13:50:00.000+02:00",
        "2025-08-27T13:55:00.000+02:00",
        "2025-08-27T14:00:00.000+02:00",
        "2025-08-27T14:05:00.000+02:00",
        "2025-08-27T14:10:00.000+02:00",
        "2025-08-27T14:15:00.000+02:00",
        "2025-08-27T14:20:00.000+02:00",
        "2025-08-27T14:25:00.000+02:00",
        "2025-08-27T14:30:00.000+02:00",
        "2025-08-27T14:35:00.000+02:00",
        "2025-08-27T14:40:00.000+02:00",
        "2025-08-27T14:45:00.000+02:00",
        "2025-08-27T14:50:00.000+02:00",
        "2025-08-27T14:55:00.000+02:00",
        "2025-08-27T15:00:00.000+02:00",
        "2025-08-27T15:05:00.000+02:00",
        "2025-08-27T15:10:00.000+02:00",
        "2025-08-27T15:15:00.000+02:00",
        "2025-08-27T15:20:00.000+02:00"
    ],
    "series": [
        {
            "label": {},
            "values": [
                3,
                2,
                10,
                5,
                4,
                2,
                5,
                null,
                20,
                5,
                5,
                7,
                11,
                8,
                3,
                4,
                7,
                8,
                4,
                8,
                2,
                7,
                9,
                19,
                9,
                3,
                16,
                null,
                2,
                2,
                8,
                null,
                26,
                9,
                1,
                2,
                2,
                5,
                3,
                8,
                6,
                16,
                10,
                2,
                null,
                5,
                8,
                null,
                2,
                1,
                1,
                8,
                9,
                12,
                6,
                1,
                1,
                6,
                12,
                3,
                9,
                3,
                5,
                3,
                14,
                7,
                2,
                7,
                6,
                7,
                2,
                null
            ]
        },
    ],
    "data_points": 259,
    "result_type": "timeseries"
}

Aggregations#

member_gender#

Labels#

KeyTypeDescription
member_genderStringSee in Fields

member_age#

Labels#

KeyTypeDescription
member_ageEnumSee in Fields

member_city_place_id#

Labels#

KeyTypeDescription
member_city_place_idIntegerSee in Fields

member_place_id#

Labels#

KeyTypeDescription
member_place_idIntegerSee in Fields

authorized#

Labels#

KeyTypeDescription
authorizedBooleanSee in Fields

authorization_type#

Labels#

KeyTypeDescription
authorization_typeStringSee in Fields
Previous
offers_events_history (timeseries)
Next
offers_events_stats (statistics)
Built with