Extraction templates

Get an extraction template by id

Returns a compact representation of an extraction template, including whether it is a wide report template. Useful for deciding which extract flow to use before creating or migrating an extract.

get/api/v3/extract-template/{template_id}/

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/get.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.

Response

Extraction template

idinteger

Extraction template ID.

datasource_namestring

Data source name.

is_wide_templateboolean

Whether the template is a wide report template.

Example response

{
  "id": 1,
  "datasource_name": "act_on",
  "is_wide_template": true
}

Changes

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