IMimprovado
Extracts

Edit extract settings in bulk

Change the settings of 1–1,000 accessible extractions of one data source and report type. Templates and data tables may differ. Only API extractions are supported: flat data, SQL, spreadsheet and file-import extractions are rejected. Requires extract UPDATE permission and an authenticated workspace user; service principals are not supported. Private connections must be owned by or shared with the caller. Each setting is changed with the operations listed in ExtractionBulkEditRequest. A setting that is left out keeps each extraction's own value. Unknown settings or operations, an empty patch and conflicting operations return 400. Schedules and the historical date are checked like in the single-extract update, including the hourly scheduling entitlement and the agency's historical depth limit. The request is accepted before the data source is consulted. The bulk edit then validates the settings each extraction ends up with in the data source and changes nothing if any of them is rejected, so it either changes every selected extraction or none. Poll the bulk status endpoint with the returned ID. Adding fields or changing additional_params, custom_filters or sync_historical_data re-downloads the history of active extractions; paused extractions stay paused. An identical retry with the same Idempotency-Key returns the existing bulk edit ID; reusing the key with a different body returns 409. One bulk edit runs per agency at a time: a new bulk edit while another one is running returns 400.

post/api/v3/extracts/bulk-edit/

Request

Headers

X-IM-WORKSPACE-IDinteger

Workspace ID headers is required when using cookie authentication

Idempotency-Keystring required

Client-generated key for one bulk operation; 1–128 printable ASCII characters. Use the same key for retries of the same operation and a new key for a new operation.

Request body

Example request

{
  "scheduling": {
    "replace": [
      {
        "scheduling": {
          "value": {
            "days": 1,
            "hours": 1,
            "minutes": 1,
            "interval": "day",
            "timezone": "UTC",
            "lookback_window": {
              "name": "default"
            }
          }
        }
      }
    ],
    "add": [
      {
        "scheduling": {
          "value": {
            "days": 1,
            "hours": 1,
            "minutes": 1,
            "interval": "day",
            "timezone": "UTC",
            "lookback_window": {
              "name": "default"
            }
          }
        }
      }
    ],
    "remove": [
      {
        "scheduling": {
          "value": {
            "days": 1,
            "hours": 1,
            "minutes": 1,
            "interval": "day",
            "timezone": "UTC",
            "lookback_window": {
              "name": "default"
            }
          }
        }
      }
    ]
  }
}

Response

Bulk edit submitted or an identical previous submission returned. Does not mean the settings are already changed.

idstring uuid required

Task ID to poll through GET /api/v3/bulk/stream/{task_info_id}/.

Changes

No recorded changes to this operation across all 1 revision of this API.