Historical Sync

9 endpoints

Historical email backfill operations

POST /historical-sync/cancel/{accountId}

Cancel historical sync for an account

Cancel active historical sync for a specific account

Parameters

accountId string

In path • Required

Returns

Default Response

Content type: application/json

Status: 200

Example request Copy Copied! Copy failed

cURL

                
                    1
                    curl -X POST "http://localhost:8080/historical-sync/cancel/{accountId}"
                  
              

Example response 200

No example response available.

---

GET /historical-sync/config

Get historical sync configuration

Get the current historical sync configuration settings

Parameters

This endpoint does not accept parameters.

Returns

Default Response

Content type: application/json

Status: 200

Example request Copy Copied! Copy failed

cURL

                
                    1
                    curl -X GET "http://localhost:8080/historical-sync/config"
                  
              

Example response 200

No example response available.

---

PUT /historical-sync/config

Update historical sync configuration

Update the historical sync configuration settings

Parameters

This endpoint does not accept parameters.

Request body

Optional • application/json

Request body (application/json)

put-/historical-sync/config-request-body-application/json

object<{ enabled, timeRangeDays, batchSize, … }>

Field	Type	Description	Values
batchSize Optional	number	≥ 1 • ≤ 1000	—
delayBetweenBatches Optional	number	≥ 0 • ≤ 60000	—
enabled Optional	boolean	—	—
maxConcurrentAccounts Optional	number	≥ 1 • ≤ 10	—
timeRangeDays Optional	number	≥ 1 • ≤ 365	—

Returns

Default Response

Content type: application/json

Status: 200

Example request Copy Copied! Copy failed

cURL

                
                    1
                    curl -X PUT "http://localhost:8080/historical-sync/config" \
                  
                    2
                      -H "Content-Type: application/json"
                  
              

Example response 200

No example response available.

---

GET /historical-sync/past

Get past historical syncs

Get all completed and failed historical sync operations from the database

Parameters

limit string

In query • Optional

status string

In query • Optional

Returns

Default Response

Content type: application/json

Status: 200

Example request Copy Copied! Copy failed

cURL

                
                    1
                    curl -X GET "http://localhost:8080/historical-sync/past"
                  
              

Example response 200

No example response available.

---

POST /historical-sync/pause/{accountId}

Pause historical sync for an account

Pause historical sync for a specific account

Parameters

accountId string

In path • Required

Returns

Default Response

Content type: application/json

Status: 200

Example request Copy Copied! Copy failed

cURL

                
                    1
                    curl -X POST "http://localhost:8080/historical-sync/pause/{accountId}"
                  
              

Example response 200

No example response available.

---

GET /historical-sync/progress

Get all active historical syncs

Get all currently active historical sync operations

Parameters

This endpoint does not accept parameters.

Returns

Default Response

Content type: application/json

Status: 200

Example request Copy Copied! Copy failed

cURL

                
                    1
                    curl -X GET "http://localhost:8080/historical-sync/progress"
                  
              

Example response 200

No example response available.

---

GET /historical-sync/progress/{accountId}

Get historical sync progress for an account

Get the current progress of historical sync for a specific account

Parameters

accountId string

In path • Required

Returns

Default Response

Content type: application/json

Status: 200

Example request Copy Copied! Copy failed

cURL

                
                    1
                    curl -X GET "http://localhost:8080/historical-sync/progress/{accountId}"
                  
              

Example response 200

No example response available.

---

POST /historical-sync/resume/{accountId}

Resume historical sync for an account

Resume paused historical sync for a specific account

Parameters

accountId string

In path • Required

Returns

Default Response

Content type: application/json

Status: 200

Example request Copy Copied! Copy failed

cURL

                
                    1
                    curl -X POST "http://localhost:8080/historical-sync/resume/{accountId}"
                  
              

Example response 200

No example response available.

---

POST /historical-sync/start/{accountId}

Start historical sync for an account

Start historical email sync for a specific account

Parameters

accountId string

In path • Required

Request body

Optional • application/json

Request body (application/json)

post-/historical-sync/start/{accountId}-request-body-application/json

object<{ configOverrides, query }>

Field	Type	Description	Values
configOverrides Optional	object<{ enabled, timeRangeDays, batchSize, … }>	—	—
query Optional	object<{ dateFrom, dateTo, searchQuery, … }>	—	—

Returns

Default Response

Content type: application/json

Status: 200

Example request Copy Copied! Copy failed

cURL

                
                    1
                    curl -X POST "http://localhost:8080/historical-sync/start/{accountId}" \
                  
                    2
                      -H "Content-Type: application/json"
                  
              

Example response 200

No example response available.