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

Get all syncs for a given collection

Beta
GET
https://api.scoutos.com/v2/collections/:collection_id/tables/:table_id/syncs
GET
/v2/collections/:collection_id/tables/:table_id/syncs
$curl https://api.scoutos.com/v2/collections/collection_id/tables/table_id/syncs \
>     -H "Authorization: Bearer <token>"
1{
2  "syncs": [
3    {
4      "sync_config": {
5        "source_settings": {
6          "source_archetype_id": "web_crawler_v1",
7          "sitemap_url": "https://example.com/sitemap.xml",
8          "crawler_settings": {
9            "scraper": {
10              "scraper_type": "http"
11            },
12            "text_extractor": {
13              "text_extractor_type": "readability"
14            },
15            "allow": "/products/,/blog/",
16            "deny": "/admin/,/login/",
17            "strip": "utm_source,utm_medium",
18            "strip_urls": true,
19            "allowed_domains": "example.com,cdn.example.com",
20            "user_agent_header": "Mozilla/5.0 (compatible; ExampleBot/1.0; +http://example.com/bot)",
21            "max_depth": 10,
22            "max_page_count": 5000,
23            "exclude_before_lastmod_date": "2023-01-01T00:00:00Z"
24          },
25          "mode": "merge"
26        },
27        "destination": {
28          "destination_type": "collections.v2",
29          "collection_id": "col_987654321",
30          "table_id": "tbl_123456789"
31        },
32        "mapping": {
33          "fields": [
34            {
35              "source_field": "title",
36              "destination_field": "product_name"
37            },
38            {
39              "source_field": "price",
40              "destination_field": "product_price"
41            }
42          ]
43        },
44        "schedule": {
45          "frequency": "daily",
46          "enabled": true
47        }
48      },
49      "sync_id": "sync_abc123def456",
50      "last_updated_at": "2024-01-15T09:30:00Z",
51      "created_at": "2024-01-10T08:00:00Z",
52      "created_by": {
53        "type": "user",
54        "details": {
55          "api_key": {
56            "key_id": "key_0011223344",
57            "created_at": "2023-12-01T12:00:00Z"
58          }
59        }
60      },
61      "last_updated_by": {
62        "type": "user",
63        "details": {
64          "api_key": {
65            "key_id": "key_0011223344",
66            "created_at": "2023-12-01T12:00:00Z"
67          }
68        }
69      },
70      "trigger_id": "trigger_xyz789ghi012"
71    }
72  ]
73}
List Sources by Destination, specifically given a collection and table
Was this page helpful?
Previous

Get view state for a collection.

Next
Built with

Authentication

AuthorizationBearer

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

Path parameters

collection_idstringRequired
table_idstringRequired

Response

Successful Response
syncslist of objects

Errors

422
Unprocessable Entity Error