ListFlagReviews

ListFlagReviews lists reviews in an organization.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

ListFlagReviewsRequest is a request for listing reviews on a transcript.

page_size

integer

page_size

optional

Optional. The number of reviews to include in a single response. When not
provided this defaults to 100.

order_by

string

order_by

optional

Optional. The order by which reviews will be listed. Follows sql order by
syntax. When not provided the order defaults to "flag_review_sid desc".
Supported order by includes:

(flag_review_sid desc)

(flag_review_sid)

page_token

string

page_token

optional

Optional. The next_page_token returned from a previous List request, if any.
When provided all other request fields are ignored.

transcript_sid

integer <int64> | string

transcript_sid

optional

Optional. The transcript sid to look for reviews on.

Example

{
    "page_size": 0,
    "order_by": "string",
    "page_token": "string",
    "transcript_sid": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

ListFlagReviewsResponse is a response for listing reviews on a transcript.

next_page_token

string

next_page_token

optional

Token to retrieve the next page of reviews, or empty if there are no
more reviews in the list.

flag_reviews

array[object (FlagReview) {6}]

flag_reviews

optional

List of flag reviews.

create_time

string <date-time>

create_time

optional

Output only. The timestamp when this flag review was created. Assigned by the
server.

Examples:

1s1.000340012s

notes

string

notes

optional

Optional. Any notes written for the flag review.

flag_review_sid

integer <int64> | string

flag_review_sid

optional

Output only. The unique id of this flag review.

transcript_sid

integer <int64> | string

transcript_sid

optional

Required. The transcript_sid of the reviewed transcript.

flag_sid

integer <int64> | string

flag_sid

deprecated

DEPRECATED. Use flag_snapshot_sid instead.

flag_snapshot_sid

integer <int64> | string

flag_snapshot_sid

optional

The ID of the flag snapshot for this flag review.

Example

{
    "next_page_token": "string",
    "flag_reviews": [
        {
            "create_time": "1s",
            "notes": "string",
            "flag_review_sid": 0,
            "transcript_sid": 0,
            "flag_sid": 0,
            "flag_snapshot_sid": 0
        }
    ]
}

🔴500Server Error