List analysis items

GET

/v1/convai/analysis-items

GET

/v1/convai/analysis-items

curl -G https://api.elevenlabs.io/v1/convai/analysis-items \
     -d analysis_item_ids=analysis_item_ids \
     -d created_by_user_id=created_by_user_id \
     -d cursor=cursor \
     -d kind=evaluation \
     -d page_size=1 \
     -d search=search \
     -d sort_direction=asc

{
  "analysis_items": [
    {
      "id": "id",
      "definition": {
        "kind": "data_collection",
        "name": "name",
        "value_schema": {
          "type": "string",
          "description": "A user-provided message"
        }
      },
      "access_info": {
        "is_creator": true,
        "creator_name": "John Doe",
        "creator_email": "john.doe@example.com",
        "role": "admin",
        "access_source": "creator"
      },
      "created_at_unix_secs": 1,
      "updated_at_unix_secs": 1,
      "current_version_id": "current_version_id",
      "legacy_source_id": "legacy_source_id"
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}

List analysis items available in the workspace.

Query parameters

searchstringOptional<=100 characters

If specified, only analysis items whose names start with this string are returned, ordered by relevance rather than sort_direction.

page_sizeintegerOptional1-100

How many documents to return at maximum. Can not exceed 100, defaults to 30.

kindenumOptional

If specified, only analysis items of this kind are returned.

Allowed values:

analysis_item_idsstringOptional

If specified, only analysis items with these IDs are returned.

created_by_user_idstringOptional

Filter by creator user ID. Use ‘@me’ to refer to the authenticated user.

sort_directionenumOptional

The direction to sort the results

Allowed values:

cursorstringOptional

Used for fetching next page. Cursor is returned in the response.

Response

Successful Response

analysis_itemslist of objects

has_moreboolean

next_cursorstringOptional

Errors

422

Analysis Items List Request Unprocessable Entity Error

Headers

Query parameters

Response

Errors