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
      • GETGet all syncs
      • POSTCreate a source sync to execute
      • GETGet a sync by ID.
      • PUTUpdate a source sync
      • DELDelete a sync
      • POSTSync a source.
LogoLogo
Scout DocsAccess Scout
EndpointsSyncs

Get a sync by ID.

Beta
GET
https://api.scoutos.com/v2/syncs/:sync_id
GET
/v2/syncs/:sync_id
$curl https://api.scoutos.com/v2/syncs/sync_id \
>     -H "Authorization: Bearer <token>"
1{
2  "data": {
3    "sync_config": {
4      "source_settings": {
5        "source_archetype_id": "web_crawler_v1",
6        "sitemap_url": "https://example.com/sitemap.xml",
7        "crawler_settings": {
8          "scraper": {
9            "scraper_type": "http"
10          },
11          "text_extractor": {
12            "text_extractor_type": "readability"
13          },
14          "allow": "/products/,/blog/",
15          "deny": "/admin/,/login/",
16          "strip": "script,style",
17          "strip_urls": true,
18          "allowed_domains": "example.com,cdn.example.com",
19          "user_agent_header": "Mozilla/5.0 (compatible; SyncBot/1.0; +https://example.com/bot)",
20          "max_depth": 10,
21          "max_page_count": 5000,
22          "exclude_before_lastmod_date": "2023-12-01T00:00:00Z"
23        },
24        "mode": "merge"
25      },
26      "destination": {
27        "destination_type": "collections.v2",
28        "collection_id": "col_987654321",
29        "table_id": "tbl_123456789"
30      },
31      "mapping": {
32        "fields": [
33          {}
34        ]
35      },
36      "schedule": {
37        "frequency": "daily",
38        "enabled": true
39      }
40    },
41    "sync_id": "sync_123e4567-e89b-12d3-a456-426614174000",
42    "last_updated_at": "2024-01-15T09:30:00Z",
43    "created_at": "2024-01-15T09:30:00Z",
44    "created_by": {
45      "type": "user",
46      "details": {
47        "api_key": {
48          "key_id": "api_001122334455",
49          "created_at": "2023-11-01T08:00:00Z"
50        }
51      }
52    },
53    "last_updated_by": {
54      "type": "user",
55      "details": {
56        "api_key": {
57          "key_id": "api_001122334455",
58          "created_at": "2023-11-01T08:00:00Z"
59        }
60      }
61    },
62    "trigger_id": "trigger_987f6543-e21b-45d3-b789-123456789abc"
63  }
64}
Was this page helpful?
Previous

Update a source sync

Next
Built with

Authentication

AuthorizationBearer

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

Path parameters

sync_idstringRequired

Response

Successful Response
dataobject

Errors

422
Unprocessable Entity Error