List screen annotations – ConversionLab Docs

GET /screen-annotations

List screen annotations. 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
`page[number]`	query	No	Page number, starting at 1.
`page[size]`	query	No	Results per page. Values above the configured maximum are capped.
`sort`	query	No	Comma-separated sort fields; prefix a field with - for descending order. Allowed: id, project_id, screen_id, note, x, y, width, height, shape, user_id.
`filter[id]`	query	No	Filter by id. Values use the endpoint’s configured matching; comma-separated values are supported by standard exact filters.
`filter[project_id]`	query	No	Filter by project_id. Values use the endpoint’s configured matching; comma-separated values are supported by standard exact filters.
`filter[screen_id]`	query	No	Filter by screen_id. Values use the endpoint’s configured matching; comma-separated values are supported by standard exact filters.
`filter[note]`	query	No	Filter by note. Values use the endpoint’s configured matching; comma-separated values are supported by standard exact filters.
`filter[x]`	query	No	Filter by x. Values use the endpoint’s configured matching; comma-separated values are supported by standard exact filters.
`filter[y]`	query	No	Filter by y. Values use the endpoint’s configured matching; comma-separated values are supported by standard exact filters.
`filter[shape]`	query	No	Filter by shape. Values use the endpoint’s configured matching; comma-separated values are supported by standard exact filters.
`filter[user_id]`	query	No	Filter by user_id. Values use the endpoint’s configured matching; comma-separated values are supported by standard exact filters.

page[number]

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

page[size]

{
  "type": "integer",
  "minimum": 1,
  "maximum": 30,
  "default": 30
}

sort

{
  "type": "string"
}

filter[id]

{
  "type": "string"
}

filter[project_id]

{
  "type": "string"
}

filter[screen_id]

{
  "type": "string"
}

filter[note]

{
  "type": "string"
}

filter[x]

{
  "type": "string"
}

filter[y]

{
  "type": "string"
}

filter[shape]

{
  "type": "string"
}

filter[user_id]

{
  "type": "string"
}

Example request

curl --request GET 'https://api.example.test/api/screen-annotations' \
  --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

Array of ScreenAnnotationResource

Content type: application/json.

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "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"
      }
    },
    "links": {
      "type": "object",
      "properties": {
        "first": {
          "type": [
            "string",
            "null"
          ]
        },
        "last": {
          "type": [
            "string",
            "null"
          ]
        },
        "prev": {
          "type": [
            "string",
            "null"
          ]
        },
        "next": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "first",
        "last",
        "prev",
        "next"
      ]
    },
    "meta": {
      "type": "object",
      "properties": {
        "current_page": {
          "type": "integer",
          "minimum": 1
        },
        "from": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 1
        },
        "last_page": {
          "type": "integer",
          "minimum": 1
        },
        "links": {
          "type": "array",
          "description": "Generated paginator links.",
          "items": {
            "type": "object",
            "properties": {
              "url": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "label": {
                "type": "string"
              },
              "active": {
                "type": "boolean"
              }
            },
            "required": [
              "url",
              "label",
              "active"
            ]
          }
        },
        "path": {
          "type": [
            "string",
            "null"
          ],
          "description": "Base path for paginator generated URLs."
        },
        "per_page": {
          "type": "integer",
          "description": "Number of items shown per page.",
          "minimum": 0
        },
        "to": {
          "type": [
            "integer",
            "null"
          ],
          "description": "Number of the last item in the slice.",
          "minimum": 1
        },
        "total": {
          "type": "integer",
          "description": "Total number of items being paginated.",
          "minimum": 0
        }
      },
      "required": [
        "current_page",
        "from",
        "last_page",
        "links",
        "path",
        "per_page",
        "to",
        "total"
      ]
    }
  },
  "required": [
    "data",
    "links",
    "meta"
  ]
}

{
  "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
    }
  ],
  "links": {
    "first": null,
    "last": null,
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": null,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "example",
        "active": true
      }
    ],
    "path": null,
    "per_page": 1,
    "to": null,
    "total": 1
  }
}

400

Unsupported filter, sort, or include.

Content type: application/json.

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "example": "Requested query option is not allowed."
    }
  },
  "required": [
    "message"
  ]
}

{
  "message": "Requested query option is not allowed."
}

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."
}

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