IMimprovado
Extracts

Update an extract partially

Partially update extraction configuration; omitted top-level fields retain their values. custom_fields and its dynamic_fields alias accept lists of dynamic-field names. Omitting both or supplying [] preserves the dynamic-field selection; [] does not deselect all fields. When both aliases are supplied, their sets of names must match or the request returns 400. Source discovery and compatibility validation apply; changing dynamic dimensions is rejected. Historical dates are validated against the agency's historical-depth limit before mutation. Responses retain the existing custom_fields object representation.

patch/api/v3/extracts/{id}

Request

Path parameters

idinteger required

Extract ID

Request body

fieldsstring[]
additional_paramsobject
custom_fieldsstring[]

Dynamic-field names to select. Optional; omission or [] keeps the existing selection. custom_fields and dynamic_fields are aliases; when both are supplied their sets must match.

dynamic_fieldsstring[]

Dynamic-field names to select. Optional; omission or [] keeps the existing selection. custom_fields and dynamic_fields are aliases; when both are supplied their sets must match.

sync_historical_datastring date nullable

Example request

{
  "scheduling": [
    {
      "scheduling": {
        "value": {
          "days": 1,
          "hours": 1,
          "minutes": 1,
          "interval": "day",
          "timezone": "UTC",
          "lookback_window": {
            "name": "default"
          }
        }
      }
    }
  ],
  "custom_fields": [
    "custom_metric"
  ],
  "dynamic_fields": [
    "custom_metric"
  ]
}

Response

Partially Update an Extract

idinteger

Extract ID

titlestring

Extract title

connection_idinteger

Connection ID

account_idinteger

Account ID

account_namestring

Account name

account_entity_idinteger

Internal Improvado account entity ID.

account_embedded_idinteger nullable

Embedded account ID. Null if the account is not linked to an embedded account.

created_atstring

Extract creation date

last_syncstring

Last sync date

statusstring

Extract status

error_textstring

Error text

schedules_limitinteger

Schedules limit

sync_historical_datastring nullable

Start date for historical data backfill (ISO date format, e.g. "2025-02-25"). Null if not set.

Example response

{
  "extract": {
    "value": {
      "id": 1,
      "title": "Extract 1",
      "connection_id": 1,
      "account_id": 1,
      "account_name": "Account 1",
      "account_entity_id": 1001,
      "account_embedded_id": 5001,
      "template": {
        "id": 1,
        "title": "Extract Template 1",
        "datasource_name": "google_sheets",
        "data_class": "table",
        "is_wide_template": false
      },
      "data_table": {
        "id": 1,
        "name": "table_1",
        "title": "Table 1"
      },
      "fields": [
        {
          "title": "Field 1",
          "name": "field_1",
          "user_kind": "string",
          "user_type": "string",
          "selected": true,
          "can_edit": true,
          "sql_name": "field_1",
          "format": "string",
          "is_dynamic": false
        }
      ],
      "created_at": "2021-01-01T00:00:00Z",
      "last_sync": "2021-01-01T00:00:00Z",
      "status": "active",
      "error_text": "Error text",
      "schedules_limit": 1,
      "scheduling": [
        {
          "days": 1,
          "hours": 1,
          "minutes": 1,
          "interval": "daily",
          "timezone": "UTC",
          "lookback_window": {
            "name": "1 day"
          }
        }
      ],
      "additional_params": [
        {
          "type": "string",
          "name": "param_1",
          "required": true,
          "title": "Param 1",
          "description": "Param 1 description",
          "params": {},
          "initial_value": "value"
        }
      ],
      "sync_historical_data": "2025-02-25"
    }
  }
}

Changes

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