Skip to main content
POST
/
v1
/
workbooks
/
search
/
labels
JavaScript
import Grid from '@grid-is/api';

const client = new Grid({
  apiKey: 'My API Key',
});

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

console.log(response.results);
{
  "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
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://sdk.grid.is/llms.txt

Use this file to discover all available pages before exploring further.

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.

query
string
required
Examples:

"profit"

"annual revenue"

"subscription rate"

max_results
integer | null

Maximum number of workbooks to return results for

Example:

10

max_labels
integer | null

Maximum number of labels to return per workbook

Example:

20

Response

Successful Response

The results of a spreadsheet data label search.

results
WorkbookResult · object[]
required