Skip to main content

Experiment Annotation GET

GET 

https://sandbox.absmartly.com/v1/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

A JSON Object containing an experiment annotation's data.

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

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: A User API Key for API authorization. **Must be in the format "Api-Key your_user_api_key"**scheme: ^Api-Key\s\S+
curl -L -X GET 'https://sandbox.absmartly.com/v1/experiment_annotations/:experimentAnnotationId' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
Request Collapse all
Base URL
https://sandbox.absmartly.com/v1
Auth
Parameters
— pathrequired
ResponseClear

Click the Send API Request button above and see the response here!