Experiment Annotation GET

GET 
/experiment_annotations/:experimentAnnotationId

Required Permissions: Annotation Get or Annotation Admin

Request

Path Parameters

experimentAnnotationId integerrequired

The id of the Experiment Annotation that you wish to get data from.

Responses

200

A JSON Object containing an experiment annotation's data.

application/json

Schema

Schema

experiment_annotation object
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)

{
  "experiment_annotation": {
    "id": 0,
    "timestamp": "2024-12-12T13:15:10.433Z",
    "description": "This was just after a successful marketing campaign",
    "color": "#CFC8FF",
    "experiment_id": 0,
    "created_at": "2024-12-12T13:15:10.433Z",
    "created_by_user_id": 0,
    "updated_at": "2024-12-12T13:15:10.433Z",
    "updated_by_user_id": 0,
    "created_by": {
      "archived": false,
      "avatar": {},
      "avatar_file_upload_url": "/cropUrl/100x100/1.png",
      "created_at": "2024-12-12T13:15:10.433Z",
      "created_by_user_id": 0,
      "department": "Marketing",
      "email": "[email protected]"
    },
    "updated_by": {
      "archived": false,
      "avatar": {},
      "avatar_file_upload_url": "/cropUrl/100x100/1.png",
      "created_at": "2024-12-12T13:15:10.433Z",
      "created_by_user_id": 0,
      "department": "Marketing",
      "email": "[email protected]"
    }
  }
}

Loading...