Get view data

Returns grouped rows for a view, with field names resolved for each cell. meta.record_count is the number of grouped rows in the view. It is not the project’s materialized row count. A project that has not been materialized returns an empty page with record_count of 0. The view must belong to the project. A chart grouping, or a view from another project, is not found.

Request

string

required

Bearer token for a workspace API key scoped to this workspace.

string

required

Workspace slug.

integer

required

Project ID.

integer

required

View ID from List views.

integer

default:"1"

Page number. Must be at least 1.

integer

default:"100"

Rows per page. Minimum 1, maximum 5000.

curl "https://app.askgrapple.com/api/v1/workspaces/acme-corp/projects/42/views/117/data?page=1&per_page=100" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

array

Paginated grouped rows. Each row is an array of cell objects.

Show cell object

string

View column key, in the form gf_{id}.

string

Human-readable column name.

mixed

Cell value.

object

Pagination metadata.

Show properties

integer

Total grouped rows in the view.

integer

Current page number.

integer

Rows returned per page.

boolean

Whether additional pages are available.

{
  "data": [
    [
      {
        "key": "gf_180",
        "name": "Last name",
        "value": "Nguyen"
      },
      {
        "key": "gf_181",
        "name": "count(Company)",
        "value": 10
      }
    ]
  ],
  "meta": {
    "record_count": 546,
    "page": 1,
    "per_page": 100,
    "has_more": true
  }
}

Paginate through all rows by incrementing page until meta.has_more is false.

Errors

Status	Reason
`401`	Missing or invalid API key
`403`	API key does not belong to this workspace
`404`	Project or view not found in this workspace
`422`	`page` or `per_page` is invalid

Getting Started

Data Library

Projects

API

Admin

Request

Response

Errors

​Request

​Response

​Errors

Request

Response

Errors