IMimprovado
Extraction templates

Get an extraction template

Returns detailed info about extraction template

get/api/v3/datasources/{datasource_name}/extract-templates/{id}

Request

Path parameters

datasource_namestring required

Datasource name

idinteger required

Extract Template ID

Response

Get an extraction template

idinteger

Extract Template ID

titlestring

Extract Template title

descriptionstring

Extract Template description

data_classstring

Data class

datasource_namestring

Data source name

is_wide_templateboolean

Whether the template is a wide report template

schedules_limitinteger

Schedules limit

Example response

{
  "extract_template": {
    "value": {
      "id": 1,
      "title": "Extract Template 1",
      "description": "Extract Template 1 description",
      "data_class": "table",
      "datasource_name": "google_sheets",
      "is_wide_template": false,
      "schedules_limit": 1,
      "scheduling": [
        {
          "days": 1,
          "hours": 1,
          "minutes": 1,
          "interval": "daily",
          "timezone": "UTC",
          "lookback_window": {
            "name": "1 day"
          }
        }
      ],
      "fields": [
        {
          "title": "Field 1",
          "name": "field_1",
          "user_kind": "dimension",
          "user_type": "string",
          "selected": true,
          "can_edit": true,
          "sql_name": "field_1",
          "format": "string",
          "is_dynamic": false
        }
      ],
      "additional_params": [
        {
          "type": "string",
          "name": "param_1",
          "required": true,
          "title": "Param 1",
          "description": "Param 1 description",
          "params": {},
          "initial_value": "value"
        }
      ]
    }
  }
}

Changes

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