IMimprovado
Extraction templates

Preview extraction template data

Returns a preview of data that would be extracted using the given template configuration. The response includes both the data rows and column metadata.

post/api/v3/extract-template/{template_id}/preview/

Request

Path parameters

template_idinteger required

A unique integer value identifying this Extraction template.

Request body

connection_idinteger

Connection ID to use for the preview.

custom_settingsobject

Custom settings for the extraction.

fieldsstring[]

List of fields to include in the preview.

dynamic_fieldsstring[]

List of dynamic fields to include.

accountsstring[]

List of account IDs.

custom_filtersunknown

Example request

{
  "connection_id": 52955,
  "custom_settings": {
    "time_granularity": "week",
    "week_start_day": "monday",
    "sync_historical_data": "2025-09-27",
    "lookback_window": "default",
    "custom_refresh_window": 1,
    "pivot": "COMPANY"
  },
  "fields": [
    "date",
    "input:pivot",
    "pivotValues",
    "approximateMemberReach"
  ],
  "dynamic_fields": [],
  "accounts": [
    "507446188"
  ]
}

Response

Preview data with rows and column metadata

Changes

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