Extraction templates

Validate extraction template settings

Validates the proposed combination of fields, custom settings and accounts against the given extraction template before creating or migrating an extract. Use this endpoint as a pre-flight check — for example, before creating an extract or calling the migrate-wide endpoint.

Accounts are referenced by their embedded account IDs and must all belong to a single connection. The connection is resolved automatically from the provided accounts.

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

Request

Base URL
https://embedded.improvado.io
Auth
- HTTP bearer
- or API key in cookie dts_session_id
TypeScript
https://skmtc.dev/improvado/apis/improvado-embedded-api-v3/docs/api/v3/extract-template/:template_id/validation/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

template_idinteger required

A unique integer value identifying this Extraction template.

Request body

accountsinteger[] required

Embedded account IDs to validate against the template. Must be non-empty and all accounts must belong to a single connection.

Example request

{
  "accounts": [
    100500,
    100501
  ],
  "template_settings": {
    "fields": [
      "date",
      "campaign.name",
      "metrics.clicks",
      "metrics.impressions"
    ],
    "additional_params": {
      "time_granularity": "day"
    }
  }
}

Response

Validation result. An empty detail and empty incompatible mean the settings are valid. Incompatible field combinations are returned in incompatible; other validation errors (e.g. bad custom settings) are returned in detail.

detailstring

Validation error details. Empty string if no errors.

incompatibleobject

Map of incompatible fields to the list of incompatibility reasons. Empty object if all fields are compatible.

Example response

{
  "incompatible": {}
}

Changes

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