Get screen annotation – ConversionLab Docs

GET /screen-annotations/{screen_annotation}

Get screen annotation. Requires the REST read token ability. The bearer token selects the Team; a supplied team_id cannot switch tenants. Additional role, entity-policy and plan requirements vary by operation.

Authentication

Use a team API key as Authorization: Bearer YOUR_API_KEY. The token ability and the user’s role must both allow this operation. See authentication.

{
  "ability": "read",
  "team": "Token-bound Team",
  "authorization": "Additional role, entity-policy and plan requirements vary by operation."
}

Parameters

Name	Location	Required	Description
`screen_annotation`	path	Yes	The screen annotation ID

screen_annotation

{
  "type": "integer",
  "minimum": 1
}

Example request

curl --request GET 'https://api.example.test/api/screen-annotations/1' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

Examples use fictional data. Replace resource IDs and the API host with your environment’s values.

Responses

200

ScreenAnnotationResource

Content type: application/json.

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer"
        },
        "project_id": {
          "type": "integer"
        },
        "screen_id": {
          "type": "integer"
        },
        "insight_label_id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "note": {
          "type": [
            "string",
            "null"
          ]
        },
        "x": {
          "type": [
            "integer",
            "null"
          ]
        },
        "y": {
          "type": [
            "integer",
            "null"
          ]
        },
        "width": {
          "type": [
            "integer",
            "null"
          ]
        },
        "height": {
          "type": [
            "integer",
            "null"
          ]
        },
        "shape": {
          "type": "string"
        },
        "metadata": {
          "description": "JSON object or array. Object keys depend on the provider, form question, or configuration being stored.",
          "anyOf": [
            {
              "type": "object",
              "additionalProperties": {
                "description": "An arbitrary JSON value retained by a metadata/settings field.",
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "boolean"
                  },
                  {
                    "type": "number"
                  },
                  {
                    "type": "string"
                  },
                  {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/JsonValue"
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": {
                      "$ref": "#/components/schemas/JsonValue"
                    }
                  }
                ]
              }
            },
            {
              "type": "array",
              "items": {
                "description": "An arbitrary JSON value retained by a metadata/settings field.",
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "boolean"
                  },
                  {
                    "type": "number"
                  },
                  {
                    "type": "string"
                  },
                  {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/JsonValue"
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": {
                      "$ref": "#/components/schemas/JsonValue"
                    }
                  }
                ]
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "user_id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "created_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updated_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "deleted_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "required": [
        "id",
        "project_id",
        "screen_id",
        "insight_label_id",
        "note",
        "x",
        "y",
        "width",
        "height",
        "shape",
        "metadata",
        "user_id",
        "created_at",
        "updated_at",
        "deleted_at"
      ],
      "title": "ScreenAnnotationResource"
    }
  },
  "required": [
    "data"
  ]
}

{
  "data": {
    "id": 101,
    "project_id": 101,
    "screen_id": 101,
    "insight_label_id": null,
    "note": null,
    "x": null,
    "y": null,
    "width": null,
    "height": null,
    "shape": "example",
    "metadata": null,
    "user_id": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null
  }
}

401

Unauthenticated

Content type: application/json.

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Error overview."
    }
  },
  "required": [
    "message"
  ]
}

{
  "message": "The request could not be completed."
}

403

Authorization error

Content type: application/json.

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Error overview."
    }
  },
  "required": [
    "message"
  ]
}

{
  "message": "The request could not be completed."
}

404

Not found

Content type: application/json.

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Error overview."
    }
  },
  "required": [
    "message"
  ]
}

{
  "message": "The request could not be completed."
}

422

Validation error

Content type: application/json.

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Errors overview."
    },
    "errors": {
      "type": "object",
      "description": "A detailed description of each field that failed validation.",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "message",
    "errors"
  ]
}

{
  "message": "The request could not be completed.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}

429

Rate limit exceeded. Honor Retry-After before retrying.

Response headers:

{
  "Retry-After": {
    "description": "Seconds before retrying.",
    "schema": {
      "type": "integer"
    }
  }
}

Content type: application/json.

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "example": "Too Many Attempts."
    }
  },
  "required": [
    "message"
  ]
}

{
  "message": "Too Many Attempts."
}

See API conventions for error handling, rate limits, pagination, and uploads.

On this page