Sign in
annotations

Get session annotations filtered by session_ids and/or identifier.

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

get/v1/projects/{project_identifier}/session_annotations

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.

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

session_idsstring[] nullable

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

Optional list of session 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, session_ids must be supplied. When combined with session_ids, results are the AND-intersection of both filters.

Optional list of annotation identifiers to filter by. Each value must be non-empty. If omitted, session_ids must be supplied. When combined with session_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).

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.

Optional list of annotation names to exclude from results.

cursorstring nullable

A cursor for pagination

A cursor for pagination

limitinteger

The maximum number of annotations to return in a single request

The maximum number of annotations to return in a single request

Response

Successful Response

next_cursorstring nullable required

Changes

Changed in 2 of the 70 revisions of this API.415

  • 4c3ecf13cbaa5See the full diff
    • ○

      added the new optional query request parameter identifier

      new-optional-request-parameter

    • ○

      the query request parameter session_ids became optional

      request-parameter-became-optional

    • ○

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

      request-parameter-list-of-types-widened

    • ○

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

      request-parameter-min-items-decreased

    • ○

      for the query request parameter session_ids, the type/format was generalized from array/ to /

      request-parameter-type-generalized

  • c81391216eb541See the full diff
    • ▲

      the query request parameter session_ids became required

      request-parameter-became-required

    • ▲

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

      request-parameter-list-of-types-narrowed

    • ▲

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

      request-parameter-min-items-increased

    • ▲

      for the query request parameter session_ids, the type/format was changed from / to array/

      request-parameter-type-changed

    • ●

      deleted the query request parameter identifier

      request-parameter-removed

    This revision also has 91 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog