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. Transactions
  • 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
      • transactions_history (timeseries)
    • Receipt Submissions
    • Attendance Challenge
  • 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. Transactions

transactions_history (timeseries)

Required permitRate limit tokens costAvailable intervals
Reporting:Api:Report:TransactionsHistory31h, 1d, 1w, 1mo
This report allows you to get information about transactions feeded into the system.
NOTE
In some of cases, transactions can be added out of order. Such transactions will be reflected in past data with a delay.
Receipt scanner transactions can be ingested within 60 days.

Fields#

loyalty_club_id#

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

event_type#

TypeFilterable
Enum
Type of transaction event.
This field is an enum, possible values are:
debit
refund

source_type#

TypeFilterable
Enum
Source of transactions event.
This field is an enum, possible values are:
api
receipt_scan

store_id#

TypeFilterable
Integer
ID of store to which transaction is assigned.

member_attendance_challenge_edition_id#

TypeFilterable
Integer
ID of attendance challenge edition to which transaction is attributed.

amount#

TypeFilterable
Numeric
Value of transaction.
Can be negative (e.g. in refunds).

member_gender#

TypeFilterable
String
Gender of member who executed the transaction. See members report.

member_age#

TypeFilterable
String
Age of member who executed the transaction. 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.

member_country#

TypeFilterable
String
Country (location) of member. See members report.

Query without aggregations#

Query returns series with number of transactions.
{
    "interval": "5m",
    "range_timezone": "Europe/Oslo",
    "time_buckets": [
        "2025-08-27T09:25:00.000+02:00",
        "2025-08-27T09:30:00.000+02:00",
    ],
    "series": [
        {
            "label": {},
            "values": [
                3,
                2
            ]
        },
    ],
    "data_points": 2,
    "result_type": "timeseries"
}

Aggregations#

sum_amount#

Query returns series with sum of transactions amounts.

average_amount#

Query returns series with average of transaction amount in given timespan.

average_and_stddev_over_amount#

Query returns series with average of transaction amount and standard deviation in given timespan.

store_id#

Query returns series with number of transactions grouped by store_id.

Labels#

KeyTypeDescription
store_idIntegerSee in Fields

sum_amount_by_store_id#

Query returns series with sum of transactions amounts grouped by store_id.

Labels#

KeyTypeDescription
store_idIntegerSee in Fields

average_amount_by_store_id#

Query returns series with average of transaction amount in given timespan grouped by store_id.

Labels#

KeyTypeDescription
store_idIntegerSee in Fields

average_and_stddev_over_amount_by_store_id#

Query returns series with average of transaction amount and standard deviation in given timespan grouped by store_id.

Labels#

KeyTypeDescription
store_idIntegerSee in Fields

source_type#

Query returns series with number of transactions grouped by source_type.

Labels#

KeyTypeDescription
source_typeEnumSee in Fields

sum_amount_by_source_type#

Query returns series with sum of transactions amounts grouped by source_type.

Labels#

KeyTypeDescription
source_typeEnumSee in Fields

member_age#

Query returns series with number of transactions grouped by member_age.

Labels#

KeyTypeDescription
member_ageEnumSee in Fields

sum_amount_by_member_age#

Query returns series with sum of transactions amounts grouped by member_age.

Labels#

KeyTypeDescription
member_ageEnumSee in Fields

member_gender#

Query returns series with number of transactions grouped by member_gender.

Labels#

KeyTypeDescription
member_genderStringSee in Fields

sum_amount_by_member_gender#

Query returns series with sum of transactions amounts grouped by member_gender.

Labels#

KeyTypeDescription
member_genderStringSee in Fields

member_city_place_id#

Query returns series with number of transactions grouped by member_city_place_id.

Labels#

KeyTypeDescription
member_city_place_idIntegerSee in Fields

sum_amount_by_member_city_place_id#

Query returns series with sum of transactions amounts grouped by member_city_place_id.

Labels#

KeyTypeDescription
member_city_place_idIntegerSee in Fields

member_place_id#

Query returns series with number of transactions grouped by member_place_id.

Labels#

KeyTypeDescription
member_place_idIntegerSee in Fields

sum_amount_by_member_place_id#

Query returns series with sum of transactions amounts grouped by member_place_id.

Labels#

KeyTypeDescription
member_place_idIntegerSee in Fields

member_created_at#

Query returns series with number of transactions grouped by member_created_at (year and month).

Labels#

KeyTypeDescription
member_created_atString(ISO 8601 timestamp truncated to month)See in Fields

sum_amount_by_member_created_at#

Query returns series with sum of transactions amounts grouped by member_created_at.

Labels#

KeyTypeDescription
member_created_atString(ISO 8601 timestamp truncated to month)See in Fields

member_country#

Query returns series with number of transactions grouped by member_country.

Labels#

KeyTypeDescription
member_countryString(ISO 3166-1 alpha-2)See in Fields

sum_amount_by_member_country#

Query returns series with sum of transactions amounts grouped by member_country.

Labels#

KeyTypeDescription
member_countryString(ISO 3166-1 alpha-2)See in Fields
Previous
offers_usages_stats (statistics)
Next
Find Locations Coordinates
Built with