annotations

Get trace annotations filtered by trace_ids and/or identifier.

Changed on

Return trace annotations for a project, filtered by trace_ids, identifier, or both. At least one of trace_ids or identifier must be supplied. When both are supplied, results are the AND-intersection of the two filters.

get/v1/projects/{project_identifier}/trace_annotations

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

project_identifierstring required

The project identifier: either project ID or project name. If using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters.

Query parameters

trace_idsstring[] nullable

Optional list of trace ids to fetch annotations for. If omitted, identifier must be supplied.

identifierstring[] nullable

Optional list of annotation identifiers to filter by. Each value must be non-empty. If omitted, trace_ids must be supplied. When combined with trace_ids, results are the AND-intersection of both filters.

include_annotation_namesstring[] nullable

Optional list of annotation names to include. If provided, only annotations with these names will be returned (allowlist). When omitted, the response includes every matching row regardless of name (no annotation names are excluded by default).

exclude_annotation_namesstring[] nullable

Optional list of annotation names to exclude from results.

cursorstring nullable

A cursor for pagination

limitinteger

The maximum number of annotations to return in a single request

Response

Successful Response

next_cursorstring nullable required

Changes

  • 4c3ecf13cbaaRevision changes
    • info

      added the new optional query request parameter identifier

    • info

      the query request parameter trace_ids became optional

    • info

      query request parameter trace_ids list-of-types was widened by adding types null

    • info

      for the query request parameter trace_ids, the minItems was decreased from 1 to 0

    • info

      for the query request parameter trace_ids, the type was generalized from array to no type

  • c81391216eb5Revision changes
    • breaking

      the query request parameter trace_ids became required

    • breaking

      query request parameter trace_ids list-of-types was narrowed by removing types null

    • breaking

      for the query request parameter trace_ids, the minItems was increased from 0 to 1

    • breaking

      for the query request parameter trace_ids, the type changed from no type to array

    • warning

      deleted the query request parameter identifier