API reference

Account

The account a token acts as.

• GET /api/user Get Authenticated User

Metrics & Leaderboards

Metric values, trendlines, leaderboards and the reference lists that drive them.

• GET /api/v1/data/metrics Get Metrics
• GET /api/v1/data/sources Get Sources
• GET /api/v1/data/periods Get Periods
• GET /api/v1/data/leaderboard Get Leaderboard
• GET /api/v1/data/metrics/query Query Metric Value
• GET /api/v1/data/metrics/trendline Query Metric Trendline

Risk

Stores whose discount, $0-check or cash-share rates fall outside their usual range.

• GET /api/v1/risk/findings List Risk Findings

Locations

Stores: create, update, activate, deactivate and delete them, and assign their districts and groups.

• GET /api/v1/locations Get Locations
• POST /api/v1/locations Create Location
• GET /api/v1/locations/{id} Get Location
• PATCH /api/v1/locations/{id} Patch Location
• DEL /api/v1/locations/{id} Delete Location
• POST /api/v1/locations/bulk-district-assignments Bulk Assign Locations to Districts
• PUT /api/v1/locations/{id}/location-groups Sync Location Groups

Location Groups

Named sets of locations that give franchisee users access to several stores.

• GET /api/v1/location-groups Get Location Groups
• POST /api/v1/location-groups Create Location Group
• GET /api/v1/location-groups/{id} Get Location Group
• PATCH /api/v1/location-groups/{id} Patch Location Group
• DEL /api/v1/location-groups/{id} Delete Location Group

Districts

Geographic or organizational groupings of locations, up to two levels per location.

• GET /api/v1/districts Get Districts
• POST /api/v1/districts Create District
• GET /api/v1/districts/{id} Get District
• PATCH /api/v1/districts/{id} Patch District
• DEL /api/v1/districts/{id} Delete District

Location Categories

Store types or formats used to classify and partition locations.

• GET /api/v1/location-categories Get Location Categories
• POST /api/v1/location-categories Create Location Category
• GET /api/v1/location-categories/{id} Get Location Category
• PATCH /api/v1/location-categories/{id} Patch Location Category
• DEL /api/v1/location-categories/{id} Delete Location Category

Users

User accounts, their perspective, direct location and location groups.

• GET /api/v1/users Get Users
• POST /api/v1/users/bulk-location-groups Bulk Add Location Groups to Users
• GET /api/v1/users/{id} Get User
• PATCH /api/v1/users/{id} Patch User
• DEL /api/v1/users/{id} Delete User
• PUT /api/v1/users/{id}/location-groups Sync Location Groups

Orders

Check-level order history from the point of sale.

• GET /api/v1/orders Get Orders
• GET /api/v1/orders/{external_id} Get Order

Custom Metrics

Daily values for the metrics your brand defines itself.

• POST /api/custom-metrics Submit Custom Metric Values