Error
Analytics
Analytics JSON
Retrieve analytics data in JSON format for a completed consent journey.
POST
Error
Overview
The Analytics JSON API allows you to retrieve analytics and insights data in JSON format for a specific consent journey. This API provides processed analytical data based on the financial information collected through the Account Aggregator framework.Key Use Cases
- Journey Analytics: Retrieve analytics data associated with a specific consent journey.
- Consent-Level Insights: Get analytical insights tied to a particular consent ID.
- JSON Format: Receive structured analytics data in JSON format for easy integration.
Important Notes
- The consent journey must be completed before calling this API.
- Both
consentIDandjourneyIDare required to identify the specific analytics dataset.
Authentication
This API requires authentication using the following headers:Your unique client identifier provided by FinPro during onboarding. This ID is used to authenticate your application.
Your confidential client secret key provided by FinPro. This must be kept secure and never exposed in client-side code.
The unique identifier for your application (e.g., your application’s package name or bundle ID). This helps FinPro identify which application is making the request.
Your organization’s unique identifier assigned by FinPro. This identifies your organization in the FinPro system.
Must be set to
application/json to indicate that the request body contains JSON data and that the response will be in JSON format.Request Body
The unique consent identifier provided by the Account Aggregator after consent approval. This must be a valid consent ID.
The unique journey identifier associated with the consent flow. This identifies the specific journey for which analytics data is requested.
Request Example
Response
Success Response Example
The response contains comprehensive banking analytics data. Below is a trimmed example showing the key structure — the actual response includes many more categories and analysis sections.The actual response is significantly larger and includes detailed breakdowns across 50+ transaction categories, account-wise analysis, monthly trends, EMI analytics, fraud/FCU indicators, and more. The example above is trimmed to illustrate the key structure.
Response Structure
| Field | Type | Description |
|---|---|---|
ver | string | API version |
status | string | Overall response status (success or failure) |
data.status | string | Processing status (SUCCESS) |
data.transaction_id | string | Unique transaction identifier |
data.journey_id | string | Journey identifier used for the analytics |
data.data.bankingAnalysis | object | Contains all banking analytics sections |
data.data.bankingAnalysis.overallAnalysis | object | Aggregate metrics — balances, credit/debit totals, volatility, weekly analytics |
data.data.bankingAnalysis.completeCategoryWiseAnalysis | object | Transaction analysis broken down by 50+ categories (e.g., Transfer in, UPI, Salary, EMI) |
data.data.bankingAnalysis.accountProfiles | array | Account holder details, balances, and account metadata |
data.data.bankingAnalysis.fcuIndicators | object | Fraud and risk indicators |
data.data.bankingAnalysis.bounceAnalysis | object | Cheque and ECS bounce analysis |
data.data.bankingAnalysis.investmentAnalysis | object | Investment-related transaction analysis |
data.data.bankingAnalysis.loanCreditsAnalysis | object | Loan credit transaction analysis |
data.data.bankingAnalysis.nudges | object | Behavioural insights and nudges |
data.data.bankingAnalysis.abbTables | object | Average bank balance tables |
data.data.rawData | object | Raw financial data used to generate the analytics |
Code Examples
Authorizations
Your unique client identifier provided by MoneyOne during FIU onboarding
Your confidential client secret provided by MoneyOne
Your organization's unique identifier in the FinPro system
Application-specific identifier for tracking API calls
Body
application/json
Request body for retrieving analytics data in JSON format.
