ListAnnotation
Retrieves annotations using an optional filter.
api/v1/annotationsQuery Parameters
pageSizeinteger
The maximum number of annotations to return. The service may return fewer than this value. If unspecified, at most 50 annotations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional.
"int64"pageTokenstring
A page token, received from a previous ListAnnotations call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListAnnotations must match
the call that provided the page token. Optional.
filterstring
A Common Expression Language (CEL) filter string.
Available fields to filter by are annotation_id, start_time, end_time,
created_date, modified_date, run_id, name, description, state, created_by_user_id, created_by_rule_condition_version_id,
annotation_type, tag_name, and assignee.
For further information about how to use CELs, please refer to this guide.
For more information about the fields used for filtering, please refer to this definition. Optional.
organizationIdstring
This field is only required if your user belongs to multiple organizations.
orderBystring
How to order the retrieved annotations. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...".
Available fields to order_by are created_date, modified_date, start_time, and end_time.
If left empty, items are ordered by created_date in ascending order (oldest-first).
For more information about the format of this field, read this
Example: "created_date desc,modified_date"
A successful response.