Bookmark - Fetch details of any requested bookmark

Retrieves details of a specific bookmark associated with a report.

get

Authorizations

Bearer

HTTPRequired

Please enter a valid token

Path parameters

reportIdstring · uuidRequired

Enter ID of an existing report

bookmarkIdstring · uuidRequired

Enter ID of an existing bookmark

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Header parameters

embedfast-user-idstringOptional

Optional User Id

Responses

200

Success: Successfully retrieved the requested bookmark details.

text/plainapplication/jsontext/json

Class for storing information about bookmark.

reportIdstring · uuidOptional

A public property of type Guid (a unique identifier) that has both a getter and a setter method, which allows for getting and setting the value of the ReportId property.

modifiedByUserIdstring · nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the ModifiedByUserId property.

bookmarkStatestring · nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the BookmarkState property.

displayNamestring · nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the DisplayName property.

reportBookmarkIdstring · uuidOptional

A public property of type Guid (a unique identifier) that has both a getter and a setter method, which allows for getting and setting the value of the ReportBookmarkId property.

typestring · enumOptional

Enum for bookmark type.

Possible values:

401

Unauthorized: Invalid credentials or missing/invalid authentication token.

text/plainapplication/jsontext/json

403

Forbidden: Access denied to view this bookmark due to insufficient permissions or account restrictions.

text/plainapplication/jsontext/json

404

Not Found: The specified bookmark or report does not exist, the URL is invalid, or the resource has been deleted.

text/plainapplication/jsontext/json

500

Internal Server Error: An unexpected issue occurred or the server timed out while trying to view the bookmark.

text/plainapplication/jsontext/json

get

/reports/{reportId}/bookmarks/{bookmarkId}

HTTPcURLJavaScriptPython

GET /reports/{reportId}/bookmarks/{bookmarkId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "reportId": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedByUserId": "text",
  "bookmarkState": "text",
  "displayName": "text",
  "reportBookmarkId": "123e4567-e89b-12d3-a456-426614174000",
  "type": "personal"
}