Experiment Annotations LIST

GET 
/experiment_annotations

Required Permissions: Annotation List or Annotation Admin

Request

Query Parameters

sort string

The object key to sort the results by.

sort_asc boolean
page integer
items integer
experiment_id integer

Filter experiment annotations by experiment_id

Responses

200

A JSON Object containing an array of all experiment annotations.

application/json

Schema

Schema

items integer
page integer

Possible values: >= 1

total integer
experiment_annotations object[]
Array [
id integer
timestamp date-time
description string
color string
Possible values: Value must match regular expression ^#[A-Fa-f0-9]{6}
type
Possible values: [local, global]
experiment_id integer
created_at date-time
created_by_user_id integer
updated_at date-timenullable
updated_by_user_id integernullable
created_by object
archived boolean
avatar objectnullable
avatar_file_upload_url string
created_at date-time
created_by_user_id integer
Possible values: >= 1
department string
email email
updated_by objectnullable
archived boolean
avatar objectnullable
avatar_file_upload_url string
created_at date-time
created_by_user_id integer
Possible values: >= 1
department string
email email
]

Example (from schema)

{
  "items": 0,
  "page": 0,
  "total": 0,
  "experiment_annotations": [
    {
      "id": 0,
      "timestamp": "2024-12-02T14:38:57.788Z",
      "description": "This was just after a successful marketing campaign",
      "color": "#CFC8FF",
      "experiment_id": 0,
      "created_at": "2024-12-02T14:38:57.788Z",
      "created_by_user_id": 0,
      "updated_at": "2024-12-02T14:38:57.788Z",
      "updated_by_user_id": 0,
      "created_by": {
        "archived": false,
        "avatar": {},
        "avatar_file_upload_url": "/cropUrl/100x100/1.png",
        "created_at": "2024-12-02T14:38:57.788Z",
        "created_by_user_id": 0,
        "department": "Marketing",
        "email": "user@example.com"
      },
      "updated_by": {
        "archived": false,
        "avatar": {},
        "avatar_file_upload_url": "/cropUrl/100x100/1.png",
        "created_at": "2024-12-02T14:38:57.788Z",
        "created_by_user_id": 0,
        "department": "Marketing",
        "email": "user@example.com"
      }
    }
  ]
}

Loading...