---
updatedAt: 2026-05-27T08:29:42.000Z
agentTools:
  projectIndex: https://docs.bridgeapi.io/llms.txt
---

# Get insights

Retrieve the insights for each category of a user's transactions

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Bridge API",
    "version": "2025-01-15",
    "description": "Bridge provides an Open Banking API to initiate payments and aggregate financial data.  \nOur API uses standards such as HTTP verbs, RESTful routing and JSON for payloads.",
    "license": {
      "name": "Proprietary",
      "url": "https://docs.bridgeapi.io"
    },
    "contact": {
      "name": "BridgeAPI",
      "url": "https://bridgeapi.io",
      "email": "support@bridgeapi.io"
    }
  },
  "servers": [
    {
      "description": "Production",
      "url": "https://api.bridgeapi.io"
    }
  ],
  "tags": [
    {
      "name": "Insights",
      "description": "Insights for each category of a user's transactions"
    }
  ],
  "paths": {
    "/v3/aggregation/insights/category": {
      "summary": "Insights",
      "parameters": [
        {
          "$ref": "#/components/parameters/version"
        }
      ],
      "get": {
        "operationId": "GetInsights",
        "summary": "Get insights",
        "description": "Retrieve the insights for each category of a user's transactions",
        "tags": [
          "Insights"
        ],
        "security": [
          {
            "userTokenBearerAuth": [],
            "clientIdAuth": [],
            "clientSecretAuth": []
          }
        ],
        "responses": {
          "200": {
            "description": "Insights",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "type": "object",
                      "properties": {
                        "resources": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "oldest_existing_transaction": {
                                "type": "string",
                                "example": "2024-09-05"
                              },
                              "fully_analyzed_month": {
                                "type": "number",
                                "example": 3
                              },
                              "fully_analyzed_day": {
                                "type": "number",
                                "example": 90
                              },
                              "risky_transactions": {
                                "type": "number",
                                "example": 0
                              },
                              "kpis": {
                                "type": "object",
                                "properties": {
                                  "global": {
                                    "description": "Global metrics on the analyzed period",
                                    "type": "object",
                                    "properties": {
                                      "categories": {
                                        "type": "array",
                                        "items": {
                                          "type": "object",
                                          "properties": {
                                            "id": {
                                              "type": "number",
                                              "example": 320
                                            },
                                            "aggregates": {
                                              "type": "object",
                                              "properties": {
                                                "monetary_max": {
                                                  "type": "number",
                                                  "example": 1000
                                                },
                                                "monetary_mean": {
                                                  "type": "number",
                                                  "example": 369.28
                                                },
                                                "monetary_min": {
                                                  "type": "number",
                                                  "example": 10
                                                }
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  },
                                  "monthly": {
                                    "description": "Montyly metrics on the analyzed period",
                                    "type": "array",
                                    "items": {
                                      "type": "object",
                                      "properties": {
                                        "from": {
                                          "type": "string",
                                          "example": "2024-11-06"
                                        },
                                        "to": {
                                          "type": "string",
                                          "example": "2024-12-05"
                                        },
                                        "categories": {
                                          "type": "array",
                                          "items": {
                                            "type": "object",
                                            "properties": {
                                              "id": {
                                                "type": "number",
                                                "example": 320
                                              },
                                              "aggregates": {
                                                "type": "object",
                                                "properties": {
                                                  "monetary_sum": {
                                                    "type": "number",
                                                    "example": 550
                                                  },
                                                  "frequency": {
                                                    "type": "number",
                                                    "example": 2
                                                  }
                                                }
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                },
                "example": {
                  "oldest_existing_transaction": "2024-09-05",
                  "fully_analyzed_month": 3,
                  "fully_analyzed_day": 90,
                  "risky_transactions": 0,
                  "kpis": {
                    "global": {
                      "categories": [
                        {
                          "id": 320,
                          "aggregates": {
                            "monetary_max": 30.5,
                            "monetary_mean": 25.5,
                            "monetary_min": 20.5
                          }
                        },
                        {
                          "id": 1,
                          "aggregates": {
                            "monetary_max": 27,
                            "monetary_mean": 25.78,
                            "monetary_min": 24.55
                          }
                        }
                      ]
                    },
                    "monthly": [
                      {
                        "from": "2024-11-06",
                        "to": "2024-12-05",
                        "categories": [
                          {
                            "id": 320,
                            "aggregates": {
                              "monetary_sum": 30.5,
                              "frequency": 1
                            }
                          },
                          {
                            "id": 1,
                            "aggregates": {
                              "monetary_sum": 24.55,
                              "frequency": 1
                            }
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "parameters": {
      "version": {
        "in": "header",
        "name": "Bridge-Version",
        "schema": {
          "type": "string",
          "enum": [
            "2025-01-15"
          ],
          "default": "2025-01-15"
        },
        "required": true,
        "description": "The Bridge API version"
      }
    },
    "securitySchemes": {
      "userTokenBearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "Aggregation user access token"
      },
      "clientIdAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "Client-Id"
      },
      "clientSecretAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "Client-Secret"
      }
    }
  },
  "security": [
    {
      "clientIdAuth": [],
      "clientSecretAuth": []
    }
  ],
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": false
  }
}
```