Skip to main content

GetDatasetViewRequest

Get a view of the data within a dataset.

    datasetId stringrequired

    The ID of the dataset from which to retrieve content. When specified, gets data from the current file in the dataset.

    datasetFileId stringrequired

    The ID of the (pinned) dataset file from which to retrieve content. Requests iterating over pages of results are recommended to use this pinned identifier after the first page in order to prevent any effects from a dataset changing between the queries.

    after integer

    Pagination: The index, by row-order, after which to query results.

    limit integer

    Pagination: The maximum number of results to return on this page.

    previousPageCursor string

    A cursor for the previous page in the pagination, if one exists.

    nextPageCursor string

    A cursor for the next page in the pagination, if one exists.

    getLastPage boolean
    useDatasetsService boolean

    filters

    object[]

    required

  • Array [

    • allOf

    object

    required

    predicates

    object[]

    required

  • Array [

    • columnName stringrequired

    stringCriteria

    object

    required

    operator Operator (string)required

    Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_NOT_EQUALS, OPERATOR_CONTAINS, OPERATOR_STARTS_WITH, OPERATOR_ENDS_WITH]

    value stringrequired

    numericCriteria

    object

    required

    operator Operator (string)required

    Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_NOT_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]

    int64Value integerrequired
    doubleValue numberrequired

    stringListCriteria

    object

    required

    operator Operator (string)required

    Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_HAS_ANY, OPERATOR_HAS_ALL, OPERATOR_HAS_NONE]

    values string[]required

  • ]

    • anyOf

    object

    required

    predicates

    object[]

    required

  • Array [

    • columnName stringrequired

    stringCriteria

    object

    required

    operator Operator (string)required

    Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_NOT_EQUALS, OPERATOR_CONTAINS, OPERATOR_STARTS_WITH, OPERATOR_ENDS_WITH]

    value stringrequired

    numericCriteria

    object

    required

    operator Operator (string)required

    Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_NOT_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]

    int64Value integerrequired
    doubleValue numberrequired

    stringListCriteria

    object

    required

    operator Operator (string)required

    Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_HAS_ANY, OPERATOR_HAS_ALL, OPERATOR_HAS_NONE]

    values string[]required

  • ]

  • ]

    • orderBy string

    Column to order results by

    orderDirection string

    Direction to order results ("asc" or "desc")