curl --request POST \
--url https://api.bigdata.com/contents/v1/connectors/{connector_id}/sync \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"date_limit": "2026-01-01"
}
'{
"connector_id": "019a9612-bfad-758c-884e-37dd8c6ad2cb",
"user_id": "user_id_001",
"org_id": "org_id_001",
"share_with_org": false,
"label": "Broker Research - Last Year",
"type": "investment_research",
"description": "Keeps only the last 365 days of broker research",
"enrichments": [
"translation"
],
"files_count": 110,
"config": {
"user_id": "user@email.com",
"rolling_history_days": 365
},
"created_at": "2026-10-09T10:09:20.204059Z",
"updated_at": "2026-10-09T10:09:20.204063Z",
"archived": false,
"last_sync_at": "2026-10-09T10:13:13.265776Z",
"last_sync_status": "PENDING",
"last_sync_error_msg": null,
"last_sync_count": null
}Trigger connector sync
Queues a new synchronization run for an investment_research or sharepoint connector. Only content that is not already ingested is synced.
SharePoint. Send an empty JSON body ({}).
Investment research. Both body fields are optional. Send date_limit (YYYY-MM-DD) to resync broker research from that date onward and replace the stored date limit. Send rolling_history_days (30–3650) to set or change the rolling history window, or null to turn it off. Omit a field to leave it unchanged.
When a rolling history window is set, the connector keeps only research published within that many days. A scheduled job deletes documents published on or before today (UTC) minus rolling_history_days, and later syncs do not ingest them again. Deletion is not reversible. Shortening the window deletes documents that now fall outside it. Lengthening the window, or turning it off, does not restore documents already removed.
If this request sets date_limit or rolling_history_days, the date limit that applies — the value you send, or the stored one (default: three months back) — cannot be older than the start of the rolling window. Otherwise the API returns 400 with ROLLING_HISTORY_CONFLICT and changes nothing. To set a short window on a connector with an older stored date limit, send a more recent date_limit in the same request. Requests that set neither field skip this check.
curl --request POST \
--url https://api.bigdata.com/contents/v1/connectors/{connector_id}/sync \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"date_limit": "2026-01-01"
}
'{
"connector_id": "019a9612-bfad-758c-884e-37dd8c6ad2cb",
"user_id": "user_id_001",
"org_id": "org_id_001",
"share_with_org": false,
"label": "Broker Research - Last Year",
"type": "investment_research",
"description": "Keeps only the last 365 days of broker research",
"enrichments": [
"translation"
],
"files_count": 110,
"config": {
"user_id": "user@email.com",
"rolling_history_days": 365
},
"created_at": "2026-10-09T10:09:20.204059Z",
"updated_at": "2026-10-09T10:09:20.204063Z",
"archived": false,
"last_sync_at": "2026-10-09T10:13:13.265776Z",
"last_sync_status": "PENDING",
"last_sync_error_msg": null,
"last_sync_count": null
}Authorizations
Your API key. Include it in every request as the X-API-KEY header. Create and manage keys in the Developer Platform.
Path Parameters
UUID of the investment_research or sharepoint connector to resync.
"019a9612-bfad-758c-884e-37dd8c6ad2cb"
Body
Body for POST /contents/v1/connectors/{connector_id}/sync. For investment_research connectors, all fields are optional: send date_limit to resync from a date and rolling_history_days to set or clear the rolling history window. For sharepoint connectors, send an empty object ({}).
Calendar date (YYYY-MM-DD). Optional for investment_research connectors; retriggers broker synchronization including research from this date forward per platform rules, and replaces the stored date limit. It cannot be in the future, and when a rolling history window is set it cannot be older than the start of that window (ROLLING_HISTORY_CONFLICT). Must be omitted for sharepoint connectors.
"2026-01-01"
Only for investment_research connectors. Sets or updates the rolling history window, in days: documents published on or before today (UTC) minus this many days are deleted by a scheduled job. Send null to turn the window off; omit the field to leave it unchanged. Shortening the window deletes the documents that now fall outside it; lengthening or turning it off does not restore documents already removed. Must be omitted for sharepoint connectors.
30 <= x <= 3650365
Response
Sync request was accepted and queued for the connector. Returns the connector, including its current config.rolling_history_days for investment_research connectors.
An ingestion source (e.g. email inbox, investment research / broker feed, or Microsoft SharePoint). Returned by Create/Get/Update connector and List connectors.
Unique identifier for the connector. Use when updating, deleting, or filtering documents by connector.
"019a9612-bfad-758c-884e-37dd8c6ad2cb"
ID of the user who owns the connector.
"user_id_001"
ID of the organization the connector belongs to.
"org_id_001"
If true, all members of your organization can access the processed content. If false, only you can access the processed content.
true
Display name for the connector (e.g. for UI or admin lists).
"Broker Research - Daily Reports"
Connector type. Determines the configuration and how content is ingested.
email, investment_research, sharepoint Timestamp when the connector was created.
"2026-02-11T11:01:09.574095Z"
Timestamp when the connector was last updated.
"2026-02-11T11:01:09.574102Z"
Whether the connector is archived.
false
Optional human-readable description of what the connector is used for.
"Collects daily reports from the broker's research team"
Enrichments applied to content ingested through this connector. Each value adds a step to the processing pipeline.
Supported enrichments:
reporting_entities: Identifies the document's reporting company, using the same concept as theReportingEntityreporting detail in Search. This keeps the reporting entity consistent with the rest of the Bigdata corpus, so you can reliably filter private content, transcripts and filings together.translation: Translates the document content so non-English material can be searched and analyzed alongside the rest of your corpus. Supports more than 70 languages.
reporting_entities, translation ["translation"]
Type-specific settings. Email connectors return inbox and allowed senders; investment research connectors return user_id and rolling_history_days (null when not set), never user_password; SharePoint connectors return config as {}.
- Email
- Investment research
- SharePoint
Show child attributes
Show child attributes
Number of files ingested through this connector, when tracked (e.g. investment research sync).
10
Timestamp of the last sync from the external source, when applicable.
"2026-04-07T09:36:34.195040Z"
Outcome of the last sync (e.g. SUCCESS), when applicable.
"SUCCESS"
Error message from the last sync when it failed; null on success.
null
Number of items processed in the last sync, when applicable.
3200
Was this page helpful?