> For the complete documentation index, see [llms.txt](https://developer.sahamati.org.in/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.sahamati.org.in/onboarding-to-saans/access-aggregated-data-from-sahamati.md).

# Access Aggregated Data from Sahamati

## FIP Health API V1.0.0

### Introduction

FIUs want to access SAANS Data during their user journeys. This allows them to manage the user expectations and Lending FIUgate the user through the AA flow depending upon the health status of the APIs. This could lead to a higher success percentage by only raising a consent request when the likelihood of the consent's success is much higher.

### Target Users

* FIUs
* AA Client apps
* FIP Health monitoring systems
* Real-time alert systems - both central and FIP specific

### How the solution works

The solution requires a system that can identify FIUs that have subscribed to the service. These FIUs will expose endpoints that receive data from the API on a 30 min frequency. This data will be calculated based on the performance of FIP over the last 30 min. The data will be pushed to the exposed endpoint.

### API Broad Specs

API Specs: [View Specs](https://github.com/Sahamati/FIP-Health-API-Specs/blob/main/Health%20API%20Specs.json)

Sample JSON: [View Sample](https://github.com/Sahamati/FIP-Health-API-Specs/blob/main/Sample%20response.json)

SLAs: [View SLAs](https://docs.google.com/spreadsheets/d/1T4qzwGPfqCxM-910HTZDkkikEezxUrU1/edit?usp=sharing\&ouid=102688648237312172000\&rtpof=true\&sd=true)

\
**Status Criteria** 

The status value is derived from two metrics, Success % and P50 Latency, using the following logic:

| Status   | Condition                                                       |
| -------- | --------------------------------------------------------------- |
| `GOOD`   | `Success %` **> 95%** AND `P50 Latency` **< 5000 ms**           |
| `BAD`    | `Success %`**≤ 95%** OR `P50 Latency`**≥ 5000 ms**              |
| `UNSURE` | No data available or metrics are incomplete for the time window |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developer.sahamati.org.in/onboarding-to-saans/access-aggregated-data-from-sahamati.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.