Skip to content
Tidepool API/Metrics API/
/
Record Metrics Event for...

Metrics API (1.0)

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 section.

Download OpenAPI description
metrics.v1.json
metrics.v1.yaml
Overview
URL

https://support.tidepool.org/

API Support

support@tidepool.org

License

BSD-2-Clause

Languages
Servers
Mock server

https://tidepool.redocly.app/_mock/reference/metrics.v1/

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/

Internal

APIs intended for internal use by Tidepool.

Operations

Metrics

Record metrics events.

These metrics APIs are intended for use by Tidepool products to capture free-form metrics events. The APIs have no request body, nor do they return any meaningful responses. There are very few constraints or validation of the input parameters. Any number of additional query parameters can be included in the API requests, and they are recorded along with the metrics event. It is OK to send them asynchronously in a fire-and-forget manner.

Operations

Record Metrics Event for User

Request

Records a new metrics event for the user identified by the userId parameter. This API does not require a session token, but if one is provided it must be a valid token. The userId parameter is not validated. Any query parameters supplied with the request will be recorded as part of the event.

Security
sessionToken
Path
userIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

Tidepool User ID

eventNamestring(Metrics Event Name)required

Client-defined event name. The metrics service imposes no restrictions on the event name. The event name must be URL-safe, or encoded as such, as it is sent as part of the URL path. Current best practice is to prefix the event name with the client application name, such as blip, followed by the actual event name, such as Viewed Care Team List. The resulting full event name might be blip - Viewed Care Team List, but encoded in URL-safe manner (i.e. converting spaces to %20). This allows differentiation between recording similar events by different client applications.

Example: blip%20-%20Viewed%20Care%20Team%20List
curl -i -X GET \
  'https://tidepool.redocly.app/_mock/reference/metrics.v1/metrics/user/{userId}/blip%20-%20Viewed%20Care%20Team%20List' \
  -H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE'

Responses

Success

Record Metrics Event for Logged-In User

Request

Records a new metrics event for the user identified by the session token. This API requires a session token, and it must be a valid user token. The userId parameter is extracted from the session token. Any query parameters supplied with the request will be recorded as part of the event.

Security
sessionToken
Path
eventNamestring(Metrics Event Name)required

Client-defined event name. The metrics service imposes no restrictions on the event name. The event name must be URL-safe, or encoded as such, as it is sent as part of the URL path. Current best practice is to prefix the event name with the client application name, such as blip, followed by the actual event name, such as Viewed Care Team List. The resulting full event name might be blip - Viewed Care Team List, but encoded in URL-safe manner (i.e. converting spaces to %20). This allows differentiation between recording similar events by different client applications.

Example: blip%20-%20Viewed%20Care%20Team%20List
curl -i -X GET \
  https://tidepool.redocly.app/_mock/reference/metrics.v1/metrics/thisuser/blip%20-%20Viewed%20Care%20Team%20List \
  -H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE'

Responses

Success

Record Metrics Event for Server

Request

Records a new metrics event on behalf of a server. This API requires a session token, and it must be a valid server token. Any query parameters supplied with the request will be recorded as part of the event.

Security
sessionToken
Path
serverNamestring(Metrics Server Name)required

Server-defined server name. The metrics service imposes no restrictions on the server name. The server name must be URL-safe, or encoded as such, as it is sent as part of the URL path.

Example: hydrophone
eventNamestring(Metrics Event Name)required

Client-defined event name. The metrics service imposes no restrictions on the event name. The event name must be URL-safe, or encoded as such, as it is sent as part of the URL path. Current best practice is to prefix the event name with the client application name, such as blip, followed by the actual event name, such as Viewed Care Team List. The resulting full event name might be blip - Viewed Care Team List, but encoded in URL-safe manner (i.e. converting spaces to %20). This allows differentiation between recording similar events by different client applications.

Example: blip%20-%20Viewed%20Care%20Team%20List
curl -i -X GET \
  https://tidepool.redocly.app/_mock/reference/metrics.v1/metrics/server/hydrophone/blip%20-%20Viewed%20Care%20Team%20List \
  -H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE'

Responses

Success