Skip to content

entries

Fetch paginated entries collection

Arguments

category · String · The category of entry (e.g Weight or Blood Pressure) to return.
client_id · String · The ID of the client whose entries to return.
end_datetime_range · String · This field takes in a datetime string, and returns entries before that datetime. Must be sent in with a start_datetime_range.
end_range · String · This field takes in a date (e.g 2020-11-29), and returns entries before the beginning of that day. Must be sent in with a start_range.
entry_id · String · The ID of a specific entry to return.
group_id · String · The ID of a user group to filter entries by.
include_inactive · Boolean · When true, includes entries from deactivated users. Only applies when no client_id is provided.
is_org · Boolean · When true, returns entries for all client in the organization.
keywords · String · A search string to filter entries by.
sort_by · String · Options are [created_at::desc,created_at::asc, metric_stat::desc, metric_stat::asc, unsorted].
order_by · EntryOrderKeys · The sort order for returned entries.
start_datetime_range · String · This field takes in a datetime string, and returns entries after that datetime. Must be sent in with a end_datetime_range.
start_range · String · This field takes in a date (e.g 2020-11-28), and returns entries starting at the beginning of that day.
summary_view · Boolean · When true, returns all matching entries with associated meals included, without pagination.
type · String · The type of entry (e.g MetricEntry) to return.
after · String · Returns the elements in the list that come after the specified cursor.
before · String · Returns the elements in the list that come before the specified cursor.
first · Int · Returns the first _n_ elements from the list.
last · Int · Returns the last _n_ elements from the list.

Returns

EntryPaginationConnection

Example

query entries(
$category: String
$client_id: String
$end_datetime_range: String
$end_range: String
$entry_id: String
$group_id: String
$include_inactive: Boolean
$is_org: Boolean
$keywords: String
$sort_by: String
$order_by: EntryOrderKeys
$start_datetime_range: String
$start_range: String
$summary_view: Boolean
$type: String
$after: String
$before: String
$first: Int
$last: Int
) {
entries(
category: $category
client_id: $client_id
end_datetime_range: $end_datetime_range
end_range: $end_range
entry_id: $entry_id
group_id: $group_id
include_inactive: $include_inactive
is_org: $is_org
keywords: $keywords
sort_by: $sort_by
order_by: $order_by
start_datetime_range: $start_datetime_range
start_range: $start_range
summary_view: $summary_view
type: $type
after: $after
before: $before
first: $first
last: $last
) {
edges
nodes
page_info
total_count
}
}