Skip to main content
Exist logo
  • Category: analytics
  • Auth: OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 12
  • Triggers: 0
  • Slug: EXIST
  • Version: 20261101_00

Tools

Slug: EXIST_ACQUIRE_ATTRIBUTE_OWNERSHIPTool to acquire ownership of attributes for the authenticated user. Allows your service to write data to these attributes. Use when you need to create or take ownership of attributes before writing data. Acquiring a templated attribute the user doesn’t have yet will create this attribute and give you ownership.

Input Parameters

array
required
List of attributes to acquire ownership of (maximum 35)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXIST_GET_ATTRIBUTES_WITH_VALUESRetrieve a paged list of the authenticated user’s attribute metadata and recent values, limited to read scopes. The response model accepts numeric values; the request does not expose the number of days of values.

Input Parameters

integer
Page number for pagination (1-based indexing)
integer
Page size for pagination (number of attributes per page)
string
Filter to only attributes in these groups, as comma-separated list of group names (e.g., ‘activity,workouts’)
string
Maximum date for values in ISO format YYYY-MM-DD (e.g., ‘2024-12-31’)
string
Minimum date for values in ISO format YYYY-MM-DD (e.g., ‘2024-01-01’)
string
Filter to only these attributes, as comma-separated list of attribute names (e.g., ‘steps,sleep’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXIST_GET_ATTRIBUTE_TEMPLATESTool to retrieve a paged list of supported attribute templates. Use when you need to browse available templates before creating or updating data.

Input Parameters

integer
Page index, starting at 1
integer
Number of results per page
array
Filter by groups, e.g., [‘activity’,‘workouts’]
boolean
Include templates with priority >= 10

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXIST_GET_AVERAGESTool to retrieve the most recent average values for each tracked attribute, with one set per week. Returns overall weekly averages plus daily breakdowns (Monday-Sunday). Use include_historical flag to retrieve historical average records.

Input Parameters

integer
Page index, 1-based. Defaults to 1.
integer
Number of results per page.
array
Filter by attribute groups. Provide a list, e.g. [‘activity’,‘workouts’].
string
Maximum (most recent) date inclusive, in yyyy-mm-dd format.
string
Minimum (oldest) date inclusive, in yyyy-mm-dd format.
array
Filter by specific attributes. Provide a list, e.g. [‘steps’,‘floors’].
boolean
Set true to retrieve historical average records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXIST_GET_CORRELATIONSRetrieve a paginated list of correlations discovered between tracked attributes in the last week. Correlations reveal statistical relationships between different metrics (e.g., sleep duration vs mood). Filter by relationship strength, confidence level (statistical significance), or specific attributes. Returns correlation coefficients, p-values, and human-readable descriptions.

Input Parameters

integer
Page index (default 1)
integer
Number of items per page (max 100)
boolean
Filter to return only correlations above a certain relationship strength threshold (stronger correlations indicate closer relationships between attributes)
string
Filter correlations to this attribute name
boolean
Filter to return only correlations with five-star confidence (highest statistical significance, certain to be related)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXIST_GET_INSIGHTSTool to retrieve automatically-generated insights about patterns in tracked data for the authenticated user. Insights are observations about correlations, trends, and anomalies (e.g., “You walked more on days you slept well”). Use when analyzing user behavior patterns or displaying personalized feedback.

Input Parameters

integer
Page index, 1-based. Defaults to 1.
integer
Number of insights to return per page (max 100)
string
Most recent date (inclusive) of results to be returned, in format YYYY-MM-DD
string
Oldest date (inclusive) of results to be returned, in format YYYY-MM-DD
integer
Filter by insight priority, where 1 = today and 4 = last month

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXIST_GET_OWNED_ATTRIBUTESTool to retrieve attributes owned by your service for the authenticated user. Use when you need to limit data updates to only the attributes your service controls.

Input Parameters

integer
Page index, 1-based. Defaults to 1.
integer
Number of results per page.
array
Filter by attribute groups. Provide a list, e.g. [‘activity’,‘workouts’].
boolean
If true, only manual attributes; if false, excludes them.
array
Filter by attribute names. Provide a list, e.g. [‘sleep_efficiency’,‘steps’].
boolean
If true, only templated attributes are returned.
boolean
If true, includes inactive attributes (active=false).
boolean
If true, includes attributes with priority >= 10.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXIST_GET_USER_ATTRIBUTESRetrieve a paged list of the user’s attributes without values, for metadata and selection. Results are limited to read scopes and can be narrowed with group, attribute and other filters.

Input Parameters

integer
Page index, 1-based. Defaults to 1.
integer
Number of results per page.
boolean
If true, only attributes owned by this client are returned.
array
Filter by attribute groups. Provide a list, e.g. [‘activity’,‘workouts’].
boolean
If true, only manual attributes; if false, excludes them.
array
Filter by attribute names. Provide a list, e.g. [‘sleep_efficiency’,‘steps’].
boolean
If true, only templated attributes are returned.
boolean
If true, includes inactive attributes (active=false).
boolean
If true, includes attributes with priority >= 10.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXIST_GET_USER_PROFILERetrieve the authenticated user’s profile details and preferences, including timezone, account settings and status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXIST_INCREMENT_ATTRIBUTE_VALUESTool to increment attribute values by a delta amount rather than setting totals. Use for counters and cumulative data. Does not work with string, scale, or time of day attributes.

Input Parameters

array
required
List of attributes to increment with name, date, and delta value. Does not work with string, scale, or time of day attributes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXIST_OAUTH2_AUTHORIZEConstructs an OAuth2 authorization URL for Exist.io. This tool generates the URL that users must visit in their browser to grant permissions to your application. After user consent, Exist redirects back to your redirect_uri with an authorization code that can be exchanged for an access token. This action does not make an API call - it only builds the authorization URL.

Input Parameters

string
required
Space-separated list of permission scopes to request. Available scopes follow the pattern [category]_read or [category]_write. Categories include: activity, productivity, mood, sleep, workouts, events, finance, food, health, location, media, social, weather, custom, and manual. Example: ‘activity_read mood_write custom_read’
string
Optional opaque value used to maintain state between the authorization request and callback. Recommended for CSRF protection - generate a random token, store it in your session, and verify it matches when the user returns to your redirect_uri
string
required
The client application’s ID, as assigned by Exist
string
required
HTTPS URI where the user will be redirected after authorization. Must match the redirect URI registered with your Exist OAuth2 client application. The authorization code will be appended as a query parameter to this URI
string
OAuth2 response type. Must be ‘code’ for authorization code flow. This parameter defaults to ‘code’ and typically does not need to be changed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: EXIST_RELEASE_ATTRIBUTE_OWNERSHIPTool to release ownership of attributes for the authenticated user. Use when your service will stop providing data for an attribute or becomes inactive.

Input Parameters

array
required
List of attributes to release ownership of. Maximum 35 attributes per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not