# Data Summary API

The Tidepool API is an HTTP REST API used by Tidepool clients use to communicate with the Tidepool Platform.

For more information, see the [Getting Started](../docs/quick-start.md) section.

Version: 1.0
License: BSD 2-Clause "Simplified" License

## Servers

integration
```
https://external.integration.tidepool.org
```

production
```
https://api.tidepool.org
```

dev1
```
https://dev1.dev.tidepool.org
```

qa1
```
https://qa1.development.tidepool.org
```

qa2
```
https://qa2.development.tidepool.org
```

## Security

### sessionToken

Tidepool Session Token

Type: apiKey
In: header
Name: X-Tidepool-Session-Token

### serverToken

Tidepool Server Token

Type: apiKey
In: header
Name: X-Tidepool-Session-Token

## Download OpenAPI description

[Data Summary API](https://tidepool.redocly.app/_spec/reference/summary.v1.yaml)

## Summary

Summary Data

This API is for a component within the `data` service that calculates summary statistics for user accounts.
These routes are mostly executed by the `task` and `clinic-worker` services.

### Get User Summary

 - [GET /v1/summaries/{summaryType}/{userId}](https://tidepool.redocly.app/reference/summary.v1/internal/getsummary.md): Retrieve a summary by user id

### Get User Summary

 - [GET /v1/summaries/{summaryType}/{userId}](https://tidepool.redocly.app/reference/summary.v1/summary/getsummary.md): Retrieve a summary by user id

## Internal

APIs intended for internal use by Tidepool.

### Get User Summary

 - [GET /v1/summaries/{summaryType}/{userId}](https://tidepool.redocly.app/reference/summary.v1/internal/getsummary.md): Retrieve a summary by user id

### Get User Summary

 - [GET /v1/summaries/{summaryType}/{userId}](https://tidepool.redocly.app/reference/summary.v1/summary/getsummary.md): Retrieve a summary by user id