PowerEPOS Reporting Queries Overview

PowerEPOS provides a JSON API for querying both raw and aggregated sales transaction data.

Getting Started

Please see our onboarding documentation for getting setup with credentials.

Architecture Overview

As a third party service you will be communicating with our Auth Server for creating access tokens and our POSCore instances for performing the actual reporting queries.

Architecture Overview

Query Types

There are two main ways to query sales reporting data from POSCore: Aggregate Queries and Sales Transaction Queries.

Aggregate Queries

Aggregate Queries provide a fast, multi-dimensional and fully filterable slice of aggregate sales data;

  • Good for answering queries like "Total Sales filtered for a range of time and only 'food' items".
  • Querying/Filtering is limited to provided dimensions.
  • Most queries are expected to return in under a second.

Raw Data Queries

Sales Transactions Queries provide queries into the raw underlying transactions/zreports:

  • Good for downloading the full history for a given set of filters.
  • Most queries are expected to return in 1 to 30 seconds (depending on filters).
  • Limited to 100 records at a time but pagination is supported.