POST
/
v1
/
workbooks
/
search
/
labels
import Grid from '@grid-is/api';

const client = new Grid({
  apiKey: process.env['GRID_API_TOKEN'], // This is the default and can be omitted
});

async function main() {
  const response = await client.beta.searchLabels({ query: 'profit' });

  console.log(response.results);
}

main();
{
  "results": [
    {
      "workbook_id": "<string>",
      "creator_id": "<string>",
      "filename": "<string>",
      "description": "<string>",
      "latest_version": 123,
      "thumbnail_url": "<string>",
      "labels": [
        {
          "for": "<string>",
          "text": "<string>",
          "value": "<string>",
          "score": 123
        }
      ],
      "score": 123
    }
  ]
}
This endpoint is in beta and is subject to change.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Define the data labels you want to search for, along with the number and quality of results to return.

Response

200
application/json

Successful Response

The results of a spreadsheet data label search.