> For the complete documentation index, see [llms.txt](https://saviorofhealth.gitbook.io/saviorofhealth-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://saviorofhealth.gitbook.io/saviorofhealth-docs/partners-and-data-api/data-api.md).

# Data API

Threshold-suppressed aggregates from the member panel (survey distributions, symptom radar, behavioural cohorts, time series and AI signal reports) as plain JSON over HTTPS.

```
Base URL: https://saviorofhealth.app/api/v1
```

|                     |                                                                                                                                                                |
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Aggregates only** | No individual records. Slices under the threshold are suppressed server-side.                                                                                  |
| **Bot-excluded**    | Aggregates are computed over accounts not classified as automated. Exception: the `responses` counts on `/campaigns` are raw counts that are not bot-filtered. |
| **Approval-gated**  | Keys are issued per organisation after manual review and can be revoked at any time.                                                                           |
| **Usage-metered**   | Per-plan daily limits. Only successful calls are logged and counted toward the limit.                                                                          |

## Reading this reference

* [Authentication](https://saviorofhealth.gitbook.io/saviorofhealth-docs/partners-and-data-api/data-api/authentication.md): the `Authorization` header, key format, scopes.
* [Plans and rate limits](https://saviorofhealth.gitbook.io/saviorofhealth-docs/partners-and-data-api/data-api/plans-and-limits.md): basic / pro / enterprise.
* [k-Anonymity and suppression](https://saviorofhealth.gitbook.io/saviorofhealth-docs/partners-and-data-api/data-api/k-anonymity.md): what is suppressed, how, and the known gaps.
* [Errors](https://saviorofhealth.gitbook.io/saviorofhealth-docs/partners-and-data-api/data-api/errors.md): status codes and the error envelope.
* [Endpoints](https://saviorofhealth.gitbook.io/saviorofhealth-docs/partners-and-data-api/endpoints.md): twelve `GET` endpoints, one page each, with request and response examples.
* [Request access](https://saviorofhealth.gitbook.io/saviorofhealth-docs/partners-and-data-api/data-api/request-access.md).

## Response envelope

Every documented endpoint returns its payload alongside a metadata object:

```json
{
  "generatedAt": "2026-10-19T09:01:00.000Z",
  "kAnonymity": 5,
  "license": "Aggregate-only. No re-identification. Redistribution requires written consent.",
  "docs": "https://saviorofhealth.app/developers"
}
```

The `license` line applies to every response. The `kAnonymity` value is the live threshold.

{% hint style="info" %}
**Example figures are illustrative.** Response samples in this reference use small numbers (`panelSize: 4210`) so the shape is easy to read. The live panel is far larger (245,335 accounts not classified as automated at the 19 October 2026 snapshot) and actual counts will differ. These are accounts not classified as automated; active respondents are fewer.
{% endhint %}


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://saviorofhealth.gitbook.io/saviorofhealth-docs/partners-and-data-api/data-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
