Top Locations

Returns the top N locations ranked by total spend or transaction count within a date window. Supports period vocabulary, arbitrary from/to date ranges, and optional distributor/distributor_card scoping. Grouped by physical location (multiple terminals at the same location are merged).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
uuid

Narrow to a single distributor (Marketer UUID).

uuid

Narrow to a single distributor card UUID.

string
enum
Defaults to month

Time window vocabulary.

Allowed:
date

Start date (YYYY-MM-DD). Takes precedence over period.

date

End date (YYYY-MM-DD). Takes precedence over period.

integer
1 to 100
Defaults to 10

Number of locations to return (default 10, max 100).

string
enum
Defaults to spend

Sort criterion: spend (default) or count.

Allowed:
Responses
200

counts distinct cardholders at a location

400

rejects unknown period

403

rejects requests without transaction read permission

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!