Create Annotation
Creates an annotation with the specified details.
Request Body required
Possible values: <= 200 characters
The annotation's text.
Optional. The annotation's start time represented in ISO 8601 format. If not provided, the current Fullstory server time will be used.
Optional. The annotation's end time represented in ISO 8601 format. If not provided, it will be set to the annotation's start_time. If provided, must be after start_time.
Possible values: <= 40 characters
Optional. A string representing the source or creator of this annotation, which will be displayed on the annotation's visualization.
A successful response.
Schema
The annotation's text.
The annotation's start time represented in ISO 8601 format. If this was not set in the request, it will be set to Fullstory's server time.
The annotation's end time represented in ISO 8601 format. If this was not set in the request, it will be set the start_time field.
The annotation's provided 'source' field.
{
"text": "Code Release",
"start_time": "2024-06-29T14:23:23Z",
"end_time": "2024-06-29T14:23:23Z",
"source": "Deploy Pipeline"
}
Returned when invalid input has been provided. Fix the issue and retry.
Schema
Long form description of what went wrong
A short snake-cased value that is safe to handle programmatically
{
"message": "text is required",
"code": "invalid_argument"
}
Returned when the client has exceeded the rate limit for this endpoint. A Retry-After header will be included with the response. This header will contain the number of seconds that you should wait before attempting to send another request.
Schema
Long form description of what went wrong
A short snake-cased value that is safe to handle programmatically
{
"message": "Too many requests. Client has exceeded the rate limit for this endpoint.",
"code": "too_many_requests"
}
Returned when a server error is encountered
Schema
Long form description of what went wrong
A short snake-cased value that is safe to handle programmatically
{
"message": "Server error was encountered",
"code": "server_error"
}