Analytics

Overview

Two read-only services sitting on the same synced store as Transaction History, pre-computed during the sync. They answer "what did our cash position look like last month" without you pulling every transaction and aggregating it yourself.

Both take the same parameters, neither paginates, and both inherit the sync's limits: toDate caps at T-1, and data starts from the account's onboarding date.

A synced day with no activity comes back with zero values. A missing date means the sync has not completed or has failed — the same caveat as Transaction History, with the same lack of a self-service way to check which dates are present.

---

Prerequisites

• Authentication: Obtain an access token using the OAuth2 Client Credentials flow (see Getting Started → Authentication). Every endpoint in this product takes Authorization: Bearer <ACCESS_TOKEN> — there are no exceptions.
• Subscription: Subscribe to Analytics in your chosen environment.

A token carries only the scopes you asked for, so one issued for a different product is rejected here. Request this product's scope, or ask for several scopes in a single token as described on the Authentication page.

---

Errors

Both services share the failure shape used across Statements: category and errors appear only on failure, and the category determines the HTTP status.