Extracts

Create extract

Request to this endpoint setups a new extracts. New extract creation request is composed of Connection, Account and Extract Template data.

post/api/v3.1/extracts/

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.1/extracts/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

data_table_titlestring

Data Table Title

template_idinteger

Template ID

accountsinteger[]

Example request

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

Response

Create an Extract

Changes

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