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 } ] }
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bearer <token>
<token>
Define the data labels you want to search for, along with the number and quality of results to return.
Maximum number of workbooks to return results for
10
Maximum number of labels to return per workbook
20
Successful Response
The results of a spreadsheet data label search.
Show child attributes
UUID for the workbook
UUID for the user that uploaded the workbook. This will always be the UUID of the account linked to the API key used in the request.
Original filename of the workbook
Generated description summarising the contents of the workbook
Most recent version number of the workbook
Absolute URL for a thumbnail of the workbook's first sheet
Array of labels within the workbook that match the search query
Cell reference or range that contains the labelled data
Text content of the label
The labelled data value(s). If a range of data is labelled, this will be a stringified JSON array
Relevance ranking of the workbook in relation to the search results (higher is better)