For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Scout DocsAccess Scout
API & SDK
API & SDK
  • Endpoints
      • GETList all collections.
      • POSTCreate a collection.
      • GETGet a collection by ID.
      • PUTUpdate a collection by ID.
      • DELDelete a collection by ID.
      • GETGet all syncs for a given collection
      • GETGet view state for a collection.
      • PUTUpdate view state for a collection.
      • DELDelete view state for a collection.
      • GETList individual views for a collection.
      • POSTCreate an individual view.
      • PUTUpdate an individual view.
      • DELDelete an individual view.
LogoLogo
Scout DocsAccess Scout
EndpointsCollections

Create an individual view.

Beta
POST
https://api.scoutos.com/v2/collections/:collection_id/views/create
POST
/v2/collections/:collection_id/views/create
$curl -X POST https://api.scoutos.com/v2/collections/collection_id/views/create \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json" \
> -d '{
> "name": "Monthly Sales Overview"
>}'
1{
2 "success": true,
3 "data": {
4 "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
5 "name": "Monthly Sales Overview",
6 "emoji": "📊",
7 "table_id": "tbl_9876543210abcdef",
8 "collection_id": "col_1234567890abcdef",
9 "created_at": "2024-01-15T09:30:00Z",
10 "updated_at": "2024-01-15T09:30:00Z",
11 "created_by": "user_00123",
12 "last_updated_by": "user_00456",
13 "visibility": "personal",
14 "shared_with": [
15 "user_00789"
16 ],
17 "filters": [
18 {
19 "id": "flt_abc123def456",
20 "column_id": "col_sales_region",
21 "operator": "equals",
22 "value": null,
23 "enabled": true,
24 "created_at": "2024-01-15T09:30:00Z"
25 }
26 ],
27 "query": {
28 "global_search": "Q1 revenue",
29 "sort_by": [
30 {
31 "column_id": "col_revenue",
32 "direction": "asc"
33 }
34 ],
35 "limit": 50,
36 "offset": 0
37 },
38 "type": "table",
39 "settings": {
40 "column_visibility": {},
41 "column_order": [
42 "col_date",
43 "col_sales_region",
44 "col_revenue"
45 ],
46 "column_widths": {},
47 "type": "table",
48 "row_height": "medium",
49 "show_row_numbers": true,
50 "wrap_text": true,
51 "filters": [
52 {
53 "id": "flt_abc123def456",
54 "column_id": "col_sales_region",
55 "operator": "equals",
56 "value": null,
57 "enabled": true,
58 "created_at": "2024-01-15T09:30:00Z"
59 }
60 ]
61 }
62 },
63 "error": ""
64}
Was this page helpful?
Previous

Update an individual view.

Next
Built with

Authentication

AuthorizationBearer

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

Path parameters

collection_idstringRequired

Request

This endpoint expects an object.
namestringRequired
typeenumOptionalDefaults to table
Allowed values:
emojistring or nullOptional
table_idstring or nullOptional
settingsobject or nullOptional
visibilityenumOptional
Allowed values:
shared_withlist of stringsOptional

Response

Successful Response
successboolean
dataobject or null
errorstring or null

Errors

422
Unprocessable Entity Error