Datastreams

63 operations in the Adverity Connect API. Replace {{INSTANCE}} and {{KEY}} in the examples with your instance and API key. How authentication works.

List columns

GET/api/columns/

API key permissionDatastream: Read-onlydatastream:read

Query parameters

• datastream_idinteger
• orderingstring

  Which field to use when ordering the results.

• pageinteger

  A page number within the paginated result set.

• page_sizeinteger

  Number of results to return per page.

• removedboolean

Responses

200OKapplication/json

Response schema

object PaginatedDatastreamColumnInfoList

• countintegerrequired

  Example 123

• nextstring · urinullable

  Example "http://api.example.org/accounts/?page=4"

• previousstring · urinullable

  Example "http://api.example.org/accounts/?page=2"

• resultsarray of objectrequired
  Items · DatastreamColumnInfo

  • datatypestringrequired
  • idintegerrequiredread-only
  • change_urlstringrequiredread-only
  • createdstring · date-timerequiredread-only
  • is_key_columnboolean

    If checked, this column will be used to consolidate multiple files.

  • confirmed_typeboolean

    If checked the type will not be changed by the tracking service.

  • namestringrequired

    Max length 200

  • typeinteger
    • 1 - String
    • 2 - Long
    • 3 - Float
    • 4 - Date
    • 5 - DateTime
    • 6 - Boolean
    • 7 - Percentage
    • 9 - Currency
    • 8 - JSON
    • 10 - Formula
    • 11 - Duration
    • 13 - Timestamp

    One of 1 2 3 4 5 6 7 9 8 10 11 13 · Min 0 · Max 32767

  • removedboolean
  • target_columnobjectnullable
    Attributes

    • ReadOnlySchemaColumn

      • idintegerrequired
      • namestringrequiredread-only

        Max length 200

      • typestringrequiredread-only
      • usagestringrequired
      • measureone of
        Attributes

        • MeasureEnum

        • BlankEnum

        • NullEnum

    • null

  • updatedstring · date-timerequiredread-only
  • has_smart_naming_conventionstringrequiredread-only

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/columns/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "datatype": "string",
      "id": 1,
      "change_url": "string",
      "created": "2024-01-01T00:00:00Z",
      "is_key_column": true,
      "confirmed_type": true,
      "name": "string",
      "type": 1,
      "removed": true,
      "target_column": {
        "id": 1,
        "name": "string",
        "type": "string",
        "usage": "string",
        "measure": null
      },
      "updated": "2024-01-01T00:00:00Z",
      "has_smart_naming_convention": "string"
    }
  ]
}

Update columns (PATCH /api/columns/)

PATCH/api/columns/

API key permissionDatastream: Writedatastream:write

Request body

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object PatchedDatastreamColumnInfo

• datatypestring
• is_key_columnboolean

  If checked, this column will be used to consolidate multiple files.

• confirmed_typeboolean

  If checked the type will not be changed by the tracking service.

• namestring

  Max length 200

• typeinteger
  • 1 - String
  • 2 - Long
  • 3 - Float
  • 4 - Date
  • 5 - DateTime
  • 6 - Boolean
  • 7 - Percentage
  • 9 - Currency
  • 8 - JSON
  • 10 - Formula
  • 11 - Duration
  • 13 - Timestamp

  One of 1 2 3 4 5 6 7 9 8 10 11 13 · Min 0 · Max 32767

• removedboolean
• target_columnobjectnullable
  Attributes

  • ReadOnlySchemaColumn

    • idintegerrequired
    • usagestringrequired
    • measureone of
      Attributes

      • MeasureEnum

      • BlankEnum

      • NullEnum

  • null

• set_defaultbooleanwrite-only

  Default false

• reset_defaultbooleanwrite-only

  Default false

• unlock_typebooleanwrite-only

  Default false

Responses

200OKapplication/json

Response schema

object DatastreamColumnInfo

• datatypestringrequired
• idintegerrequiredread-only
• change_urlstringrequiredread-only
• createdstring · date-timerequiredread-only
• is_key_columnboolean

  If checked, this column will be used to consolidate multiple files.

• confirmed_typeboolean

  If checked the type will not be changed by the tracking service.

• namestringrequired

  Max length 200

• typeinteger
  • 1 - String
  • 2 - Long
  • 3 - Float
  • 4 - Date
  • 5 - DateTime
  • 6 - Boolean
  • 7 - Percentage
  • 9 - Currency
  • 8 - JSON
  • 10 - Formula
  • 11 - Duration
  • 13 - Timestamp

  One of 1 2 3 4 5 6 7 9 8 10 11 13 · Min 0 · Max 32767

• removedboolean
• target_columnobjectnullable
  Attributes

  • ReadOnlySchemaColumn

    • idintegerrequired
    • namestringrequiredread-only

      Max length 200

    • typestringrequiredread-only
    • usagestringrequired
    • measureone of
      Attributes

      • MeasureEnum

      • BlankEnum

      • NullEnum

  • null

• updatedstring · date-timerequiredread-only
• has_smart_naming_conventionstringrequiredread-only

RequestcURL

curl --request PATCH 'https://{{INSTANCE}}/api/columns/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "datatype": "string",
    "is_key_column": true,
    "confirmed_type": true,
    "name": "string",
    "type": 1,
    "removed": true,
    "target_column": {
      "id": 1,
      "usage": "string",
      "measure": "SUM"
    },
    "set_default": false,
    "reset_default": false,
    "unlock_type": false
  }'

Response200

{
  "datatype": "string",
  "id": 1,
  "change_url": "string",
  "created": "2024-01-01T00:00:00Z",
  "is_key_column": true,
  "confirmed_type": true,
  "name": "string",
  "type": 1,
  "removed": true,
  "target_column": {
    "id": 1,
    "name": "string",
    "type": "string",
    "usage": "string",
    "measure": "SUM"
  },
  "updated": "2024-01-01T00:00:00Z",
  "has_smart_naming_convention": "string"
}

Get columns

GET/api/columns/{id}/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• idintegerrequired

  A unique integer value identifying this datastream column info.

Responses

200OKapplication/json

Response schema

object DatastreamColumnInfo

• datatypestringrequired
• idintegerrequiredread-only
• change_urlstringrequiredread-only
• createdstring · date-timerequiredread-only
• is_key_columnboolean

  If checked, this column will be used to consolidate multiple files.

• confirmed_typeboolean

  If checked the type will not be changed by the tracking service.

• namestringrequired

  Max length 200

• typeinteger
  • 1 - String
  • 2 - Long
  • 3 - Float
  • 4 - Date
  • 5 - DateTime
  • 6 - Boolean
  • 7 - Percentage
  • 9 - Currency
  • 8 - JSON
  • 10 - Formula
  • 11 - Duration
  • 13 - Timestamp

  One of 1 2 3 4 5 6 7 9 8 10 11 13 · Min 0 · Max 32767

• removedboolean
• target_columnobjectnullable
  Attributes

  • ReadOnlySchemaColumn

    • idintegerrequired
    • namestringrequiredread-only

      Max length 200

    • typestringrequiredread-only
    • usagestringrequired
    • measureone of
      Attributes

      • MeasureEnum

      • BlankEnum

      • NullEnum

  • null

• updatedstring · date-timerequiredread-only
• has_smart_naming_conventionstringrequiredread-only

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/columns/{id}/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "datatype": "string",
  "id": 1,
  "change_url": "string",
  "created": "2024-01-01T00:00:00Z",
  "is_key_column": true,
  "confirmed_type": true,
  "name": "string",
  "type": 1,
  "removed": true,
  "target_column": {
    "id": 1,
    "name": "string",
    "type": "string",
    "usage": "string",
    "measure": "SUM"
  },
  "updated": "2024-01-01T00:00:00Z",
  "has_smart_naming_convention": "string"
}

Update columns (PATCH /api/columns/{id}/)

PATCH/api/columns/{id}/

API key permissionDatastream: Writedatastream:write

Path parameters

• idintegerrequired

  A unique integer value identifying this datastream column info.

Request body

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object PatchedDatastreamColumnInfo

• datatypestring
• is_key_columnboolean

  If checked, this column will be used to consolidate multiple files.

• confirmed_typeboolean

  If checked the type will not be changed by the tracking service.

• namestring

  Max length 200

• typeinteger
  • 1 - String
  • 2 - Long
  • 3 - Float
  • 4 - Date
  • 5 - DateTime
  • 6 - Boolean
  • 7 - Percentage
  • 9 - Currency
  • 8 - JSON
  • 10 - Formula
  • 11 - Duration
  • 13 - Timestamp

  One of 1 2 3 4 5 6 7 9 8 10 11 13 · Min 0 · Max 32767

• removedboolean
• target_columnobjectnullable
  Attributes

  • ReadOnlySchemaColumn

    • idintegerrequired
    • usagestringrequired
    • measureone of
      Attributes

      • MeasureEnum

      • BlankEnum

      • NullEnum

  • null

• set_defaultbooleanwrite-only

  Default false

• reset_defaultbooleanwrite-only

  Default false

• unlock_typebooleanwrite-only

  Default false

Responses

200OKapplication/json

Response schema

object DatastreamColumnInfo

• datatypestringrequired
• idintegerrequiredread-only
• change_urlstringrequiredread-only
• createdstring · date-timerequiredread-only
• is_key_columnboolean

  If checked, this column will be used to consolidate multiple files.

• confirmed_typeboolean

  If checked the type will not be changed by the tracking service.

• namestringrequired

  Max length 200

• typeinteger
  • 1 - String
  • 2 - Long
  • 3 - Float
  • 4 - Date
  • 5 - DateTime
  • 6 - Boolean
  • 7 - Percentage
  • 9 - Currency
  • 8 - JSON
  • 10 - Formula
  • 11 - Duration
  • 13 - Timestamp

  One of 1 2 3 4 5 6 7 9 8 10 11 13 · Min 0 · Max 32767

• removedboolean
• target_columnobjectnullable
  Attributes

  • ReadOnlySchemaColumn

    • idintegerrequired
    • namestringrequiredread-only

      Max length 200

    • typestringrequiredread-only
    • usagestringrequired
    • measureone of
      Attributes

      • MeasureEnum

      • BlankEnum

      • NullEnum

  • null

• updatedstring · date-timerequiredread-only
• has_smart_naming_conventionstringrequiredread-only

RequestcURL

curl --request PATCH 'https://{{INSTANCE}}/api/columns/{id}/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "datatype": "string",
    "is_key_column": true,
    "confirmed_type": true,
    "name": "string",
    "type": 1,
    "removed": true,
    "target_column": {
      "id": 1,
      "usage": "string",
      "measure": "SUM"
    },
    "set_default": false,
    "reset_default": false,
    "unlock_type": false
  }'

Response200

{
  "datatype": "string",
  "id": 1,
  "change_url": "string",
  "created": "2024-01-01T00:00:00Z",
  "is_key_column": true,
  "confirmed_type": true,
  "name": "string",
  "type": 1,
  "removed": true,
  "target_column": {
    "id": 1,
    "name": "string",
    "type": "string",
    "usage": "string",
    "measure": "SUM"
  },
  "updated": "2024-01-01T00:00:00Z",
  "has_smart_naming_convention": "string"
}

List datastream types

GET/api/datastream-types/

API key permissionDatastream: Read-onlydatastream:read

Query parameters

• pageinteger

  A page number within the paginated result set.

• page_sizeinteger

  Number of results to return per page.

• searchstring

  A search term.

Responses

200OKapplication/json

Response schema

object PaginatedDatastreamTypeList

• countintegerrequired

  Example 123

• nextstring · urinullable

  Example "http://api.example.org/accounts/?page=4"

• previousstring · urinullable

  Example "http://api.example.org/accounts/?page=2"

• resultsarray of objectrequired
  Items · DatastreamType

  • idintegerrequiredread-only
  • namestringrequiredread-only
  • slugstringrequiredread-only
  • canonical_namestringrequiredread-only
  • api_detailsobjectrequiredread-only
  • urlstring · urirequiredread-only
  • categoriesarray of stringrequiredread-only
  • keywordsarray of stringrequiredread-only
  • is_deprecatedbooleanrequiredread-only
  • logo_urlstringrequiredread-only
  • create_urlstringrequiredread-only
  • datastreamsstring · urirequiredread-only
  • connection_typesarray of stringrequiredread-only
  • presetsstringrequiredread-only

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/datastream-types/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 1,
      "name": "string",
      "slug": "string",
      "canonical_name": "string",
      "api_details": {
        "key": null
      },
      "url": "https://example.com",
      "categories": [
        "string"
      ],
      "keywords": [
        "string"
      ],
      "is_deprecated": true,
      "logo_url": "string",
      "create_url": "string",
      "datastreams": "https://example.com",
      "connection_types": [
        "string"
      ],
      "presets": "string"
    }
  ]
}

Get datastream types

GET/api/datastream-types/{id}/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• idintegerrequired

  A unique integer value identifying this content type.

Responses

200OKapplication/json

Response schema

object DatastreamType

• idintegerrequiredread-only
• namestringrequiredread-only
• slugstringrequiredread-only
• canonical_namestringrequiredread-only
• api_detailsobjectrequiredread-only
• urlstring · urirequiredread-only
• categoriesarray of stringrequiredread-only
• keywordsarray of stringrequiredread-only
• is_deprecatedbooleanrequiredread-only
• logo_urlstringrequiredread-only
• create_urlstringrequiredread-only
• datastreamsstring · urirequiredread-only
• connection_typesarray of stringrequiredread-only
• presetsstringrequiredread-only

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/datastream-types/{id}/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "id": 1,
  "name": "string",
  "slug": "string",
  "canonical_name": "string",
  "api_details": {
    "key": null
  },
  "url": "https://example.com",
  "categories": [
    "string"
  ],
  "keywords": [
    "string"
  ],
  "is_deprecated": true,
  "logo_url": "string",
  "create_url": "string",
  "datastreams": "https://example.com",
  "connection_types": [
    "string"
  ],
  "presets": "string"
}

Get datastream types datastreams (GET /api/datastream-types/{parent_lookup_type_id}/datastreams/)

GET/api/datastream-types/{parent_lookup_type_id}/datastreams/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• parent_lookup_type_idstringrequired

Query parameters

• autharray of integer

  Return only datastreams using the given authorization(s). Accepts a comma-separated list of IDs.

• creatorstring
• idsarray of integer

  Multiple values may be separated by commas.

• namestring
• scheduled_deletionboolean

  true returns only datastreams scheduled for deletion; false returns only those that are not. Omit to return both.

• stack_idinteger

  Which workspace the datastream belongs to.

• transformerinteger

  Return only datastreams that have the given TransformerConfig assigned.

Responses

200No response body

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/datastream-types/{parent_lookup_type_id}/datastreams/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

No response body.

Create datastream types datastreams

POST/api/datastream-types/{parent_lookup_type_id}/datastreams/

API key permissionDatastream: Writedatastream:write

Path parameters

• parent_lookup_type_idstringrequired

Responses

201No response body

RequestcURL

curl --request POST 'https://{{INSTANCE}}/api/datastream-types/{parent_lookup_type_id}/datastreams/' \
  --header 'Authorization: Bearer {{KEY}}'

Response201

No response body.

Get datastream types datastreams (GET /api/datastream-types/{parent_lookup_type_id}/datastreams/{id}/)

GET/api/datastream-types/{parent_lookup_type_id}/datastreams/{id}/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• idstringrequired
• parent_lookup_type_idstringrequired

Query parameters

• expandstring

  Comma-separated related resources to inline in the response. Currently supports 'destinations', which adds the assigned_destinations array.

  One of destinations

Responses

200No response body

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/datastream-types/{parent_lookup_type_id}/datastreams/{id}/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

No response body.

Replace datastream types datastreams

PUT/api/datastream-types/{parent_lookup_type_id}/datastreams/{id}/

API key permissionDatastream: Writedatastream:write

Path parameters

• idstringrequired
• parent_lookup_type_idstringrequired

Responses

200No response body

RequestcURL

curl --request PUT 'https://{{INSTANCE}}/api/datastream-types/{parent_lookup_type_id}/datastreams/{id}/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

No response body.

Update datastream types datastreams

PATCH/api/datastream-types/{parent_lookup_type_id}/datastreams/{id}/

API key permissionDatastream: Writedatastream:write

Path parameters

• idstringrequired
• parent_lookup_type_idstringrequired

Responses

200No response body

RequestcURL

curl --request PATCH 'https://{{INSTANCE}}/api/datastream-types/{parent_lookup_type_id}/datastreams/{id}/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

No response body.

Delete datastream types datastreams

DELETE/api/datastream-types/{parent_lookup_type_id}/datastreams/{id}/

API key permissionDatastream: Writedatastream:write

Path parameters

• idstringrequired
• parent_lookup_type_idstringrequired

Responses

204No response body

RequestcURL

curl --request DELETE 'https://{{INSTANCE}}/api/datastream-types/{parent_lookup_type_id}/datastreams/{id}/' \
  --header 'Authorization: Bearer {{KEY}}'

Response204

No response body.

List datastream types datastreams columns

GET/api/datastream-types/{parent_lookup_type_id}/datastreams/{parent_lookup_datastream_id}/columns/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• parent_lookup_datastream_idstringrequired
• parent_lookup_type_idstringrequired

Query parameters

• datastream_idinteger
• orderingstring

  Which field to use when ordering the results.

• pageinteger

  A page number within the paginated result set.

• page_sizeinteger

  Number of results to return per page.

• removedboolean

Responses

200OKapplication/json

Response schema

object PaginatedDatastreamColumnInfoList

• countintegerrequired

  Example 123

• nextstring · urinullable

  Example "http://api.example.org/accounts/?page=4"

• previousstring · urinullable

  Example "http://api.example.org/accounts/?page=2"

• resultsarray of objectrequired
  Items · DatastreamColumnInfo

  • datatypestringrequired
  • idintegerrequiredread-only
  • change_urlstringrequiredread-only
  • createdstring · date-timerequiredread-only
  • is_key_columnboolean

    If checked, this column will be used to consolidate multiple files.

  • confirmed_typeboolean

    If checked the type will not be changed by the tracking service.

  • namestringrequired

    Max length 200

  • typeinteger
    • 1 - String
    • 2 - Long
    • 3 - Float
    • 4 - Date
    • 5 - DateTime
    • 6 - Boolean
    • 7 - Percentage
    • 9 - Currency
    • 8 - JSON
    • 10 - Formula
    • 11 - Duration
    • 13 - Timestamp

    One of 1 2 3 4 5 6 7 9 8 10 11 13 · Min 0 · Max 32767

  • removedboolean
  • target_columnobjectnullable
    Attributes

    • ReadOnlySchemaColumn

      • idintegerrequired
      • namestringrequiredread-only

        Max length 200

      • typestringrequiredread-only
      • usagestringrequired
      • measureone of
        Attributes

        • MeasureEnum

        • BlankEnum

        • NullEnum

    • null

  • updatedstring · date-timerequiredread-only
  • has_smart_naming_conventionstringrequiredread-only

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/datastream-types/{parent_lookup_type_id}/datastreams/{parent_lookup_datastream_id}/columns/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "datatype": "string",
      "id": 1,
      "change_url": "string",
      "created": "2024-01-01T00:00:00Z",
      "is_key_column": true,
      "confirmed_type": true,
      "name": "string",
      "type": 1,
      "removed": true,
      "target_column": {
        "id": 1,
        "name": "string",
        "type": "string",
        "usage": "string",
        "measure": null
      },
      "updated": "2024-01-01T00:00:00Z",
      "has_smart_naming_convention": "string"
    }
  ]
}

Get datastream types datastreams columns

GET/api/datastream-types/{parent_lookup_type_id}/datastreams/{parent_lookup_datastream_id}/columns/{id}/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• idintegerrequired

  A unique integer value identifying this datastream column info.

• parent_lookup_datastream_idstringrequired
• parent_lookup_type_idstringrequired

Responses

200OKapplication/json

Response schema

object DatastreamColumnInfo

• datatypestringrequired
• idintegerrequiredread-only
• change_urlstringrequiredread-only
• createdstring · date-timerequiredread-only
• is_key_columnboolean

  If checked, this column will be used to consolidate multiple files.

• confirmed_typeboolean

  If checked the type will not be changed by the tracking service.

• namestringrequired

  Max length 200

• typeinteger
  • 1 - String
  • 2 - Long
  • 3 - Float
  • 4 - Date
  • 5 - DateTime
  • 6 - Boolean
  • 7 - Percentage
  • 9 - Currency
  • 8 - JSON
  • 10 - Formula
  • 11 - Duration
  • 13 - Timestamp

  One of 1 2 3 4 5 6 7 9 8 10 11 13 · Min 0 · Max 32767

• removedboolean
• target_columnobjectnullable
  Attributes

  • ReadOnlySchemaColumn

    • idintegerrequired
    • namestringrequiredread-only

      Max length 200

    • typestringrequiredread-only
    • usagestringrequired
    • measureone of
      Attributes

      • MeasureEnum

      • BlankEnum

      • NullEnum

  • null

• updatedstring · date-timerequiredread-only
• has_smart_naming_conventionstringrequiredread-only

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/datastream-types/{parent_lookup_type_id}/datastreams/{parent_lookup_datastream_id}/columns/{id}/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "datatype": "string",
  "id": 1,
  "change_url": "string",
  "created": "2024-01-01T00:00:00Z",
  "is_key_column": true,
  "confirmed_type": true,
  "name": "string",
  "type": 1,
  "removed": true,
  "target_column": {
    "id": 1,
    "name": "string",
    "type": "string",
    "usage": "string",
    "measure": "SUM"
  },
  "updated": "2024-01-01T00:00:00Z",
  "has_smart_naming_convention": "string"
}

Update datastream types datastreams columns

PATCH/api/datastream-types/{parent_lookup_type_id}/datastreams/{parent_lookup_datastream_id}/columns/{id}/

API key permissionDatastream: Writedatastream:write

Path parameters

• idintegerrequired

  A unique integer value identifying this datastream column info.

• parent_lookup_datastream_idstringrequired
• parent_lookup_type_idstringrequired

Request body

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object PatchedDatastreamColumnInfo

• datatypestring
• is_key_columnboolean

  If checked, this column will be used to consolidate multiple files.

• confirmed_typeboolean

  If checked the type will not be changed by the tracking service.

• namestring

  Max length 200

• typeinteger
  • 1 - String
  • 2 - Long
  • 3 - Float
  • 4 - Date
  • 5 - DateTime
  • 6 - Boolean
  • 7 - Percentage
  • 9 - Currency
  • 8 - JSON
  • 10 - Formula
  • 11 - Duration
  • 13 - Timestamp

  One of 1 2 3 4 5 6 7 9 8 10 11 13 · Min 0 · Max 32767

• removedboolean
• target_columnobjectnullable
  Attributes

  • ReadOnlySchemaColumn

    • idintegerrequired
    • usagestringrequired
    • measureone of
      Attributes

      • MeasureEnum

      • BlankEnum

      • NullEnum

  • null

• set_defaultbooleanwrite-only

  Default false

• reset_defaultbooleanwrite-only

  Default false

• unlock_typebooleanwrite-only

  Default false

Responses

200OKapplication/json

Response schema

object DatastreamColumnInfo

• datatypestringrequired
• idintegerrequiredread-only
• change_urlstringrequiredread-only
• createdstring · date-timerequiredread-only
• is_key_columnboolean

  If checked, this column will be used to consolidate multiple files.

• confirmed_typeboolean

  If checked the type will not be changed by the tracking service.

• namestringrequired

  Max length 200

• typeinteger
  • 1 - String
  • 2 - Long
  • 3 - Float
  • 4 - Date
  • 5 - DateTime
  • 6 - Boolean
  • 7 - Percentage
  • 9 - Currency
  • 8 - JSON
  • 10 - Formula
  • 11 - Duration
  • 13 - Timestamp

  One of 1 2 3 4 5 6 7 9 8 10 11 13 · Min 0 · Max 32767

• removedboolean
• target_columnobjectnullable
  Attributes

  • ReadOnlySchemaColumn

    • idintegerrequired
    • namestringrequiredread-only

      Max length 200

    • typestringrequiredread-only
    • usagestringrequired
    • measureone of
      Attributes

      • MeasureEnum

      • BlankEnum

      • NullEnum

  • null

• updatedstring · date-timerequiredread-only
• has_smart_naming_conventionstringrequiredread-only

RequestcURL

curl --request PATCH 'https://{{INSTANCE}}/api/datastream-types/{parent_lookup_type_id}/datastreams/{parent_lookup_datastream_id}/columns/{id}/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "datatype": "string",
    "is_key_column": true,
    "confirmed_type": true,
    "name": "string",
    "type": 1,
    "removed": true,
    "target_column": {
      "id": 1,
      "usage": "string",
      "measure": "SUM"
    },
    "set_default": false,
    "reset_default": false,
    "unlock_type": false
  }'

Response200

{
  "datatype": "string",
  "id": 1,
  "change_url": "string",
  "created": "2024-01-01T00:00:00Z",
  "is_key_column": true,
  "confirmed_type": true,
  "name": "string",
  "type": 1,
  "removed": true,
  "target_column": {
    "id": 1,
    "name": "string",
    "type": "string",
    "usage": "string",
    "measure": "SUM"
  },
  "updated": "2024-01-01T00:00:00Z",
  "has_smart_naming_convention": "string"
}

List datastreams (GET /api/datastreams/)

GET/api/datastreams/

API key permissionDatastream: Read-onlydatastream:read

Query parameters

• autharray of integer

  Return only datastreams using the given authorization(s). Accepts a comma-separated list of IDs.

• creatorstring
• idsarray of integer

  Multiple values may be separated by commas.

• namestring
• orderingstring

  Which field to use when ordering the results.

• pageinteger

  A page number within the paginated result set.

• page_sizeinteger

  Number of results to return per page.

• scheduled_deletionboolean

  true returns only datastreams scheduled for deletion; false returns only those that are not. Omit to return both.

• stack_idinteger

  Which workspace the datastream belongs to.

• transformerinteger

  Return only datastreams that have the given TransformerConfig assigned.

Responses

200OKapplication/json

Response schema

object PaginatedAPIDatastreamBasicList

• countintegerrequired

  Example 123

• nextstring · urinullable

  Example "http://api.example.org/accounts/?page=4"

• previousstring · urinullable

  Example "http://api.example.org/accounts/?page=2"

• resultsarray of objectrequired
  Items · APIDatastreamBasic

  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • stackobjectrequiredread-only
    Attributes · StackBasic

    • idintegerrequiredread-only
    • uuidstring · uuidrequiredread-only
    • namestringrequired

      Max length 60

    • slugstringrequiredread-only
    • urlstring · urirequiredread-only
    • change_urlstringrequiredread-only
    • extracts_urlstringrequiredread-only
    • issues_urlstringrequiredread-only
    • overview_urlstringrequiredread-only
    • permissionsstringrequiredread-only
  • stack_idintegerrequiredread-only

    Which workspace the datastream belongs to.

  • authintegernullable

    Which authorization the datastream uses.

  • namestringrequired

    A human readable name. Numbers and special characters are supported.

    Max length 150

  • slugstringrequiredread-only
  • app_labelstringrequiredread-only
  • absolute_urlstringrequiredread-only
  • change_urlstringrequiredread-only
  • extracts_urlstringrequiredread-only
  • fetch_urlstringrequiredread-only
  • overview_urlstringrequiredread-only
  • schema_mapping_urlstringrequiredread-only
  • enabledboolean

    Streams that are not scheduled will not be fetched automatically.

  • next_runstring · date-timerequiredread-only
  • urlstring · urirequiredread-only
  • datastream_type_idintegerrequiredread-only
  • logo_urlstringrequiredread-only
  • extracts_stream_urlstringrequiredread-only
  • supports_extended_intervalsstringrequiredread-only
  • updatedstring · date-timerequiredread-only
  • createdstring · date-timerequiredread-only
  • creatorstringrequiredread-onlynullable
  • can_be_fetchedbooleanrequiredread-only

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/datastreams/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 1,
      "uuid": "00000000-0000-0000-0000-000000000000",
      "stack": {
        "id": 1,
        "uuid": "00000000-0000-0000-0000-000000000000",
        "name": "string",
        "slug": "string",
        "url": "https://example.com",
        "change_url": "string",
        "extracts_url": "string",
        "issues_url": "string",
        "overview_url": "string",
        "permissions": "string"
      },
      "stack_id": 1,
      "auth": 1,
      "name": "string",
      "slug": "string",
      "app_label": "string",
      "absolute_url": "string",
      "change_url": "string",
      "extracts_url": "string",
      "fetch_url": "string",
      "overview_url": "string",
      "schema_mapping_url": "string",
      "enabled": true,
      "next_run": "2024-01-01T00:00:00Z",
      "url": "https://example.com",
      "datastream_type_id": 1,
      "logo_url": "string",
      "extracts_stream_url": "string",
      "supports_extended_intervals": "string",
      "updated": "2024-01-01T00:00:00Z",
      "created": "2024-01-01T00:00:00Z",
      "creator": "string",
      "can_be_fetched": true
    }
  ]
}

Get datastreams

GET/api/datastreams/{id}/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream.

Query parameters

• expandstring

  Comma-separated related resources to inline in the response. Currently supports 'destinations', which adds the assigned_destinations array.

  One of destinations

Responses

200OKapplication/json

Response schema

object APIDatastreamFull

• idintegerrequiredread-only
• uuidstring · uuidrequiredread-only
• urlstring · urirequiredread-only
• stackobjectrequiredread-only
  Attributes · StackBasic

  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • namestringrequired

    Max length 60

  • slugstringrequiredread-only
  • urlstring · urirequiredread-only
  • change_urlstringrequiredread-only
  • extracts_urlstringrequiredread-only
  • issues_urlstringrequiredread-only
  • overview_urlstringrequiredread-only
  • permissionsstringrequiredread-only
• authintegernullable

  Which authorization the datastream uses.

• auth_change_urlstringrequiredread-only
• app_labelstringrequiredread-only
• namestringrequired

  A human readable name. Numbers and special characters are supported.

  Max length 150

• slugstringrequiredread-only
• descriptionstring

  Max length 1000

• enabledboolean

  Streams that are not scheduled will not be fetched automatically.

• frequencystringrequiredread-only
• next_runstring · date-timerequiredread-only
• last_fetchstring · date-timerequiredread-only
• absolute_urlstringrequiredread-only
• change_urlstringrequiredread-only
• extracts_urlstringrequiredread-only
• fetch_urlstringrequiredread-only
• overview_urlstringrequiredread-only
• schema_mapping_urlstringrequiredread-only
• issues_urlstringrequiredread-only
• transformersarray of objectrequiredread-only
  Items · TransformerBasic

  • idintegerrequiredread-only
  • namestringrequired

    Max length 200

  • stackintegernullable
  • change_urlstringrequiredread-only
  • smart_naming_conventionobjectrequiredread-only
    Attributes · SmartNamingConventionSummary

    • idintegerrequiredread-only
    • column_namestringrequiredread-only
    • datastream_namesstringrequiredread-only
    • delimiters_charactersstringrequiredread-only
    • sorted_columns_namesstringrequiredread-only
    • email_for_errorbooleanrequired
    • email_for_warningbooleanrequired
    • raise_for_warningbooleanrequired
    • add_status_columnsbooleanrequired
    • columns_rule_phrasingstringrequiredread-only
• schedulesarray of objectrequiredread-only
  Items · FetchSchedule

  • idintegerrequiredread-only
  • cron_presetstring
    • ONCE - Once
    • CRON_EVERY_DAY - Every day
    • CRON_EVERY_WEEK - Every week
    • CRON_EVERY_MONTH - Every month
    • CRON_EVERY_QUARTER - Every quarter
    • CRON_EVERY_15_MINUTES - Every 15 minutes
    • CRON_EVERY_30_MINUTES - Every 30 minutes
    • CRON_EVERY_HOUR - Every hour
    • CRON_EVERY_2_HOURS - Every 2 hours
    • CRON_EVERY_3_HOURS - Every 3 hours
    • CRON_EVERY_4_HOURS - Every 4 hours
    • CRON_EVERY_5_HOURS - Every 5 hours
    • CRON_EVERY_6_HOURS - Every 6 hours
    • CRON_EVERY_8_HOURS - Every 8 hours
    • CRON_EVERY_12_HOURS - Every 12 hours
    • CRON_EVERY_2_DAYS - Every 2 days
    • CRON_EVERY_30_DAYS - Every 30 days
    • CRON_EVERY_40_DAYS - Every 40 days
    • CRON_EVERY_2_WEEKS - Every 2 weeks
    • CRON_EVERY_4_WEEKS - Every 4 weeks
    • CRON_EVERY_6_MONTHS - Every 6 months
    • CRON_EVERY_YEAR - Every year

    One of ONCE CRON_EVERY_DAY CRON_EVERY_WEEK CRON_EVERY_MONTH CRON_EVERY_QUARTER CRON_EVERY_15_MINUTES CRON_EVERY_30_MINUTES CRON_EVERY_HOUR CRON_EVERY_2_HOURS CRON_EVERY_3_HOURS CRON_EVERY_4_HOURS CRON_EVERY_5_HOURS CRON_EVERY_6_HOURS CRON_EVERY_8_HOURS CRON_EVERY_12_HOURS CRON_EVERY_2_DAYS CRON_EVERY_30_DAYS CRON_EVERY_40_DAYS CRON_EVERY_2_WEEKS CRON_EVERY_4_WEEKS CRON_EVERY_6_MONTHS CRON_EVERY_YEAR

  • cron_typestring

    Defaults to 'day' when omitted on a schedule entry.

  • cron_intervalinteger

    Min 0 · Max 2147483647

  • cron_start_of_daystring · time

    At what time the day starts.

  • cron_interval_startinteger

    Min 0 · Max 32767

  • time_range_presetinteger

    Select one of the time range presets.

    • 0 - Custom Time Range
    • 13 - Yesterday
    • 10 - Today
    • 11 - Current Week
    • 6 - Current Month
    • 7 - Previous Month
    • 17 - Last Quarter
    • 18 - Last 2 Days
    • 16 - Last 3 Days
    • 23 - Last 4 Days
    • 19 - Last 5 Days
    • 24 - Last 6 Days
    • 4 - Last 7 Days
    • 25 - Last 8 Days
    • 26 - Last 9 Days
    • 22 - Last 10 Days
    • 14 - Last 14 Days
    • 15 - Last 28 Days
    • 2 - Last 30 Days
    • 20 - Last 40 Days
    • 21 - Last 60 Days
    • 5 - Last 90 Days
    • 31 - Last 120 Days
    • 28 - Last 180 Days
    • 3 - Last 365 Days
    • 27 - Last 730 Days
    • 8 - Previous Week
    • 9 - Previous Year
    • 29 - Current Quarter
    • 12 - Current Year
    • 30 - Last Hour
    • 1000 - Lifetime
    • 50 - Tomorrow
    • 51 - Next 2 Days
    • 52 - Next 7 Days
    • 53 - Next 30 Days
    • 54 - Current Week (incl Future Days)
    • 55 - Next Week
    • 56 - Current Month (incl Future Days)
    • 57 - Next Month
    • 58 - Current Year (incl Future Days)
    • 59 - Next Year

    One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59 · Min 0 · Max 32767

  • time_range_preset_labelstringrequiredread-only
  • delta_typeinteger
    • 0 - minute(s)
    • 1 - hour(s)
    • 2 - day(s)
    • 3 - week(s)
    • 4 - month(s)
    • 6 - quarters(s)
    • 5 - year(s)
    • 7 - once

    One of 0 1 2 3 4 6 5 7 · Min -32768 · Max 32767

  • delta_intervalinteger

    Min 0 · Max 2147483647

  • delta_start_of_daystring · time

    At what time the day starts.

  • delta_interval_startinteger

    Min 0 · Max 32767

  • fixed_startstring · datenullable

    First day to fetch.

  • fixed_endstring · datenullable

    Last day to fetch.

  • offset_daysinteger

    Number of days to shift the fetched date range into the past.

    Min -32768 · Max 32767

  • not_before_datestring · datenullable

    Do not fetch before this date.

  • not_before_timestring · timenullable

    Do not fetch before this time.

• datastream_type_idintegerrequiredread-only
• datastream_type_namestringrequiredread-only
• datastream_type_slugstringrequiredread-only
• datatypestring

  Projection of destination state: reads Live if any destination is enabled, otherwise Staging. Writing 'Live' enables all destinations and 'Staging' disables them.

  • Live - Live
  • Staging - Staging

  One of Live Staging

• actionsstringrequiredread-only
• overwrite_key_columnsboolean

  Overwrite rows according to Key defined in Data Mapping.

• manage_extract_namesboolean

  Split by selected date column and name extracts with pre-defined pattern to consolidate data.

• extract_name_keysstringnullable

  Max length 128

• retention_typeinteger
  • 1 - Retain all
  • 2 - Retain N fetches
  • 4 - Retain N extracts
  • 3 - Retain N days

  One of 1 2 4 3 · Min 0 · Max 32767

• retention_numberintegernullable

  The amount (N) of fetches/extracts/days to retain (raw extracts are not counted). Must be an integer greater than or equal to zero.

  Min 0 · Max 32767

• remove_if_emptyboolean

  When enabled, fetches resulting in only empty rows ("empty extracts") will be silently discarded.

• skip_empty_rowsboolean

  When enabled, empty data rows in fetches will be silently ignored.

• prune_instantlyboolean

  When enabled, deleted files will not be kept for the configured grace period.

• overwrite_datastreamboolean

  Delete/Drop all existing rows (created by this datastream) in the destination before inserting a new import.

• overwrite_filenameboolean

  Overwrite rows from same extract file.

• logo_urlstringrequiredread-only
• extracts_stream_urlstringrequiredread-only
• active_destinationstringrequiredread-only
• supports_passive_destinationsbooleanrequiredread-only
• passive_destinationsstringrequiredread-only
• columnsstring · urirequiredread-only
• supports_extended_intervalsstringrequiredread-only
• updatedstring · date-timerequiredread-only
• createdstring · date-timerequiredread-only
• creatorstringrequiredread-onlynullable
• has_schema_mappingbooleanrequiredread-only
• is_insights_mediaplanboolean

  If checked, generated extracts will be treated as Insights mediaplans.

• cron_typestring
• cron_intervalinteger

  Min 0

• cron_start_of_daystring · time
• cron_interval_startinteger

  Min 0

• time_range_presetinteger
  • 0 - Custom Time Range
  • 13 - Yesterday
  • 10 - Today
  • 11 - Current Week
  • 6 - Current Month
  • 7 - Previous Month
  • 17 - Last Quarter
  • 18 - Last 2 Days
  • 16 - Last 3 Days
  • 23 - Last 4 Days
  • 19 - Last 5 Days
  • 24 - Last 6 Days
  • 4 - Last 7 Days
  • 25 - Last 8 Days
  • 26 - Last 9 Days
  • 22 - Last 10 Days
  • 14 - Last 14 Days
  • 15 - Last 28 Days
  • 2 - Last 30 Days
  • 20 - Last 40 Days
  • 21 - Last 60 Days
  • 5 - Last 90 Days
  • 31 - Last 120 Days
  • 28 - Last 180 Days
  • 3 - Last 365 Days
  • 27 - Last 730 Days
  • 8 - Previous Week
  • 9 - Previous Year
  • 29 - Current Quarter
  • 12 - Current Year
  • 30 - Last Hour
  • 1000 - Lifetime
  • 50 - Tomorrow
  • 51 - Next 2 Days
  • 52 - Next 7 Days
  • 53 - Next 30 Days
  • 54 - Current Week (incl Future Days)
  • 55 - Next Week
  • 56 - Current Month (incl Future Days)
  • 57 - Next Month
  • 58 - Current Year (incl Future Days)
  • 59 - Next Year

  One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59

• delta_intervalinteger

  Min 0

• delta_interval_startinteger

  Min 0

• delta_start_of_daystring · time
• delta_typeinteger
  • 0 - minute(s)
  • 1 - hour(s)
  • 2 - day(s)
  • 3 - week(s)
  • 4 - month(s)
  • 6 - quarters(s)
  • 5 - year(s)
  • 7 - once

  One of 0 1 2 3 4 6 5 7

• time_range_maxstringrequiredread-only
• time_range_availablestringrequiredread-only
• has_schema_mapping_dimensionbooleanrequiredread-only
• feature_smart_naming_conventionstringrequiredread-only
• auto_fetchstringrequiredread-only
• assigned_destinationsarray of objectrequiredread-only
  Items · AssignedDestination

  • target_idintegerrequiredread-only
  • destination_namestringrequiredread-only
  • destination_typestringrequiredread-only
  • enabledbooleanrequiredread-only
  • destination_settingsobjectrequiredread-only
• can_be_fetchedbooleanrequiredread-only

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/datastreams/{id}/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "id": 1,
  "uuid": "00000000-0000-0000-0000-000000000000",
  "url": "https://example.com",
  "stack": {
    "id": 1,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "slug": "string",
    "url": "https://example.com",
    "change_url": "string",
    "extracts_url": "string",
    "issues_url": "string",
    "overview_url": "string",
    "permissions": "string"
  },
  "auth": 1,
  "auth_change_url": "string",
  "app_label": "string",
  "name": "string",
  "slug": "string",
  "description": "string",
  "enabled": true,
  "frequency": "string",
  "next_run": "2024-01-01T00:00:00Z",
  "last_fetch": "2024-01-01T00:00:00Z",
  "absolute_url": "string",
  "change_url": "string",
  "extracts_url": "string",
  "fetch_url": "string",
  "overview_url": "string",
  "schema_mapping_url": "string",
  "issues_url": "string",
  "transformers": [
    {
      "id": 1,
      "name": "string",
      "stack": 1,
      "change_url": "string",
      "smart_naming_convention": {
        "id": 1,
        "column_name": "string",
        "datastream_names": "string",
        "delimiters_characters": "string",
        "sorted_columns_names": "string",
        "email_for_error": true,
        "email_for_warning": true,
        "raise_for_warning": true,
        "add_status_columns": true,
        "columns_rule_phrasing": "string"
      }
    }
  ],
  "schedules": [
    {
      "id": 1,
      "cron_preset": "ONCE",
      "cron_type": "string",
      "cron_interval": 1,
      "cron_start_of_day": "string",
      "cron_interval_start": 1,
      "time_range_preset": 0,
      "time_range_preset_label": "string",
      "delta_type": 0,
      "delta_interval": 1,
      "delta_start_of_day": "string",
      "delta_interval_start": 1,
      "fixed_start": "2024-01-01",
      "fixed_end": "2024-01-01",
      "offset_days": 1,
      "not_before_date": "2024-01-01",
      "not_before_time": "string"
    }
  ],
  "datastream_type_id": 1,
  "datastream_type_name": "string",
  "datastream_type_slug": "string",
  "datatype": "Live",
  "actions": "string",
  "overwrite_key_columns": true,
  "manage_extract_names": true,
  "extract_name_keys": "string",
  "retention_type": 1,
  "retention_number": 1,
  "remove_if_empty": true,
  "skip_empty_rows": true,
  "prune_instantly": true,
  "overwrite_datastream": true,
  "overwrite_filename": true,
  "logo_url": "string",
  "extracts_stream_url": "string",
  "active_destination": "string",
  "supports_passive_destinations": true,
  "passive_destinations": "string",
  "columns": "https://example.com",
  "supports_extended_intervals": "string",
  "updated": "2024-01-01T00:00:00Z",
  "created": "2024-01-01T00:00:00Z",
  "creator": "string",
  "has_schema_mapping": true,
  "is_insights_mediaplan": true,
  "cron_type": "string",
  "cron_interval": 1,
  "cron_start_of_day": "string",
  "cron_interval_start": 1,
  "time_range_preset": 0,
  "delta_interval": 1,
  "delta_interval_start": 1,
  "delta_start_of_day": "string",
  "delta_type": 0,
  "time_range_max": "string",
  "time_range_available": "string",
  "has_schema_mapping_dimension": true,
  "feature_smart_naming_convention": "string",
  "auto_fetch": "string",
  "assigned_destinations": [
    {
      "target_id": 1,
      "destination_name": "string",
      "destination_type": "string",
      "enabled": true,
      "destination_settings": {
        "key": null
      }
    }
  ],
  "can_be_fetched": true
}

Replace datastreams

PUT/api/datastreams/{id}/

API key permissionDatastream: Writedatastream:write

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream.

Request bodyrequired

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object APIDatastreamFull

• stack_idintegerrequiredwrite-only
• authintegernullable

  Which authorization the datastream uses.

• namestringrequired

  A human readable name. Numbers and special characters are supported.

  Max length 150

• descriptionstring

  Max length 1000

• enabledboolean

  Streams that are not scheduled will not be fetched automatically.

• transformer_idsarray of integerrequiredwrite-only
• datatypestring

  Projection of destination state: reads Live if any destination is enabled, otherwise Staging. Writing 'Live' enables all destinations and 'Staging' disables them.

  • Live - Live
  • Staging - Staging

  One of Live Staging

• overwrite_key_columnsboolean

  Overwrite rows according to Key defined in Data Mapping.

• manage_extract_namesboolean

  Split by selected date column and name extracts with pre-defined pattern to consolidate data.

• extract_name_keysstringnullable

  Max length 128

• retention_typeinteger
  • 1 - Retain all
  • 2 - Retain N fetches
  • 4 - Retain N extracts
  • 3 - Retain N days

  One of 1 2 4 3 · Min 0 · Max 32767

• retention_numberintegernullable

  The amount (N) of fetches/extracts/days to retain (raw extracts are not counted). Must be an integer greater than or equal to zero.

  Min 0 · Max 32767

• remove_if_emptyboolean

  When enabled, fetches resulting in only empty rows ("empty extracts") will be silently discarded.

• skip_empty_rowsboolean

  When enabled, empty data rows in fetches will be silently ignored.

• prune_instantlyboolean

  When enabled, deleted files will not be kept for the configured grace period.

• overwrite_datastreamboolean

  Delete/Drop all existing rows (created by this datastream) in the destination before inserting a new import.

• overwrite_filenameboolean

  Overwrite rows from same extract file.

• is_insights_mediaplanboolean

  If checked, generated extracts will be treated as Insights mediaplans.

• cron_typestring
• cron_intervalinteger

  Min 0

• cron_start_of_daystring · time
• cron_interval_startinteger

  Min 0

• time_range_presetinteger
  • 0 - Custom Time Range
  • 13 - Yesterday
  • 10 - Today
  • 11 - Current Week
  • 6 - Current Month
  • 7 - Previous Month
  • 17 - Last Quarter
  • 18 - Last 2 Days
  • 16 - Last 3 Days
  • 23 - Last 4 Days
  • 19 - Last 5 Days
  • 24 - Last 6 Days
  • 4 - Last 7 Days
  • 25 - Last 8 Days
  • 26 - Last 9 Days
  • 22 - Last 10 Days
  • 14 - Last 14 Days
  • 15 - Last 28 Days
  • 2 - Last 30 Days
  • 20 - Last 40 Days
  • 21 - Last 60 Days
  • 5 - Last 90 Days
  • 31 - Last 120 Days
  • 28 - Last 180 Days
  • 3 - Last 365 Days
  • 27 - Last 730 Days
  • 8 - Previous Week
  • 9 - Previous Year
  • 29 - Current Quarter
  • 12 - Current Year
  • 30 - Last Hour
  • 1000 - Lifetime
  • 50 - Tomorrow
  • 51 - Next 2 Days
  • 52 - Next 7 Days
  • 53 - Next 30 Days
  • 54 - Current Week (incl Future Days)
  • 55 - Next Week
  • 56 - Current Month (incl Future Days)
  • 57 - Next Month
  • 58 - Current Year (incl Future Days)
  • 59 - Next Year

  One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59

• delta_intervalinteger

  Min 0

• delta_interval_startinteger

  Min 0

• delta_start_of_daystring · time
• delta_typeinteger
  • 0 - minute(s)
  • 1 - hour(s)
  • 2 - day(s)
  • 3 - week(s)
  • 4 - month(s)
  • 6 - quarters(s)
  • 5 - year(s)
  • 7 - once

  One of 0 1 2 3 4 6 5 7

Responses

200OKapplication/json

Response schema

object APIDatastreamFull

• idintegerrequiredread-only
• uuidstring · uuidrequiredread-only
• urlstring · urirequiredread-only
• stackobjectrequiredread-only
  Attributes · StackBasic

  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • namestringrequired

    Max length 60

  • slugstringrequiredread-only
  • urlstring · urirequiredread-only
  • change_urlstringrequiredread-only
  • extracts_urlstringrequiredread-only
  • issues_urlstringrequiredread-only
  • overview_urlstringrequiredread-only
  • permissionsstringrequiredread-only
• authintegernullable

  Which authorization the datastream uses.

• auth_change_urlstringrequiredread-only
• app_labelstringrequiredread-only
• namestringrequired

  A human readable name. Numbers and special characters are supported.

  Max length 150

• slugstringrequiredread-only
• descriptionstring

  Max length 1000

• enabledboolean

  Streams that are not scheduled will not be fetched automatically.

• frequencystringrequiredread-only
• next_runstring · date-timerequiredread-only
• last_fetchstring · date-timerequiredread-only
• absolute_urlstringrequiredread-only
• change_urlstringrequiredread-only
• extracts_urlstringrequiredread-only
• fetch_urlstringrequiredread-only
• overview_urlstringrequiredread-only
• schema_mapping_urlstringrequiredread-only
• issues_urlstringrequiredread-only
• transformersarray of objectrequiredread-only
  Items · TransformerBasic

  • idintegerrequiredread-only
  • namestringrequired

    Max length 200

  • stackintegernullable
  • change_urlstringrequiredread-only
  • smart_naming_conventionobjectrequiredread-only
    Attributes · SmartNamingConventionSummary

    • idintegerrequiredread-only
    • column_namestringrequiredread-only
    • datastream_namesstringrequiredread-only
    • delimiters_charactersstringrequiredread-only
    • sorted_columns_namesstringrequiredread-only
    • email_for_errorbooleanrequired
    • email_for_warningbooleanrequired
    • raise_for_warningbooleanrequired
    • add_status_columnsbooleanrequired
    • columns_rule_phrasingstringrequiredread-only
• schedulesarray of objectrequiredread-only
  Items · FetchSchedule

  • idintegerrequiredread-only
  • cron_presetstring
    • ONCE - Once
    • CRON_EVERY_DAY - Every day
    • CRON_EVERY_WEEK - Every week
    • CRON_EVERY_MONTH - Every month
    • CRON_EVERY_QUARTER - Every quarter
    • CRON_EVERY_15_MINUTES - Every 15 minutes
    • CRON_EVERY_30_MINUTES - Every 30 minutes
    • CRON_EVERY_HOUR - Every hour
    • CRON_EVERY_2_HOURS - Every 2 hours
    • CRON_EVERY_3_HOURS - Every 3 hours
    • CRON_EVERY_4_HOURS - Every 4 hours
    • CRON_EVERY_5_HOURS - Every 5 hours
    • CRON_EVERY_6_HOURS - Every 6 hours
    • CRON_EVERY_8_HOURS - Every 8 hours
    • CRON_EVERY_12_HOURS - Every 12 hours
    • CRON_EVERY_2_DAYS - Every 2 days
    • CRON_EVERY_30_DAYS - Every 30 days
    • CRON_EVERY_40_DAYS - Every 40 days
    • CRON_EVERY_2_WEEKS - Every 2 weeks
    • CRON_EVERY_4_WEEKS - Every 4 weeks
    • CRON_EVERY_6_MONTHS - Every 6 months
    • CRON_EVERY_YEAR - Every year

    One of ONCE CRON_EVERY_DAY CRON_EVERY_WEEK CRON_EVERY_MONTH CRON_EVERY_QUARTER CRON_EVERY_15_MINUTES CRON_EVERY_30_MINUTES CRON_EVERY_HOUR CRON_EVERY_2_HOURS CRON_EVERY_3_HOURS CRON_EVERY_4_HOURS CRON_EVERY_5_HOURS CRON_EVERY_6_HOURS CRON_EVERY_8_HOURS CRON_EVERY_12_HOURS CRON_EVERY_2_DAYS CRON_EVERY_30_DAYS CRON_EVERY_40_DAYS CRON_EVERY_2_WEEKS CRON_EVERY_4_WEEKS CRON_EVERY_6_MONTHS CRON_EVERY_YEAR

  • cron_typestring

    Defaults to 'day' when omitted on a schedule entry.

  • cron_intervalinteger

    Min 0 · Max 2147483647

  • cron_start_of_daystring · time

    At what time the day starts.

  • cron_interval_startinteger

    Min 0 · Max 32767

  • time_range_presetinteger

    Select one of the time range presets.

    • 0 - Custom Time Range
    • 13 - Yesterday
    • 10 - Today
    • 11 - Current Week
    • 6 - Current Month
    • 7 - Previous Month
    • 17 - Last Quarter
    • 18 - Last 2 Days
    • 16 - Last 3 Days
    • 23 - Last 4 Days
    • 19 - Last 5 Days
    • 24 - Last 6 Days
    • 4 - Last 7 Days
    • 25 - Last 8 Days
    • 26 - Last 9 Days
    • 22 - Last 10 Days
    • 14 - Last 14 Days
    • 15 - Last 28 Days
    • 2 - Last 30 Days
    • 20 - Last 40 Days
    • 21 - Last 60 Days
    • 5 - Last 90 Days
    • 31 - Last 120 Days
    • 28 - Last 180 Days
    • 3 - Last 365 Days
    • 27 - Last 730 Days
    • 8 - Previous Week
    • 9 - Previous Year
    • 29 - Current Quarter
    • 12 - Current Year
    • 30 - Last Hour
    • 1000 - Lifetime
    • 50 - Tomorrow
    • 51 - Next 2 Days
    • 52 - Next 7 Days
    • 53 - Next 30 Days
    • 54 - Current Week (incl Future Days)
    • 55 - Next Week
    • 56 - Current Month (incl Future Days)
    • 57 - Next Month
    • 58 - Current Year (incl Future Days)
    • 59 - Next Year

    One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59 · Min 0 · Max 32767

  • time_range_preset_labelstringrequiredread-only
  • delta_typeinteger
    • 0 - minute(s)
    • 1 - hour(s)
    • 2 - day(s)
    • 3 - week(s)
    • 4 - month(s)
    • 6 - quarters(s)
    • 5 - year(s)
    • 7 - once

    One of 0 1 2 3 4 6 5 7 · Min -32768 · Max 32767

  • delta_intervalinteger

    Min 0 · Max 2147483647

  • delta_start_of_daystring · time

    At what time the day starts.

  • delta_interval_startinteger

    Min 0 · Max 32767

  • fixed_startstring · datenullable

    First day to fetch.

  • fixed_endstring · datenullable

    Last day to fetch.

  • offset_daysinteger

    Number of days to shift the fetched date range into the past.

    Min -32768 · Max 32767

  • not_before_datestring · datenullable

    Do not fetch before this date.

  • not_before_timestring · timenullable

    Do not fetch before this time.

• datastream_type_idintegerrequiredread-only
• datastream_type_namestringrequiredread-only
• datastream_type_slugstringrequiredread-only
• datatypestring

  Projection of destination state: reads Live if any destination is enabled, otherwise Staging. Writing 'Live' enables all destinations and 'Staging' disables them.

  • Live - Live
  • Staging - Staging

  One of Live Staging

• actionsstringrequiredread-only
• overwrite_key_columnsboolean

  Overwrite rows according to Key defined in Data Mapping.

• manage_extract_namesboolean

  Split by selected date column and name extracts with pre-defined pattern to consolidate data.

• extract_name_keysstringnullable

  Max length 128

• retention_typeinteger
  • 1 - Retain all
  • 2 - Retain N fetches
  • 4 - Retain N extracts
  • 3 - Retain N days

  One of 1 2 4 3 · Min 0 · Max 32767

• retention_numberintegernullable

  The amount (N) of fetches/extracts/days to retain (raw extracts are not counted). Must be an integer greater than or equal to zero.

  Min 0 · Max 32767

• remove_if_emptyboolean

  When enabled, fetches resulting in only empty rows ("empty extracts") will be silently discarded.

• skip_empty_rowsboolean

  When enabled, empty data rows in fetches will be silently ignored.

• prune_instantlyboolean

  When enabled, deleted files will not be kept for the configured grace period.

• overwrite_datastreamboolean

  Delete/Drop all existing rows (created by this datastream) in the destination before inserting a new import.

• overwrite_filenameboolean

  Overwrite rows from same extract file.

• logo_urlstringrequiredread-only
• extracts_stream_urlstringrequiredread-only
• active_destinationstringrequiredread-only
• supports_passive_destinationsbooleanrequiredread-only
• passive_destinationsstringrequiredread-only
• columnsstring · urirequiredread-only
• supports_extended_intervalsstringrequiredread-only
• updatedstring · date-timerequiredread-only
• createdstring · date-timerequiredread-only
• creatorstringrequiredread-onlynullable
• has_schema_mappingbooleanrequiredread-only
• is_insights_mediaplanboolean

  If checked, generated extracts will be treated as Insights mediaplans.

• cron_typestring
• cron_intervalinteger

  Min 0

• cron_start_of_daystring · time
• cron_interval_startinteger

  Min 0

• time_range_presetinteger
  • 0 - Custom Time Range
  • 13 - Yesterday
  • 10 - Today
  • 11 - Current Week
  • 6 - Current Month
  • 7 - Previous Month
  • 17 - Last Quarter
  • 18 - Last 2 Days
  • 16 - Last 3 Days
  • 23 - Last 4 Days
  • 19 - Last 5 Days
  • 24 - Last 6 Days
  • 4 - Last 7 Days
  • 25 - Last 8 Days
  • 26 - Last 9 Days
  • 22 - Last 10 Days
  • 14 - Last 14 Days
  • 15 - Last 28 Days
  • 2 - Last 30 Days
  • 20 - Last 40 Days
  • 21 - Last 60 Days
  • 5 - Last 90 Days
  • 31 - Last 120 Days
  • 28 - Last 180 Days
  • 3 - Last 365 Days
  • 27 - Last 730 Days
  • 8 - Previous Week
  • 9 - Previous Year
  • 29 - Current Quarter
  • 12 - Current Year
  • 30 - Last Hour
  • 1000 - Lifetime
  • 50 - Tomorrow
  • 51 - Next 2 Days
  • 52 - Next 7 Days
  • 53 - Next 30 Days
  • 54 - Current Week (incl Future Days)
  • 55 - Next Week
  • 56 - Current Month (incl Future Days)
  • 57 - Next Month
  • 58 - Current Year (incl Future Days)
  • 59 - Next Year

  One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59

• delta_intervalinteger

  Min 0

• delta_interval_startinteger

  Min 0

• delta_start_of_daystring · time
• delta_typeinteger
  • 0 - minute(s)
  • 1 - hour(s)
  • 2 - day(s)
  • 3 - week(s)
  • 4 - month(s)
  • 6 - quarters(s)
  • 5 - year(s)
  • 7 - once

  One of 0 1 2 3 4 6 5 7

• time_range_maxstringrequiredread-only
• time_range_availablestringrequiredread-only
• has_schema_mapping_dimensionbooleanrequiredread-only
• feature_smart_naming_conventionstringrequiredread-only
• auto_fetchstringrequiredread-only
• assigned_destinationsarray of objectrequiredread-only
  Items · AssignedDestination

  • target_idintegerrequiredread-only
  • destination_namestringrequiredread-only
  • destination_typestringrequiredread-only
  • enabledbooleanrequiredread-only
  • destination_settingsobjectrequiredread-only
• can_be_fetchedbooleanrequiredread-only

RequestcURL

curl --request PUT 'https://{{INSTANCE}}/api/datastreams/{id}/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "stack_id": 1,
    "auth": 1,
    "name": "string",
    "description": "string",
    "enabled": true,
    "transformer_ids": [
      1
    ],
    "datatype": "Live",
    "overwrite_key_columns": true,
    "manage_extract_names": true,
    "extract_name_keys": "string",
    "retention_type": 1,
    "retention_number": 1,
    "remove_if_empty": true,
    "skip_empty_rows": true,
    "prune_instantly": true,
    "overwrite_datastream": true,
    "overwrite_filename": true,
    "is_insights_mediaplan": true,
    "cron_type": "string",
    "cron_interval": 1,
    "cron_start_of_day": "string",
    "cron_interval_start": 1,
    "time_range_preset": 0,
    "delta_interval": 1,
    "delta_interval_start": 1,
    "delta_start_of_day": "string",
    "delta_type": 0
  }'

Response200

{
  "id": 1,
  "uuid": "00000000-0000-0000-0000-000000000000",
  "url": "https://example.com",
  "stack": {
    "id": 1,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "slug": "string",
    "url": "https://example.com",
    "change_url": "string",
    "extracts_url": "string",
    "issues_url": "string",
    "overview_url": "string",
    "permissions": "string"
  },
  "auth": 1,
  "auth_change_url": "string",
  "app_label": "string",
  "name": "string",
  "slug": "string",
  "description": "string",
  "enabled": true,
  "frequency": "string",
  "next_run": "2024-01-01T00:00:00Z",
  "last_fetch": "2024-01-01T00:00:00Z",
  "absolute_url": "string",
  "change_url": "string",
  "extracts_url": "string",
  "fetch_url": "string",
  "overview_url": "string",
  "schema_mapping_url": "string",
  "issues_url": "string",
  "transformers": [
    {
      "id": 1,
      "name": "string",
      "stack": 1,
      "change_url": "string",
      "smart_naming_convention": {
        "id": 1,
        "column_name": "string",
        "datastream_names": "string",
        "delimiters_characters": "string",
        "sorted_columns_names": "string",
        "email_for_error": true,
        "email_for_warning": true,
        "raise_for_warning": true,
        "add_status_columns": true,
        "columns_rule_phrasing": "string"
      }
    }
  ],
  "schedules": [
    {
      "id": 1,
      "cron_preset": "ONCE",
      "cron_type": "string",
      "cron_interval": 1,
      "cron_start_of_day": "string",
      "cron_interval_start": 1,
      "time_range_preset": 0,
      "time_range_preset_label": "string",
      "delta_type": 0,
      "delta_interval": 1,
      "delta_start_of_day": "string",
      "delta_interval_start": 1,
      "fixed_start": "2024-01-01",
      "fixed_end": "2024-01-01",
      "offset_days": 1,
      "not_before_date": "2024-01-01",
      "not_before_time": "string"
    }
  ],
  "datastream_type_id": 1,
  "datastream_type_name": "string",
  "datastream_type_slug": "string",
  "datatype": "Live",
  "actions": "string",
  "overwrite_key_columns": true,
  "manage_extract_names": true,
  "extract_name_keys": "string",
  "retention_type": 1,
  "retention_number": 1,
  "remove_if_empty": true,
  "skip_empty_rows": true,
  "prune_instantly": true,
  "overwrite_datastream": true,
  "overwrite_filename": true,
  "logo_url": "string",
  "extracts_stream_url": "string",
  "active_destination": "string",
  "supports_passive_destinations": true,
  "passive_destinations": "string",
  "columns": "https://example.com",
  "supports_extended_intervals": "string",
  "updated": "2024-01-01T00:00:00Z",
  "created": "2024-01-01T00:00:00Z",
  "creator": "string",
  "has_schema_mapping": true,
  "is_insights_mediaplan": true,
  "cron_type": "string",
  "cron_interval": 1,
  "cron_start_of_day": "string",
  "cron_interval_start": 1,
  "time_range_preset": 0,
  "delta_interval": 1,
  "delta_interval_start": 1,
  "delta_start_of_day": "string",
  "delta_type": 0,
  "time_range_max": "string",
  "time_range_available": "string",
  "has_schema_mapping_dimension": true,
  "feature_smart_naming_convention": "string",
  "auto_fetch": "string",
  "assigned_destinations": [
    {
      "target_id": 1,
      "destination_name": "string",
      "destination_type": "string",
      "enabled": true,
      "destination_settings": {
        "key": null
      }
    }
  ],
  "can_be_fetched": true
}

Update datastreams

PATCH/api/datastreams/{id}/

API key permissionDatastream: Writedatastream:write

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream.

Request body

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object PatchedAPIDatastreamFull

• stack_idintegerwrite-only
• authintegernullable

  Which authorization the datastream uses.

• namestring

  A human readable name. Numbers and special characters are supported.

  Max length 150

• descriptionstring

  Max length 1000

• enabledboolean

  Streams that are not scheduled will not be fetched automatically.

• transformer_idsarray of integerwrite-only
• datatypestring

  Projection of destination state: reads Live if any destination is enabled, otherwise Staging. Writing 'Live' enables all destinations and 'Staging' disables them.

  • Live - Live
  • Staging - Staging

  One of Live Staging

• overwrite_key_columnsboolean

  Overwrite rows according to Key defined in Data Mapping.

• manage_extract_namesboolean

  Split by selected date column and name extracts with pre-defined pattern to consolidate data.

• extract_name_keysstringnullable

  Max length 128

• retention_typeinteger
  • 1 - Retain all
  • 2 - Retain N fetches
  • 4 - Retain N extracts
  • 3 - Retain N days

  One of 1 2 4 3 · Min 0 · Max 32767

• retention_numberintegernullable

  The amount (N) of fetches/extracts/days to retain (raw extracts are not counted). Must be an integer greater than or equal to zero.

  Min 0 · Max 32767

• remove_if_emptyboolean

  When enabled, fetches resulting in only empty rows ("empty extracts") will be silently discarded.

• skip_empty_rowsboolean

  When enabled, empty data rows in fetches will be silently ignored.

• prune_instantlyboolean

  When enabled, deleted files will not be kept for the configured grace period.

• overwrite_datastreamboolean

  Delete/Drop all existing rows (created by this datastream) in the destination before inserting a new import.

• overwrite_filenameboolean

  Overwrite rows from same extract file.

• is_insights_mediaplanboolean

  If checked, generated extracts will be treated as Insights mediaplans.

• cron_typestring
• cron_intervalinteger

  Min 0

• cron_start_of_daystring · time
• cron_interval_startinteger

  Min 0

• time_range_presetinteger
  • 0 - Custom Time Range
  • 13 - Yesterday
  • 10 - Today
  • 11 - Current Week
  • 6 - Current Month
  • 7 - Previous Month
  • 17 - Last Quarter
  • 18 - Last 2 Days
  • 16 - Last 3 Days
  • 23 - Last 4 Days
  • 19 - Last 5 Days
  • 24 - Last 6 Days
  • 4 - Last 7 Days
  • 25 - Last 8 Days
  • 26 - Last 9 Days
  • 22 - Last 10 Days
  • 14 - Last 14 Days
  • 15 - Last 28 Days
  • 2 - Last 30 Days
  • 20 - Last 40 Days
  • 21 - Last 60 Days
  • 5 - Last 90 Days
  • 31 - Last 120 Days
  • 28 - Last 180 Days
  • 3 - Last 365 Days
  • 27 - Last 730 Days
  • 8 - Previous Week
  • 9 - Previous Year
  • 29 - Current Quarter
  • 12 - Current Year
  • 30 - Last Hour
  • 1000 - Lifetime
  • 50 - Tomorrow
  • 51 - Next 2 Days
  • 52 - Next 7 Days
  • 53 - Next 30 Days
  • 54 - Current Week (incl Future Days)
  • 55 - Next Week
  • 56 - Current Month (incl Future Days)
  • 57 - Next Month
  • 58 - Current Year (incl Future Days)
  • 59 - Next Year

  One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59

• delta_intervalinteger

  Min 0

• delta_interval_startinteger

  Min 0

• delta_start_of_daystring · time
• delta_typeinteger
  • 0 - minute(s)
  • 1 - hour(s)
  • 2 - day(s)
  • 3 - week(s)
  • 4 - month(s)
  • 6 - quarters(s)
  • 5 - year(s)
  • 7 - once

  One of 0 1 2 3 4 6 5 7

Responses

200OKapplication/json

Response schema

object APIDatastreamFull

• idintegerrequiredread-only
• uuidstring · uuidrequiredread-only
• urlstring · urirequiredread-only
• stackobjectrequiredread-only
  Attributes · StackBasic

  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • namestringrequired

    Max length 60

  • slugstringrequiredread-only
  • urlstring · urirequiredread-only
  • change_urlstringrequiredread-only
  • extracts_urlstringrequiredread-only
  • issues_urlstringrequiredread-only
  • overview_urlstringrequiredread-only
  • permissionsstringrequiredread-only
• authintegernullable

  Which authorization the datastream uses.

• auth_change_urlstringrequiredread-only
• app_labelstringrequiredread-only
• namestringrequired

  A human readable name. Numbers and special characters are supported.

  Max length 150

• slugstringrequiredread-only
• descriptionstring

  Max length 1000

• enabledboolean

  Streams that are not scheduled will not be fetched automatically.

• frequencystringrequiredread-only
• next_runstring · date-timerequiredread-only
• last_fetchstring · date-timerequiredread-only
• absolute_urlstringrequiredread-only
• change_urlstringrequiredread-only
• extracts_urlstringrequiredread-only
• fetch_urlstringrequiredread-only
• overview_urlstringrequiredread-only
• schema_mapping_urlstringrequiredread-only
• issues_urlstringrequiredread-only
• transformersarray of objectrequiredread-only
  Items · TransformerBasic

  • idintegerrequiredread-only
  • namestringrequired

    Max length 200

  • stackintegernullable
  • change_urlstringrequiredread-only
  • smart_naming_conventionobjectrequiredread-only
    Attributes · SmartNamingConventionSummary

    • idintegerrequiredread-only
    • column_namestringrequiredread-only
    • datastream_namesstringrequiredread-only
    • delimiters_charactersstringrequiredread-only
    • sorted_columns_namesstringrequiredread-only
    • email_for_errorbooleanrequired
    • email_for_warningbooleanrequired
    • raise_for_warningbooleanrequired
    • add_status_columnsbooleanrequired
    • columns_rule_phrasingstringrequiredread-only
• schedulesarray of objectrequiredread-only
  Items · FetchSchedule

  • idintegerrequiredread-only
  • cron_presetstring
    • ONCE - Once
    • CRON_EVERY_DAY - Every day
    • CRON_EVERY_WEEK - Every week
    • CRON_EVERY_MONTH - Every month
    • CRON_EVERY_QUARTER - Every quarter
    • CRON_EVERY_15_MINUTES - Every 15 minutes
    • CRON_EVERY_30_MINUTES - Every 30 minutes
    • CRON_EVERY_HOUR - Every hour
    • CRON_EVERY_2_HOURS - Every 2 hours
    • CRON_EVERY_3_HOURS - Every 3 hours
    • CRON_EVERY_4_HOURS - Every 4 hours
    • CRON_EVERY_5_HOURS - Every 5 hours
    • CRON_EVERY_6_HOURS - Every 6 hours
    • CRON_EVERY_8_HOURS - Every 8 hours
    • CRON_EVERY_12_HOURS - Every 12 hours
    • CRON_EVERY_2_DAYS - Every 2 days
    • CRON_EVERY_30_DAYS - Every 30 days
    • CRON_EVERY_40_DAYS - Every 40 days
    • CRON_EVERY_2_WEEKS - Every 2 weeks
    • CRON_EVERY_4_WEEKS - Every 4 weeks
    • CRON_EVERY_6_MONTHS - Every 6 months
    • CRON_EVERY_YEAR - Every year

    One of ONCE CRON_EVERY_DAY CRON_EVERY_WEEK CRON_EVERY_MONTH CRON_EVERY_QUARTER CRON_EVERY_15_MINUTES CRON_EVERY_30_MINUTES CRON_EVERY_HOUR CRON_EVERY_2_HOURS CRON_EVERY_3_HOURS CRON_EVERY_4_HOURS CRON_EVERY_5_HOURS CRON_EVERY_6_HOURS CRON_EVERY_8_HOURS CRON_EVERY_12_HOURS CRON_EVERY_2_DAYS CRON_EVERY_30_DAYS CRON_EVERY_40_DAYS CRON_EVERY_2_WEEKS CRON_EVERY_4_WEEKS CRON_EVERY_6_MONTHS CRON_EVERY_YEAR

  • cron_typestring

    Defaults to 'day' when omitted on a schedule entry.

  • cron_intervalinteger

    Min 0 · Max 2147483647

  • cron_start_of_daystring · time

    At what time the day starts.

  • cron_interval_startinteger

    Min 0 · Max 32767

  • time_range_presetinteger

    Select one of the time range presets.

    • 0 - Custom Time Range
    • 13 - Yesterday
    • 10 - Today
    • 11 - Current Week
    • 6 - Current Month
    • 7 - Previous Month
    • 17 - Last Quarter
    • 18 - Last 2 Days
    • 16 - Last 3 Days
    • 23 - Last 4 Days
    • 19 - Last 5 Days
    • 24 - Last 6 Days
    • 4 - Last 7 Days
    • 25 - Last 8 Days
    • 26 - Last 9 Days
    • 22 - Last 10 Days
    • 14 - Last 14 Days
    • 15 - Last 28 Days
    • 2 - Last 30 Days
    • 20 - Last 40 Days
    • 21 - Last 60 Days
    • 5 - Last 90 Days
    • 31 - Last 120 Days
    • 28 - Last 180 Days
    • 3 - Last 365 Days
    • 27 - Last 730 Days
    • 8 - Previous Week
    • 9 - Previous Year
    • 29 - Current Quarter
    • 12 - Current Year
    • 30 - Last Hour
    • 1000 - Lifetime
    • 50 - Tomorrow
    • 51 - Next 2 Days
    • 52 - Next 7 Days
    • 53 - Next 30 Days
    • 54 - Current Week (incl Future Days)
    • 55 - Next Week
    • 56 - Current Month (incl Future Days)
    • 57 - Next Month
    • 58 - Current Year (incl Future Days)
    • 59 - Next Year

    One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59 · Min 0 · Max 32767

  • time_range_preset_labelstringrequiredread-only
  • delta_typeinteger
    • 0 - minute(s)
    • 1 - hour(s)
    • 2 - day(s)
    • 3 - week(s)
    • 4 - month(s)
    • 6 - quarters(s)
    • 5 - year(s)
    • 7 - once

    One of 0 1 2 3 4 6 5 7 · Min -32768 · Max 32767

  • delta_intervalinteger

    Min 0 · Max 2147483647

  • delta_start_of_daystring · time

    At what time the day starts.

  • delta_interval_startinteger

    Min 0 · Max 32767

  • fixed_startstring · datenullable

    First day to fetch.

  • fixed_endstring · datenullable

    Last day to fetch.

  • offset_daysinteger

    Number of days to shift the fetched date range into the past.

    Min -32768 · Max 32767

  • not_before_datestring · datenullable

    Do not fetch before this date.

  • not_before_timestring · timenullable

    Do not fetch before this time.

• datastream_type_idintegerrequiredread-only
• datastream_type_namestringrequiredread-only
• datastream_type_slugstringrequiredread-only
• datatypestring

  Projection of destination state: reads Live if any destination is enabled, otherwise Staging. Writing 'Live' enables all destinations and 'Staging' disables them.

  • Live - Live
  • Staging - Staging

  One of Live Staging

• actionsstringrequiredread-only
• overwrite_key_columnsboolean

  Overwrite rows according to Key defined in Data Mapping.

• manage_extract_namesboolean

  Split by selected date column and name extracts with pre-defined pattern to consolidate data.

• extract_name_keysstringnullable

  Max length 128

• retention_typeinteger
  • 1 - Retain all
  • 2 - Retain N fetches
  • 4 - Retain N extracts
  • 3 - Retain N days

  One of 1 2 4 3 · Min 0 · Max 32767

• retention_numberintegernullable

  The amount (N) of fetches/extracts/days to retain (raw extracts are not counted). Must be an integer greater than or equal to zero.

  Min 0 · Max 32767

• remove_if_emptyboolean

  When enabled, fetches resulting in only empty rows ("empty extracts") will be silently discarded.

• skip_empty_rowsboolean

  When enabled, empty data rows in fetches will be silently ignored.

• prune_instantlyboolean

  When enabled, deleted files will not be kept for the configured grace period.

• overwrite_datastreamboolean

  Delete/Drop all existing rows (created by this datastream) in the destination before inserting a new import.

• overwrite_filenameboolean

  Overwrite rows from same extract file.

• logo_urlstringrequiredread-only
• extracts_stream_urlstringrequiredread-only
• active_destinationstringrequiredread-only
• supports_passive_destinationsbooleanrequiredread-only
• passive_destinationsstringrequiredread-only
• columnsstring · urirequiredread-only
• supports_extended_intervalsstringrequiredread-only
• updatedstring · date-timerequiredread-only
• createdstring · date-timerequiredread-only
• creatorstringrequiredread-onlynullable
• has_schema_mappingbooleanrequiredread-only
• is_insights_mediaplanboolean

  If checked, generated extracts will be treated as Insights mediaplans.

• cron_typestring
• cron_intervalinteger

  Min 0

• cron_start_of_daystring · time
• cron_interval_startinteger

  Min 0

• time_range_presetinteger
  • 0 - Custom Time Range
  • 13 - Yesterday
  • 10 - Today
  • 11 - Current Week
  • 6 - Current Month
  • 7 - Previous Month
  • 17 - Last Quarter
  • 18 - Last 2 Days
  • 16 - Last 3 Days
  • 23 - Last 4 Days
  • 19 - Last 5 Days
  • 24 - Last 6 Days
  • 4 - Last 7 Days
  • 25 - Last 8 Days
  • 26 - Last 9 Days
  • 22 - Last 10 Days
  • 14 - Last 14 Days
  • 15 - Last 28 Days
  • 2 - Last 30 Days
  • 20 - Last 40 Days
  • 21 - Last 60 Days
  • 5 - Last 90 Days
  • 31 - Last 120 Days
  • 28 - Last 180 Days
  • 3 - Last 365 Days
  • 27 - Last 730 Days
  • 8 - Previous Week
  • 9 - Previous Year
  • 29 - Current Quarter
  • 12 - Current Year
  • 30 - Last Hour
  • 1000 - Lifetime
  • 50 - Tomorrow
  • 51 - Next 2 Days
  • 52 - Next 7 Days
  • 53 - Next 30 Days
  • 54 - Current Week (incl Future Days)
  • 55 - Next Week
  • 56 - Current Month (incl Future Days)
  • 57 - Next Month
  • 58 - Current Year (incl Future Days)
  • 59 - Next Year

  One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59

• delta_intervalinteger

  Min 0

• delta_interval_startinteger

  Min 0

• delta_start_of_daystring · time
• delta_typeinteger
  • 0 - minute(s)
  • 1 - hour(s)
  • 2 - day(s)
  • 3 - week(s)
  • 4 - month(s)
  • 6 - quarters(s)
  • 5 - year(s)
  • 7 - once

  One of 0 1 2 3 4 6 5 7

• time_range_maxstringrequiredread-only
• time_range_availablestringrequiredread-only
• has_schema_mapping_dimensionbooleanrequiredread-only
• feature_smart_naming_conventionstringrequiredread-only
• auto_fetchstringrequiredread-only
• assigned_destinationsarray of objectrequiredread-only
  Items · AssignedDestination

  • target_idintegerrequiredread-only
  • destination_namestringrequiredread-only
  • destination_typestringrequiredread-only
  • enabledbooleanrequiredread-only
  • destination_settingsobjectrequiredread-only
• can_be_fetchedbooleanrequiredread-only

RequestcURL

curl --request PATCH 'https://{{INSTANCE}}/api/datastreams/{id}/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "stack_id": 1,
    "auth": 1,
    "name": "string",
    "description": "string",
    "enabled": true,
    "transformer_ids": [
      1
    ],
    "datatype": "Live",
    "overwrite_key_columns": true,
    "manage_extract_names": true,
    "extract_name_keys": "string",
    "retention_type": 1,
    "retention_number": 1,
    "remove_if_empty": true,
    "skip_empty_rows": true,
    "prune_instantly": true,
    "overwrite_datastream": true,
    "overwrite_filename": true,
    "is_insights_mediaplan": true,
    "cron_type": "string",
    "cron_interval": 1,
    "cron_start_of_day": "string",
    "cron_interval_start": 1,
    "time_range_preset": 0,
    "delta_interval": 1,
    "delta_interval_start": 1,
    "delta_start_of_day": "string",
    "delta_type": 0
  }'

Response200

{
  "id": 1,
  "uuid": "00000000-0000-0000-0000-000000000000",
  "url": "https://example.com",
  "stack": {
    "id": 1,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "slug": "string",
    "url": "https://example.com",
    "change_url": "string",
    "extracts_url": "string",
    "issues_url": "string",
    "overview_url": "string",
    "permissions": "string"
  },
  "auth": 1,
  "auth_change_url": "string",
  "app_label": "string",
  "name": "string",
  "slug": "string",
  "description": "string",
  "enabled": true,
  "frequency": "string",
  "next_run": "2024-01-01T00:00:00Z",
  "last_fetch": "2024-01-01T00:00:00Z",
  "absolute_url": "string",
  "change_url": "string",
  "extracts_url": "string",
  "fetch_url": "string",
  "overview_url": "string",
  "schema_mapping_url": "string",
  "issues_url": "string",
  "transformers": [
    {
      "id": 1,
      "name": "string",
      "stack": 1,
      "change_url": "string",
      "smart_naming_convention": {
        "id": 1,
        "column_name": "string",
        "datastream_names": "string",
        "delimiters_characters": "string",
        "sorted_columns_names": "string",
        "email_for_error": true,
        "email_for_warning": true,
        "raise_for_warning": true,
        "add_status_columns": true,
        "columns_rule_phrasing": "string"
      }
    }
  ],
  "schedules": [
    {
      "id": 1,
      "cron_preset": "ONCE",
      "cron_type": "string",
      "cron_interval": 1,
      "cron_start_of_day": "string",
      "cron_interval_start": 1,
      "time_range_preset": 0,
      "time_range_preset_label": "string",
      "delta_type": 0,
      "delta_interval": 1,
      "delta_start_of_day": "string",
      "delta_interval_start": 1,
      "fixed_start": "2024-01-01",
      "fixed_end": "2024-01-01",
      "offset_days": 1,
      "not_before_date": "2024-01-01",
      "not_before_time": "string"
    }
  ],
  "datastream_type_id": 1,
  "datastream_type_name": "string",
  "datastream_type_slug": "string",
  "datatype": "Live",
  "actions": "string",
  "overwrite_key_columns": true,
  "manage_extract_names": true,
  "extract_name_keys": "string",
  "retention_type": 1,
  "retention_number": 1,
  "remove_if_empty": true,
  "skip_empty_rows": true,
  "prune_instantly": true,
  "overwrite_datastream": true,
  "overwrite_filename": true,
  "logo_url": "string",
  "extracts_stream_url": "string",
  "active_destination": "string",
  "supports_passive_destinations": true,
  "passive_destinations": "string",
  "columns": "https://example.com",
  "supports_extended_intervals": "string",
  "updated": "2024-01-01T00:00:00Z",
  "created": "2024-01-01T00:00:00Z",
  "creator": "string",
  "has_schema_mapping": true,
  "is_insights_mediaplan": true,
  "cron_type": "string",
  "cron_interval": 1,
  "cron_start_of_day": "string",
  "cron_interval_start": 1,
  "time_range_preset": 0,
  "delta_interval": 1,
  "delta_interval_start": 1,
  "delta_start_of_day": "string",
  "delta_type": 0,
  "time_range_max": "string",
  "time_range_available": "string",
  "has_schema_mapping_dimension": true,
  "feature_smart_naming_convention": "string",
  "auto_fetch": "string",
  "assigned_destinations": [
    {
      "target_id": 1,
      "destination_name": "string",
      "destination_type": "string",
      "enabled": true,
      "destination_settings": {
        "key": null
      }
    }
  ],
  "can_be_fetched": true
}

Get datastreams columns (GET /api/datastreams/{id}/columns/)

GET/api/datastreams/{id}/columns/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream.

Responses

200OKapplication/json

Response schema

object DatastreamColumnInfo

• datatypestringrequired
• idintegerrequiredread-only
• change_urlstringrequiredread-only
• createdstring · date-timerequiredread-only
• is_key_columnboolean

  If checked, this column will be used to consolidate multiple files.

• confirmed_typeboolean

  If checked the type will not be changed by the tracking service.

• namestringrequired

  Max length 200

• typeinteger
  • 1 - String
  • 2 - Long
  • 3 - Float
  • 4 - Date
  • 5 - DateTime
  • 6 - Boolean
  • 7 - Percentage
  • 9 - Currency
  • 8 - JSON
  • 10 - Formula
  • 11 - Duration
  • 13 - Timestamp

  One of 1 2 3 4 5 6 7 9 8 10 11 13 · Min 0 · Max 32767

• removedboolean
• target_columnobjectnullable
  Attributes

  • ReadOnlySchemaColumn

    • idintegerrequired
    • namestringrequiredread-only

      Max length 200

    • typestringrequiredread-only
    • usagestringrequired
    • measureone of
      Attributes

      • MeasureEnum

      • BlankEnum

      • NullEnum

  • null

• updatedstring · date-timerequiredread-only
• has_smart_naming_conventionstringrequiredread-only

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/datastreams/{id}/columns/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "datatype": "string",
  "id": 1,
  "change_url": "string",
  "created": "2024-01-01T00:00:00Z",
  "is_key_column": true,
  "confirmed_type": true,
  "name": "string",
  "type": 1,
  "removed": true,
  "target_column": {
    "id": 1,
    "name": "string",
    "type": "string",
    "usage": "string",
    "measure": "SUM"
  },
  "updated": "2024-01-01T00:00:00Z",
  "has_smart_naming_convention": "string"
}

Create datastreams columns

POST/api/datastreams/{id}/columns/

API key permissionDatastream: Writedatastream:write

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream.

Request bodyrequired

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object DatastreamColumnInfo

• datatypestringrequired
• is_key_columnboolean

  If checked, this column will be used to consolidate multiple files.

• confirmed_typeboolean

  If checked the type will not be changed by the tracking service.

• namestringrequired

  Max length 200

• typeinteger
  • 1 - String
  • 2 - Long
  • 3 - Float
  • 4 - Date
  • 5 - DateTime
  • 6 - Boolean
  • 7 - Percentage
  • 9 - Currency
  • 8 - JSON
  • 10 - Formula
  • 11 - Duration
  • 13 - Timestamp

  One of 1 2 3 4 5 6 7 9 8 10 11 13 · Min 0 · Max 32767

• removedboolean
• target_columnobjectnullable
  Attributes

  • ReadOnlySchemaColumn

    • idintegerrequired
    • usagestringrequired
    • measureone of
      Attributes

      • MeasureEnum

      • BlankEnum

      • NullEnum

  • null

• set_defaultbooleanwrite-only

  Default false

• reset_defaultbooleanwrite-only

  Default false

• unlock_typebooleanwrite-only

  Default false

Responses

200OKapplication/json

Response schema

object DatastreamColumnInfo

• datatypestringrequired
• idintegerrequiredread-only
• change_urlstringrequiredread-only
• createdstring · date-timerequiredread-only
• is_key_columnboolean

  If checked, this column will be used to consolidate multiple files.

• confirmed_typeboolean

  If checked the type will not be changed by the tracking service.

• namestringrequired

  Max length 200

• typeinteger
  • 1 - String
  • 2 - Long
  • 3 - Float
  • 4 - Date
  • 5 - DateTime
  • 6 - Boolean
  • 7 - Percentage
  • 9 - Currency
  • 8 - JSON
  • 10 - Formula
  • 11 - Duration
  • 13 - Timestamp

  One of 1 2 3 4 5 6 7 9 8 10 11 13 · Min 0 · Max 32767

• removedboolean
• target_columnobjectnullable
  Attributes

  • ReadOnlySchemaColumn

    • idintegerrequired
    • namestringrequiredread-only

      Max length 200

    • typestringrequiredread-only
    • usagestringrequired
    • measureone of
      Attributes

      • MeasureEnum

      • BlankEnum

      • NullEnum

  • null

• updatedstring · date-timerequiredread-only
• has_smart_naming_conventionstringrequiredread-only

RequestcURL

curl --request POST 'https://{{INSTANCE}}/api/datastreams/{id}/columns/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "datatype": "string",
    "is_key_column": true,
    "confirmed_type": true,
    "name": "string",
    "type": 1,
    "removed": true,
    "target_column": {
      "id": 1,
      "usage": "string",
      "measure": "SUM"
    },
    "set_default": false,
    "reset_default": false,
    "unlock_type": false
  }'

Response200

{
  "datatype": "string",
  "id": 1,
  "change_url": "string",
  "created": "2024-01-01T00:00:00Z",
  "is_key_column": true,
  "confirmed_type": true,
  "name": "string",
  "type": 1,
  "removed": true,
  "target_column": {
    "id": 1,
    "name": "string",
    "type": "string",
    "usage": "string",
    "measure": "SUM"
  },
  "updated": "2024-01-01T00:00:00Z",
  "has_smart_naming_convention": "string"
}

Replace datastreams columns map

PUT/api/datastreams/{id}/columns/map/

API key permissionDatastream: Writedatastream:write

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream.

Request bodyrequired

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object DatastreamMapping

• schema_columnstringrequired

  Max length 200

• source_columnstringrequired

  Max length 200

• is_key_columnboolean

Responses

200OKapplication/json

Response schema

object DatastreamMapping

• schema_columnstringrequired

  Max length 200

• source_columnstringrequired

  Max length 200

• is_key_columnboolean

RequestcURL

curl --request PUT 'https://{{INSTANCE}}/api/datastreams/{id}/columns/map/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "schema_column": "string",
    "source_column": "string",
    "is_key_column": true
  }'

Response200

{
  "schema_column": "string",
  "source_column": "string",
  "is_key_column": true
}

Get datastreams columns (GET /api/datastreams/{id}/columns/{cid}/)

GET/api/datastreams/{id}/columns/{cid}/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• cidstringrequired

  Pattern ^[0-9]+$

• idintegerrequired

  A unique integer value identifying this Datastream.

Responses

200OKapplication/json

Response schema

object DatastreamColumnInfo

• datatypestringrequired
• idintegerrequiredread-only
• change_urlstringrequiredread-only
• createdstring · date-timerequiredread-only
• is_key_columnboolean

  If checked, this column will be used to consolidate multiple files.

• confirmed_typeboolean

  If checked the type will not be changed by the tracking service.

• namestringrequired

  Max length 200

• typeinteger
  • 1 - String
  • 2 - Long
  • 3 - Float
  • 4 - Date
  • 5 - DateTime
  • 6 - Boolean
  • 7 - Percentage
  • 9 - Currency
  • 8 - JSON
  • 10 - Formula
  • 11 - Duration
  • 13 - Timestamp

  One of 1 2 3 4 5 6 7 9 8 10 11 13 · Min 0 · Max 32767

• removedboolean
• target_columnobjectnullable
  Attributes

  • ReadOnlySchemaColumn

    • idintegerrequired
    • namestringrequiredread-only

      Max length 200

    • typestringrequiredread-only
    • usagestringrequired
    • measureone of
      Attributes

      • MeasureEnum

      • BlankEnum

      • NullEnum

  • null

• updatedstring · date-timerequiredread-only
• has_smart_naming_conventionstringrequiredread-only

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/datastreams/{id}/columns/{cid}/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "datatype": "string",
  "id": 1,
  "change_url": "string",
  "created": "2024-01-01T00:00:00Z",
  "is_key_column": true,
  "confirmed_type": true,
  "name": "string",
  "type": 1,
  "removed": true,
  "target_column": {
    "id": 1,
    "name": "string",
    "type": "string",
    "usage": "string",
    "measure": "SUM"
  },
  "updated": "2024-01-01T00:00:00Z",
  "has_smart_naming_convention": "string"
}

Update datastreams columns

PATCH/api/datastreams/{id}/columns/{cid}/

API key permissionDatastream: Writedatastream:write

Path parameters

• cidstringrequired

  Pattern ^[0-9]+$

• idintegerrequired

  A unique integer value identifying this Datastream.

Request body

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object PatchedDatastreamColumnInfo

• datatypestring
• is_key_columnboolean

  If checked, this column will be used to consolidate multiple files.

• confirmed_typeboolean

  If checked the type will not be changed by the tracking service.

• namestring

  Max length 200

• typeinteger
  • 1 - String
  • 2 - Long
  • 3 - Float
  • 4 - Date
  • 5 - DateTime
  • 6 - Boolean
  • 7 - Percentage
  • 9 - Currency
  • 8 - JSON
  • 10 - Formula
  • 11 - Duration
  • 13 - Timestamp

  One of 1 2 3 4 5 6 7 9 8 10 11 13 · Min 0 · Max 32767

• removedboolean
• target_columnobjectnullable
  Attributes

  • ReadOnlySchemaColumn

    • idintegerrequired
    • usagestringrequired
    • measureone of
      Attributes

      • MeasureEnum

      • BlankEnum

      • NullEnum

  • null

• set_defaultbooleanwrite-only

  Default false

• reset_defaultbooleanwrite-only

  Default false

• unlock_typebooleanwrite-only

  Default false

Responses

200OKapplication/json

Response schema

object DatastreamColumnInfo

• datatypestringrequired
• idintegerrequiredread-only
• change_urlstringrequiredread-only
• createdstring · date-timerequiredread-only
• is_key_columnboolean

  If checked, this column will be used to consolidate multiple files.

• confirmed_typeboolean

  If checked the type will not be changed by the tracking service.

• namestringrequired

  Max length 200

• typeinteger
  • 1 - String
  • 2 - Long
  • 3 - Float
  • 4 - Date
  • 5 - DateTime
  • 6 - Boolean
  • 7 - Percentage
  • 9 - Currency
  • 8 - JSON
  • 10 - Formula
  • 11 - Duration
  • 13 - Timestamp

  One of 1 2 3 4 5 6 7 9 8 10 11 13 · Min 0 · Max 32767

• removedboolean
• target_columnobjectnullable
  Attributes

  • ReadOnlySchemaColumn

    • idintegerrequired
    • namestringrequiredread-only

      Max length 200

    • typestringrequiredread-only
    • usagestringrequired
    • measureone of
      Attributes

      • MeasureEnum

      • BlankEnum

      • NullEnum

  • null

• updatedstring · date-timerequiredread-only
• has_smart_naming_conventionstringrequiredread-only

RequestcURL

curl --request PATCH 'https://{{INSTANCE}}/api/datastreams/{id}/columns/{cid}/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "datatype": "string",
    "is_key_column": true,
    "confirmed_type": true,
    "name": "string",
    "type": 1,
    "removed": true,
    "target_column": {
      "id": 1,
      "usage": "string",
      "measure": "SUM"
    },
    "set_default": false,
    "reset_default": false,
    "unlock_type": false
  }'

Response200

{
  "datatype": "string",
  "id": 1,
  "change_url": "string",
  "created": "2024-01-01T00:00:00Z",
  "is_key_column": true,
  "confirmed_type": true,
  "name": "string",
  "type": 1,
  "removed": true,
  "target_column": {
    "id": 1,
    "name": "string",
    "type": "string",
    "usage": "string",
    "measure": "SUM"
  },
  "updated": "2024-01-01T00:00:00Z",
  "has_smart_naming_convention": "string"
}

Create datastreams copy mapping

POST/api/datastreams/{id}/copy-mapping/

API key permissionDatastream: Writedatastream:write

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream.

Request bodyrequired

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object APIDatastreamFull

• stack_idintegerrequiredwrite-only
• authintegernullable

  Which authorization the datastream uses.

• namestringrequired

  A human readable name. Numbers and special characters are supported.

  Max length 150

• descriptionstring

  Max length 1000

• enabledboolean

  Streams that are not scheduled will not be fetched automatically.

• transformer_idsarray of integerrequiredwrite-only
• datatypestring

  Projection of destination state: reads Live if any destination is enabled, otherwise Staging. Writing 'Live' enables all destinations and 'Staging' disables them.

  • Live - Live
  • Staging - Staging

  One of Live Staging

• overwrite_key_columnsboolean

  Overwrite rows according to Key defined in Data Mapping.

• manage_extract_namesboolean

  Split by selected date column and name extracts with pre-defined pattern to consolidate data.

• extract_name_keysstringnullable

  Max length 128

• retention_typeinteger
  • 1 - Retain all
  • 2 - Retain N fetches
  • 4 - Retain N extracts
  • 3 - Retain N days

  One of 1 2 4 3 · Min 0 · Max 32767

• retention_numberintegernullable

  The amount (N) of fetches/extracts/days to retain (raw extracts are not counted). Must be an integer greater than or equal to zero.

  Min 0 · Max 32767

• remove_if_emptyboolean

  When enabled, fetches resulting in only empty rows ("empty extracts") will be silently discarded.

• skip_empty_rowsboolean

  When enabled, empty data rows in fetches will be silently ignored.

• prune_instantlyboolean

  When enabled, deleted files will not be kept for the configured grace period.

• overwrite_datastreamboolean

  Delete/Drop all existing rows (created by this datastream) in the destination before inserting a new import.

• overwrite_filenameboolean

  Overwrite rows from same extract file.

• is_insights_mediaplanboolean

  If checked, generated extracts will be treated as Insights mediaplans.

• cron_typestring
• cron_intervalinteger

  Min 0

• cron_start_of_daystring · time
• cron_interval_startinteger

  Min 0

• time_range_presetinteger
  • 0 - Custom Time Range
  • 13 - Yesterday
  • 10 - Today
  • 11 - Current Week
  • 6 - Current Month
  • 7 - Previous Month
  • 17 - Last Quarter
  • 18 - Last 2 Days
  • 16 - Last 3 Days
  • 23 - Last 4 Days
  • 19 - Last 5 Days
  • 24 - Last 6 Days
  • 4 - Last 7 Days
  • 25 - Last 8 Days
  • 26 - Last 9 Days
  • 22 - Last 10 Days
  • 14 - Last 14 Days
  • 15 - Last 28 Days
  • 2 - Last 30 Days
  • 20 - Last 40 Days
  • 21 - Last 60 Days
  • 5 - Last 90 Days
  • 31 - Last 120 Days
  • 28 - Last 180 Days
  • 3 - Last 365 Days
  • 27 - Last 730 Days
  • 8 - Previous Week
  • 9 - Previous Year
  • 29 - Current Quarter
  • 12 - Current Year
  • 30 - Last Hour
  • 1000 - Lifetime
  • 50 - Tomorrow
  • 51 - Next 2 Days
  • 52 - Next 7 Days
  • 53 - Next 30 Days
  • 54 - Current Week (incl Future Days)
  • 55 - Next Week
  • 56 - Current Month (incl Future Days)
  • 57 - Next Month
  • 58 - Current Year (incl Future Days)
  • 59 - Next Year

  One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59

• delta_intervalinteger

  Min 0

• delta_interval_startinteger

  Min 0

• delta_start_of_daystring · time
• delta_typeinteger
  • 0 - minute(s)
  • 1 - hour(s)
  • 2 - day(s)
  • 3 - week(s)
  • 4 - month(s)
  • 6 - quarters(s)
  • 5 - year(s)
  • 7 - once

  One of 0 1 2 3 4 6 5 7

Responses

200OKapplication/json

Response schema

object APIDatastreamFull

• idintegerrequiredread-only
• uuidstring · uuidrequiredread-only
• urlstring · urirequiredread-only
• stackobjectrequiredread-only
  Attributes · StackBasic

  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • namestringrequired

    Max length 60

  • slugstringrequiredread-only
  • urlstring · urirequiredread-only
  • change_urlstringrequiredread-only
  • extracts_urlstringrequiredread-only
  • issues_urlstringrequiredread-only
  • overview_urlstringrequiredread-only
  • permissionsstringrequiredread-only
• authintegernullable

  Which authorization the datastream uses.

• auth_change_urlstringrequiredread-only
• app_labelstringrequiredread-only
• namestringrequired

  A human readable name. Numbers and special characters are supported.

  Max length 150

• slugstringrequiredread-only
• descriptionstring

  Max length 1000

• enabledboolean

  Streams that are not scheduled will not be fetched automatically.

• frequencystringrequiredread-only
• next_runstring · date-timerequiredread-only
• last_fetchstring · date-timerequiredread-only
• absolute_urlstringrequiredread-only
• change_urlstringrequiredread-only
• extracts_urlstringrequiredread-only
• fetch_urlstringrequiredread-only
• overview_urlstringrequiredread-only
• schema_mapping_urlstringrequiredread-only
• issues_urlstringrequiredread-only
• transformersarray of objectrequiredread-only
  Items · TransformerBasic

  • idintegerrequiredread-only
  • namestringrequired

    Max length 200

  • stackintegernullable
  • change_urlstringrequiredread-only
  • smart_naming_conventionobjectrequiredread-only
    Attributes · SmartNamingConventionSummary

    • idintegerrequiredread-only
    • column_namestringrequiredread-only
    • datastream_namesstringrequiredread-only
    • delimiters_charactersstringrequiredread-only
    • sorted_columns_namesstringrequiredread-only
    • email_for_errorbooleanrequired
    • email_for_warningbooleanrequired
    • raise_for_warningbooleanrequired
    • add_status_columnsbooleanrequired
    • columns_rule_phrasingstringrequiredread-only
• schedulesarray of objectrequiredread-only
  Items · FetchSchedule

  • idintegerrequiredread-only
  • cron_presetstring
    • ONCE - Once
    • CRON_EVERY_DAY - Every day
    • CRON_EVERY_WEEK - Every week
    • CRON_EVERY_MONTH - Every month
    • CRON_EVERY_QUARTER - Every quarter
    • CRON_EVERY_15_MINUTES - Every 15 minutes
    • CRON_EVERY_30_MINUTES - Every 30 minutes
    • CRON_EVERY_HOUR - Every hour
    • CRON_EVERY_2_HOURS - Every 2 hours
    • CRON_EVERY_3_HOURS - Every 3 hours
    • CRON_EVERY_4_HOURS - Every 4 hours
    • CRON_EVERY_5_HOURS - Every 5 hours
    • CRON_EVERY_6_HOURS - Every 6 hours
    • CRON_EVERY_8_HOURS - Every 8 hours
    • CRON_EVERY_12_HOURS - Every 12 hours
    • CRON_EVERY_2_DAYS - Every 2 days
    • CRON_EVERY_30_DAYS - Every 30 days
    • CRON_EVERY_40_DAYS - Every 40 days
    • CRON_EVERY_2_WEEKS - Every 2 weeks
    • CRON_EVERY_4_WEEKS - Every 4 weeks
    • CRON_EVERY_6_MONTHS - Every 6 months
    • CRON_EVERY_YEAR - Every year

    One of ONCE CRON_EVERY_DAY CRON_EVERY_WEEK CRON_EVERY_MONTH CRON_EVERY_QUARTER CRON_EVERY_15_MINUTES CRON_EVERY_30_MINUTES CRON_EVERY_HOUR CRON_EVERY_2_HOURS CRON_EVERY_3_HOURS CRON_EVERY_4_HOURS CRON_EVERY_5_HOURS CRON_EVERY_6_HOURS CRON_EVERY_8_HOURS CRON_EVERY_12_HOURS CRON_EVERY_2_DAYS CRON_EVERY_30_DAYS CRON_EVERY_40_DAYS CRON_EVERY_2_WEEKS CRON_EVERY_4_WEEKS CRON_EVERY_6_MONTHS CRON_EVERY_YEAR

  • cron_typestring

    Defaults to 'day' when omitted on a schedule entry.

  • cron_intervalinteger

    Min 0 · Max 2147483647

  • cron_start_of_daystring · time

    At what time the day starts.

  • cron_interval_startinteger

    Min 0 · Max 32767

  • time_range_presetinteger

    Select one of the time range presets.

    • 0 - Custom Time Range
    • 13 - Yesterday
    • 10 - Today
    • 11 - Current Week
    • 6 - Current Month
    • 7 - Previous Month
    • 17 - Last Quarter
    • 18 - Last 2 Days
    • 16 - Last 3 Days
    • 23 - Last 4 Days
    • 19 - Last 5 Days
    • 24 - Last 6 Days
    • 4 - Last 7 Days
    • 25 - Last 8 Days
    • 26 - Last 9 Days
    • 22 - Last 10 Days
    • 14 - Last 14 Days
    • 15 - Last 28 Days
    • 2 - Last 30 Days
    • 20 - Last 40 Days
    • 21 - Last 60 Days
    • 5 - Last 90 Days
    • 31 - Last 120 Days
    • 28 - Last 180 Days
    • 3 - Last 365 Days
    • 27 - Last 730 Days
    • 8 - Previous Week
    • 9 - Previous Year
    • 29 - Current Quarter
    • 12 - Current Year
    • 30 - Last Hour
    • 1000 - Lifetime
    • 50 - Tomorrow
    • 51 - Next 2 Days
    • 52 - Next 7 Days
    • 53 - Next 30 Days
    • 54 - Current Week (incl Future Days)
    • 55 - Next Week
    • 56 - Current Month (incl Future Days)
    • 57 - Next Month
    • 58 - Current Year (incl Future Days)
    • 59 - Next Year

    One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59 · Min 0 · Max 32767

  • time_range_preset_labelstringrequiredread-only
  • delta_typeinteger
    • 0 - minute(s)
    • 1 - hour(s)
    • 2 - day(s)
    • 3 - week(s)
    • 4 - month(s)
    • 6 - quarters(s)
    • 5 - year(s)
    • 7 - once

    One of 0 1 2 3 4 6 5 7 · Min -32768 · Max 32767

  • delta_intervalinteger

    Min 0 · Max 2147483647

  • delta_start_of_daystring · time

    At what time the day starts.

  • delta_interval_startinteger

    Min 0 · Max 32767

  • fixed_startstring · datenullable

    First day to fetch.

  • fixed_endstring · datenullable

    Last day to fetch.

  • offset_daysinteger

    Number of days to shift the fetched date range into the past.

    Min -32768 · Max 32767

  • not_before_datestring · datenullable

    Do not fetch before this date.

  • not_before_timestring · timenullable

    Do not fetch before this time.

• datastream_type_idintegerrequiredread-only
• datastream_type_namestringrequiredread-only
• datastream_type_slugstringrequiredread-only
• datatypestring

  Projection of destination state: reads Live if any destination is enabled, otherwise Staging. Writing 'Live' enables all destinations and 'Staging' disables them.

  • Live - Live
  • Staging - Staging

  One of Live Staging

• actionsstringrequiredread-only
• overwrite_key_columnsboolean

  Overwrite rows according to Key defined in Data Mapping.

• manage_extract_namesboolean

  Split by selected date column and name extracts with pre-defined pattern to consolidate data.

• extract_name_keysstringnullable

  Max length 128

• retention_typeinteger
  • 1 - Retain all
  • 2 - Retain N fetches
  • 4 - Retain N extracts
  • 3 - Retain N days

  One of 1 2 4 3 · Min 0 · Max 32767

• retention_numberintegernullable

  The amount (N) of fetches/extracts/days to retain (raw extracts are not counted). Must be an integer greater than or equal to zero.

  Min 0 · Max 32767

• remove_if_emptyboolean

  When enabled, fetches resulting in only empty rows ("empty extracts") will be silently discarded.

• skip_empty_rowsboolean

  When enabled, empty data rows in fetches will be silently ignored.

• prune_instantlyboolean

  When enabled, deleted files will not be kept for the configured grace period.

• overwrite_datastreamboolean

  Delete/Drop all existing rows (created by this datastream) in the destination before inserting a new import.

• overwrite_filenameboolean

  Overwrite rows from same extract file.

• logo_urlstringrequiredread-only
• extracts_stream_urlstringrequiredread-only
• active_destinationstringrequiredread-only
• supports_passive_destinationsbooleanrequiredread-only
• passive_destinationsstringrequiredread-only
• columnsstring · urirequiredread-only
• supports_extended_intervalsstringrequiredread-only
• updatedstring · date-timerequiredread-only
• createdstring · date-timerequiredread-only
• creatorstringrequiredread-onlynullable
• has_schema_mappingbooleanrequiredread-only
• is_insights_mediaplanboolean

  If checked, generated extracts will be treated as Insights mediaplans.

• cron_typestring
• cron_intervalinteger

  Min 0

• cron_start_of_daystring · time
• cron_interval_startinteger

  Min 0

• time_range_presetinteger
  • 0 - Custom Time Range
  • 13 - Yesterday
  • 10 - Today
  • 11 - Current Week
  • 6 - Current Month
  • 7 - Previous Month
  • 17 - Last Quarter
  • 18 - Last 2 Days
  • 16 - Last 3 Days
  • 23 - Last 4 Days
  • 19 - Last 5 Days
  • 24 - Last 6 Days
  • 4 - Last 7 Days
  • 25 - Last 8 Days
  • 26 - Last 9 Days
  • 22 - Last 10 Days
  • 14 - Last 14 Days
  • 15 - Last 28 Days
  • 2 - Last 30 Days
  • 20 - Last 40 Days
  • 21 - Last 60 Days
  • 5 - Last 90 Days
  • 31 - Last 120 Days
  • 28 - Last 180 Days
  • 3 - Last 365 Days
  • 27 - Last 730 Days
  • 8 - Previous Week
  • 9 - Previous Year
  • 29 - Current Quarter
  • 12 - Current Year
  • 30 - Last Hour
  • 1000 - Lifetime
  • 50 - Tomorrow
  • 51 - Next 2 Days
  • 52 - Next 7 Days
  • 53 - Next 30 Days
  • 54 - Current Week (incl Future Days)
  • 55 - Next Week
  • 56 - Current Month (incl Future Days)
  • 57 - Next Month
  • 58 - Current Year (incl Future Days)
  • 59 - Next Year

  One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59

• delta_intervalinteger

  Min 0

• delta_interval_startinteger

  Min 0

• delta_start_of_daystring · time
• delta_typeinteger
  • 0 - minute(s)
  • 1 - hour(s)
  • 2 - day(s)
  • 3 - week(s)
  • 4 - month(s)
  • 6 - quarters(s)
  • 5 - year(s)
  • 7 - once

  One of 0 1 2 3 4 6 5 7

• time_range_maxstringrequiredread-only
• time_range_availablestringrequiredread-only
• has_schema_mapping_dimensionbooleanrequiredread-only
• feature_smart_naming_conventionstringrequiredread-only
• auto_fetchstringrequiredread-only
• assigned_destinationsarray of objectrequiredread-only
  Items · AssignedDestination

  • target_idintegerrequiredread-only
  • destination_namestringrequiredread-only
  • destination_typestringrequiredread-only
  • enabledbooleanrequiredread-only
  • destination_settingsobjectrequiredread-only
• can_be_fetchedbooleanrequiredread-only

RequestcURL

curl --request POST 'https://{{INSTANCE}}/api/datastreams/{id}/copy-mapping/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "stack_id": 1,
    "auth": 1,
    "name": "string",
    "description": "string",
    "enabled": true,
    "transformer_ids": [
      1
    ],
    "datatype": "Live",
    "overwrite_key_columns": true,
    "manage_extract_names": true,
    "extract_name_keys": "string",
    "retention_type": 1,
    "retention_number": 1,
    "remove_if_empty": true,
    "skip_empty_rows": true,
    "prune_instantly": true,
    "overwrite_datastream": true,
    "overwrite_filename": true,
    "is_insights_mediaplan": true,
    "cron_type": "string",
    "cron_interval": 1,
    "cron_start_of_day": "string",
    "cron_interval_start": 1,
    "time_range_preset": 0,
    "delta_interval": 1,
    "delta_interval_start": 1,
    "delta_start_of_day": "string",
    "delta_type": 0
  }'

Response200

{
  "id": 1,
  "uuid": "00000000-0000-0000-0000-000000000000",
  "url": "https://example.com",
  "stack": {
    "id": 1,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "slug": "string",
    "url": "https://example.com",
    "change_url": "string",
    "extracts_url": "string",
    "issues_url": "string",
    "overview_url": "string",
    "permissions": "string"
  },
  "auth": 1,
  "auth_change_url": "string",
  "app_label": "string",
  "name": "string",
  "slug": "string",
  "description": "string",
  "enabled": true,
  "frequency": "string",
  "next_run": "2024-01-01T00:00:00Z",
  "last_fetch": "2024-01-01T00:00:00Z",
  "absolute_url": "string",
  "change_url": "string",
  "extracts_url": "string",
  "fetch_url": "string",
  "overview_url": "string",
  "schema_mapping_url": "string",
  "issues_url": "string",
  "transformers": [
    {
      "id": 1,
      "name": "string",
      "stack": 1,
      "change_url": "string",
      "smart_naming_convention": {
        "id": 1,
        "column_name": "string",
        "datastream_names": "string",
        "delimiters_characters": "string",
        "sorted_columns_names": "string",
        "email_for_error": true,
        "email_for_warning": true,
        "raise_for_warning": true,
        "add_status_columns": true,
        "columns_rule_phrasing": "string"
      }
    }
  ],
  "schedules": [
    {
      "id": 1,
      "cron_preset": "ONCE",
      "cron_type": "string",
      "cron_interval": 1,
      "cron_start_of_day": "string",
      "cron_interval_start": 1,
      "time_range_preset": 0,
      "time_range_preset_label": "string",
      "delta_type": 0,
      "delta_interval": 1,
      "delta_start_of_day": "string",
      "delta_interval_start": 1,
      "fixed_start": "2024-01-01",
      "fixed_end": "2024-01-01",
      "offset_days": 1,
      "not_before_date": "2024-01-01",
      "not_before_time": "string"
    }
  ],
  "datastream_type_id": 1,
  "datastream_type_name": "string",
  "datastream_type_slug": "string",
  "datatype": "Live",
  "actions": "string",
  "overwrite_key_columns": true,
  "manage_extract_names": true,
  "extract_name_keys": "string",
  "retention_type": 1,
  "retention_number": 1,
  "remove_if_empty": true,
  "skip_empty_rows": true,
  "prune_instantly": true,
  "overwrite_datastream": true,
  "overwrite_filename": true,
  "logo_url": "string",
  "extracts_stream_url": "string",
  "active_destination": "string",
  "supports_passive_destinations": true,
  "passive_destinations": "string",
  "columns": "https://example.com",
  "supports_extended_intervals": "string",
  "updated": "2024-01-01T00:00:00Z",
  "created": "2024-01-01T00:00:00Z",
  "creator": "string",
  "has_schema_mapping": true,
  "is_insights_mediaplan": true,
  "cron_type": "string",
  "cron_interval": 1,
  "cron_start_of_day": "string",
  "cron_interval_start": 1,
  "time_range_preset": 0,
  "delta_interval": 1,
  "delta_interval_start": 1,
  "delta_start_of_day": "string",
  "delta_type": 0,
  "time_range_max": "string",
  "time_range_available": "string",
  "has_schema_mapping_dimension": true,
  "feature_smart_naming_convention": "string",
  "auto_fetch": "string",
  "assigned_destinations": [
    {
      "target_id": 1,
      "destination_name": "string",
      "destination_type": "string",
      "enabled": true,
      "destination_settings": {
        "key": null
      }
    }
  ],
  "can_be_fetched": true
}

Create datastreams copy

POST/api/datastreams/{id}/copy/

API key permissionDatastream: Writedatastream:write

Copy a datastream. Without stack, or with stack equal to the source workspace, the copy is a same-workspace duplicate (disabled, destination bindings copied disabled, mapping copied).

With a different stack (HI-304) the copy follows the UI Clone wizard: fetch configuration, schedules and column mappings are carried over, the authorization is reused when the target workspace can see it and cloned otherwise, and the source's destination bindings, enrichments and monitors are NOT carried. Optional destinations (ids usable from the target workspace; bindings created disabled), enrichments (ids usable from the target workspace) and authorization_id attach what the copy should use. The response then carries a report with reused, cloned, attached and dropped lists. Ids not usable from the target workspace return 400.

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream.

Request body

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object CopyDatastreamRequest

• destinationsarray of integer

  Destinations in the target workspace (or a parent) to bind, disabled.

• enrichmentsarray of integer

  Enrichments usable from the target workspace to assign to the copy.

• authorization_idintegernullable

  Authorization usable from the target workspace, replacing the source's.

• authintegernullable

  Alias of authorization_id (the datastream serializer's field name).

• namestring

  Name of the copy.

• stackinteger

  Workspace of the copy. Omit or pass the source workspace for a plain duplicate; a different workspace switches to clone semantics.

Responses

200OKapplication/json

Response schema

object CopyDatastreamResponse

• statusstringrequired
• idintegerrequired
• urlstringrequired
• reportobject

  Only present on a copy into a different workspace.

  Attributes · CopyDatastreamReport

  • reusedarray of stringrequired
  • clonedarray of stringrequired
  • attachedarray of stringrequired
  • droppedarray of stringrequired

RequestcURL

curl --request POST 'https://{{INSTANCE}}/api/datastreams/{id}/copy/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "destinations": [
      1
    ],
    "enrichments": [
      1
    ],
    "authorization_id": 1,
    "auth": 1,
    "name": "string",
    "stack": 1
  }'

Response200

{
  "status": "string",
  "id": 1,
  "url": "string",
  "report": {
    "reused": [
      "string"
    ],
    "cloned": [
      "string"
    ],
    "attached": [
      "string"
    ],
    "dropped": [
      "string"
    ]
  }
}

Get datastreams default mapping

GET/api/datastreams/{id}/default-mapping/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream.

Responses

200OKapplication/json

Response schema

object APIDatastreamFull

• idintegerrequiredread-only
• uuidstring · uuidrequiredread-only
• urlstring · urirequiredread-only
• stackobjectrequiredread-only
  Attributes · StackBasic

  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • namestringrequired

    Max length 60

  • slugstringrequiredread-only
  • urlstring · urirequiredread-only
  • change_urlstringrequiredread-only
  • extracts_urlstringrequiredread-only
  • issues_urlstringrequiredread-only
  • overview_urlstringrequiredread-only
  • permissionsstringrequiredread-only
• authintegernullable

  Which authorization the datastream uses.

• auth_change_urlstringrequiredread-only
• app_labelstringrequiredread-only
• namestringrequired

  A human readable name. Numbers and special characters are supported.

  Max length 150

• slugstringrequiredread-only
• descriptionstring

  Max length 1000

• enabledboolean

  Streams that are not scheduled will not be fetched automatically.

• frequencystringrequiredread-only
• next_runstring · date-timerequiredread-only
• last_fetchstring · date-timerequiredread-only
• absolute_urlstringrequiredread-only
• change_urlstringrequiredread-only
• extracts_urlstringrequiredread-only
• fetch_urlstringrequiredread-only
• overview_urlstringrequiredread-only
• schema_mapping_urlstringrequiredread-only
• issues_urlstringrequiredread-only
• transformersarray of objectrequiredread-only
  Items · TransformerBasic

  • idintegerrequiredread-only
  • namestringrequired

    Max length 200

  • stackintegernullable
  • change_urlstringrequiredread-only
  • smart_naming_conventionobjectrequiredread-only
    Attributes · SmartNamingConventionSummary

    • idintegerrequiredread-only
    • column_namestringrequiredread-only
    • datastream_namesstringrequiredread-only
    • delimiters_charactersstringrequiredread-only
    • sorted_columns_namesstringrequiredread-only
    • email_for_errorbooleanrequired
    • email_for_warningbooleanrequired
    • raise_for_warningbooleanrequired
    • add_status_columnsbooleanrequired
    • columns_rule_phrasingstringrequiredread-only
• schedulesarray of objectrequiredread-only
  Items · FetchSchedule

  • idintegerrequiredread-only
  • cron_presetstring
    • ONCE - Once
    • CRON_EVERY_DAY - Every day
    • CRON_EVERY_WEEK - Every week
    • CRON_EVERY_MONTH - Every month
    • CRON_EVERY_QUARTER - Every quarter
    • CRON_EVERY_15_MINUTES - Every 15 minutes
    • CRON_EVERY_30_MINUTES - Every 30 minutes
    • CRON_EVERY_HOUR - Every hour
    • CRON_EVERY_2_HOURS - Every 2 hours
    • CRON_EVERY_3_HOURS - Every 3 hours
    • CRON_EVERY_4_HOURS - Every 4 hours
    • CRON_EVERY_5_HOURS - Every 5 hours
    • CRON_EVERY_6_HOURS - Every 6 hours
    • CRON_EVERY_8_HOURS - Every 8 hours
    • CRON_EVERY_12_HOURS - Every 12 hours
    • CRON_EVERY_2_DAYS - Every 2 days
    • CRON_EVERY_30_DAYS - Every 30 days
    • CRON_EVERY_40_DAYS - Every 40 days
    • CRON_EVERY_2_WEEKS - Every 2 weeks
    • CRON_EVERY_4_WEEKS - Every 4 weeks
    • CRON_EVERY_6_MONTHS - Every 6 months
    • CRON_EVERY_YEAR - Every year

    One of ONCE CRON_EVERY_DAY CRON_EVERY_WEEK CRON_EVERY_MONTH CRON_EVERY_QUARTER CRON_EVERY_15_MINUTES CRON_EVERY_30_MINUTES CRON_EVERY_HOUR CRON_EVERY_2_HOURS CRON_EVERY_3_HOURS CRON_EVERY_4_HOURS CRON_EVERY_5_HOURS CRON_EVERY_6_HOURS CRON_EVERY_8_HOURS CRON_EVERY_12_HOURS CRON_EVERY_2_DAYS CRON_EVERY_30_DAYS CRON_EVERY_40_DAYS CRON_EVERY_2_WEEKS CRON_EVERY_4_WEEKS CRON_EVERY_6_MONTHS CRON_EVERY_YEAR

  • cron_typestring

    Defaults to 'day' when omitted on a schedule entry.

  • cron_intervalinteger

    Min 0 · Max 2147483647

  • cron_start_of_daystring · time

    At what time the day starts.

  • cron_interval_startinteger

    Min 0 · Max 32767

  • time_range_presetinteger

    Select one of the time range presets.

    • 0 - Custom Time Range
    • 13 - Yesterday
    • 10 - Today
    • 11 - Current Week
    • 6 - Current Month
    • 7 - Previous Month
    • 17 - Last Quarter
    • 18 - Last 2 Days
    • 16 - Last 3 Days
    • 23 - Last 4 Days
    • 19 - Last 5 Days
    • 24 - Last 6 Days
    • 4 - Last 7 Days
    • 25 - Last 8 Days
    • 26 - Last 9 Days
    • 22 - Last 10 Days
    • 14 - Last 14 Days
    • 15 - Last 28 Days
    • 2 - Last 30 Days
    • 20 - Last 40 Days
    • 21 - Last 60 Days
    • 5 - Last 90 Days
    • 31 - Last 120 Days
    • 28 - Last 180 Days
    • 3 - Last 365 Days
    • 27 - Last 730 Days
    • 8 - Previous Week
    • 9 - Previous Year
    • 29 - Current Quarter
    • 12 - Current Year
    • 30 - Last Hour
    • 1000 - Lifetime
    • 50 - Tomorrow
    • 51 - Next 2 Days
    • 52 - Next 7 Days
    • 53 - Next 30 Days
    • 54 - Current Week (incl Future Days)
    • 55 - Next Week
    • 56 - Current Month (incl Future Days)
    • 57 - Next Month
    • 58 - Current Year (incl Future Days)
    • 59 - Next Year

    One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59 · Min 0 · Max 32767

  • time_range_preset_labelstringrequiredread-only
  • delta_typeinteger
    • 0 - minute(s)
    • 1 - hour(s)
    • 2 - day(s)
    • 3 - week(s)
    • 4 - month(s)
    • 6 - quarters(s)
    • 5 - year(s)
    • 7 - once

    One of 0 1 2 3 4 6 5 7 · Min -32768 · Max 32767

  • delta_intervalinteger

    Min 0 · Max 2147483647

  • delta_start_of_daystring · time

    At what time the day starts.

  • delta_interval_startinteger

    Min 0 · Max 32767

  • fixed_startstring · datenullable

    First day to fetch.

  • fixed_endstring · datenullable

    Last day to fetch.

  • offset_daysinteger

    Number of days to shift the fetched date range into the past.

    Min -32768 · Max 32767

  • not_before_datestring · datenullable

    Do not fetch before this date.

  • not_before_timestring · timenullable

    Do not fetch before this time.

• datastream_type_idintegerrequiredread-only
• datastream_type_namestringrequiredread-only
• datastream_type_slugstringrequiredread-only
• datatypestring

  Projection of destination state: reads Live if any destination is enabled, otherwise Staging. Writing 'Live' enables all destinations and 'Staging' disables them.

  • Live - Live
  • Staging - Staging

  One of Live Staging

• actionsstringrequiredread-only
• overwrite_key_columnsboolean

  Overwrite rows according to Key defined in Data Mapping.

• manage_extract_namesboolean

  Split by selected date column and name extracts with pre-defined pattern to consolidate data.

• extract_name_keysstringnullable

  Max length 128

• retention_typeinteger
  • 1 - Retain all
  • 2 - Retain N fetches
  • 4 - Retain N extracts
  • 3 - Retain N days

  One of 1 2 4 3 · Min 0 · Max 32767

• retention_numberintegernullable

  The amount (N) of fetches/extracts/days to retain (raw extracts are not counted). Must be an integer greater than or equal to zero.

  Min 0 · Max 32767

• remove_if_emptyboolean

  When enabled, fetches resulting in only empty rows ("empty extracts") will be silently discarded.

• skip_empty_rowsboolean

  When enabled, empty data rows in fetches will be silently ignored.

• prune_instantlyboolean

  When enabled, deleted files will not be kept for the configured grace period.

• overwrite_datastreamboolean

  Delete/Drop all existing rows (created by this datastream) in the destination before inserting a new import.

• overwrite_filenameboolean

  Overwrite rows from same extract file.

• logo_urlstringrequiredread-only
• extracts_stream_urlstringrequiredread-only
• active_destinationstringrequiredread-only
• supports_passive_destinationsbooleanrequiredread-only
• passive_destinationsstringrequiredread-only
• columnsstring · urirequiredread-only
• supports_extended_intervalsstringrequiredread-only
• updatedstring · date-timerequiredread-only
• createdstring · date-timerequiredread-only
• creatorstringrequiredread-onlynullable
• has_schema_mappingbooleanrequiredread-only
• is_insights_mediaplanboolean

  If checked, generated extracts will be treated as Insights mediaplans.

• cron_typestring
• cron_intervalinteger

  Min 0

• cron_start_of_daystring · time
• cron_interval_startinteger

  Min 0

• time_range_presetinteger
  • 0 - Custom Time Range
  • 13 - Yesterday
  • 10 - Today
  • 11 - Current Week
  • 6 - Current Month
  • 7 - Previous Month
  • 17 - Last Quarter
  • 18 - Last 2 Days
  • 16 - Last 3 Days
  • 23 - Last 4 Days
  • 19 - Last 5 Days
  • 24 - Last 6 Days
  • 4 - Last 7 Days
  • 25 - Last 8 Days
  • 26 - Last 9 Days
  • 22 - Last 10 Days
  • 14 - Last 14 Days
  • 15 - Last 28 Days
  • 2 - Last 30 Days
  • 20 - Last 40 Days
  • 21 - Last 60 Days
  • 5 - Last 90 Days
  • 31 - Last 120 Days
  • 28 - Last 180 Days
  • 3 - Last 365 Days
  • 27 - Last 730 Days
  • 8 - Previous Week
  • 9 - Previous Year
  • 29 - Current Quarter
  • 12 - Current Year
  • 30 - Last Hour
  • 1000 - Lifetime
  • 50 - Tomorrow
  • 51 - Next 2 Days
  • 52 - Next 7 Days
  • 53 - Next 30 Days
  • 54 - Current Week (incl Future Days)
  • 55 - Next Week
  • 56 - Current Month (incl Future Days)
  • 57 - Next Month
  • 58 - Current Year (incl Future Days)
  • 59 - Next Year

  One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59

• delta_intervalinteger

  Min 0

• delta_interval_startinteger

  Min 0

• delta_start_of_daystring · time
• delta_typeinteger
  • 0 - minute(s)
  • 1 - hour(s)
  • 2 - day(s)
  • 3 - week(s)
  • 4 - month(s)
  • 6 - quarters(s)
  • 5 - year(s)
  • 7 - once

  One of 0 1 2 3 4 6 5 7

• time_range_maxstringrequiredread-only
• time_range_availablestringrequiredread-only
• has_schema_mapping_dimensionbooleanrequiredread-only
• feature_smart_naming_conventionstringrequiredread-only
• auto_fetchstringrequiredread-only
• assigned_destinationsarray of objectrequiredread-only
  Items · AssignedDestination

  • target_idintegerrequiredread-only
  • destination_namestringrequiredread-only
  • destination_typestringrequiredread-only
  • enabledbooleanrequiredread-only
  • destination_settingsobjectrequiredread-only
• can_be_fetchedbooleanrequiredread-only

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/datastreams/{id}/default-mapping/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "id": 1,
  "uuid": "00000000-0000-0000-0000-000000000000",
  "url": "https://example.com",
  "stack": {
    "id": 1,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "slug": "string",
    "url": "https://example.com",
    "change_url": "string",
    "extracts_url": "string",
    "issues_url": "string",
    "overview_url": "string",
    "permissions": "string"
  },
  "auth": 1,
  "auth_change_url": "string",
  "app_label": "string",
  "name": "string",
  "slug": "string",
  "description": "string",
  "enabled": true,
  "frequency": "string",
  "next_run": "2024-01-01T00:00:00Z",
  "last_fetch": "2024-01-01T00:00:00Z",
  "absolute_url": "string",
  "change_url": "string",
  "extracts_url": "string",
  "fetch_url": "string",
  "overview_url": "string",
  "schema_mapping_url": "string",
  "issues_url": "string",
  "transformers": [
    {
      "id": 1,
      "name": "string",
      "stack": 1,
      "change_url": "string",
      "smart_naming_convention": {
        "id": 1,
        "column_name": "string",
        "datastream_names": "string",
        "delimiters_characters": "string",
        "sorted_columns_names": "string",
        "email_for_error": true,
        "email_for_warning": true,
        "raise_for_warning": true,
        "add_status_columns": true,
        "columns_rule_phrasing": "string"
      }
    }
  ],
  "schedules": [
    {
      "id": 1,
      "cron_preset": "ONCE",
      "cron_type": "string",
      "cron_interval": 1,
      "cron_start_of_day": "string",
      "cron_interval_start": 1,
      "time_range_preset": 0,
      "time_range_preset_label": "string",
      "delta_type": 0,
      "delta_interval": 1,
      "delta_start_of_day": "string",
      "delta_interval_start": 1,
      "fixed_start": "2024-01-01",
      "fixed_end": "2024-01-01",
      "offset_days": 1,
      "not_before_date": "2024-01-01",
      "not_before_time": "string"
    }
  ],
  "datastream_type_id": 1,
  "datastream_type_name": "string",
  "datastream_type_slug": "string",
  "datatype": "Live",
  "actions": "string",
  "overwrite_key_columns": true,
  "manage_extract_names": true,
  "extract_name_keys": "string",
  "retention_type": 1,
  "retention_number": 1,
  "remove_if_empty": true,
  "skip_empty_rows": true,
  "prune_instantly": true,
  "overwrite_datastream": true,
  "overwrite_filename": true,
  "logo_url": "string",
  "extracts_stream_url": "string",
  "active_destination": "string",
  "supports_passive_destinations": true,
  "passive_destinations": "string",
  "columns": "https://example.com",
  "supports_extended_intervals": "string",
  "updated": "2024-01-01T00:00:00Z",
  "created": "2024-01-01T00:00:00Z",
  "creator": "string",
  "has_schema_mapping": true,
  "is_insights_mediaplan": true,
  "cron_type": "string",
  "cron_interval": 1,
  "cron_start_of_day": "string",
  "cron_interval_start": 1,
  "time_range_preset": 0,
  "delta_interval": 1,
  "delta_interval_start": 1,
  "delta_start_of_day": "string",
  "delta_type": 0,
  "time_range_max": "string",
  "time_range_available": "string",
  "has_schema_mapping_dimension": true,
  "feature_smart_naming_convention": "string",
  "auto_fetch": "string",
  "assigned_destinations": [
    {
      "target_id": 1,
      "destination_name": "string",
      "destination_type": "string",
      "enabled": true,
      "destination_settings": {
        "key": null
      }
    }
  ],
  "can_be_fetched": true
}

Get datastreams extracts most recent download

GET/api/datastreams/{id}/extracts/most-recent/download/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream.

Responses

200OKapplication/json

Response schema

object APIDatastreamFull

• idintegerrequiredread-only
• uuidstring · uuidrequiredread-only
• urlstring · urirequiredread-only
• stackobjectrequiredread-only
  Attributes · StackBasic

  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • namestringrequired

    Max length 60

  • slugstringrequiredread-only
  • urlstring · urirequiredread-only
  • change_urlstringrequiredread-only
  • extracts_urlstringrequiredread-only
  • issues_urlstringrequiredread-only
  • overview_urlstringrequiredread-only
  • permissionsstringrequiredread-only
• authintegernullable

  Which authorization the datastream uses.

• auth_change_urlstringrequiredread-only
• app_labelstringrequiredread-only
• namestringrequired

  A human readable name. Numbers and special characters are supported.

  Max length 150

• slugstringrequiredread-only
• descriptionstring

  Max length 1000

• enabledboolean

  Streams that are not scheduled will not be fetched automatically.

• frequencystringrequiredread-only
• next_runstring · date-timerequiredread-only
• last_fetchstring · date-timerequiredread-only
• absolute_urlstringrequiredread-only
• change_urlstringrequiredread-only
• extracts_urlstringrequiredread-only
• fetch_urlstringrequiredread-only
• overview_urlstringrequiredread-only
• schema_mapping_urlstringrequiredread-only
• issues_urlstringrequiredread-only
• transformersarray of objectrequiredread-only
  Items · TransformerBasic

  • idintegerrequiredread-only
  • namestringrequired

    Max length 200

  • stackintegernullable
  • change_urlstringrequiredread-only
  • smart_naming_conventionobjectrequiredread-only
    Attributes · SmartNamingConventionSummary

    • idintegerrequiredread-only
    • column_namestringrequiredread-only
    • datastream_namesstringrequiredread-only
    • delimiters_charactersstringrequiredread-only
    • sorted_columns_namesstringrequiredread-only
    • email_for_errorbooleanrequired
    • email_for_warningbooleanrequired
    • raise_for_warningbooleanrequired
    • add_status_columnsbooleanrequired
    • columns_rule_phrasingstringrequiredread-only
• schedulesarray of objectrequiredread-only
  Items · FetchSchedule

  • idintegerrequiredread-only
  • cron_presetstring
    • ONCE - Once
    • CRON_EVERY_DAY - Every day
    • CRON_EVERY_WEEK - Every week
    • CRON_EVERY_MONTH - Every month
    • CRON_EVERY_QUARTER - Every quarter
    • CRON_EVERY_15_MINUTES - Every 15 minutes
    • CRON_EVERY_30_MINUTES - Every 30 minutes
    • CRON_EVERY_HOUR - Every hour
    • CRON_EVERY_2_HOURS - Every 2 hours
    • CRON_EVERY_3_HOURS - Every 3 hours
    • CRON_EVERY_4_HOURS - Every 4 hours
    • CRON_EVERY_5_HOURS - Every 5 hours
    • CRON_EVERY_6_HOURS - Every 6 hours
    • CRON_EVERY_8_HOURS - Every 8 hours
    • CRON_EVERY_12_HOURS - Every 12 hours
    • CRON_EVERY_2_DAYS - Every 2 days
    • CRON_EVERY_30_DAYS - Every 30 days
    • CRON_EVERY_40_DAYS - Every 40 days
    • CRON_EVERY_2_WEEKS - Every 2 weeks
    • CRON_EVERY_4_WEEKS - Every 4 weeks
    • CRON_EVERY_6_MONTHS - Every 6 months
    • CRON_EVERY_YEAR - Every year

    One of ONCE CRON_EVERY_DAY CRON_EVERY_WEEK CRON_EVERY_MONTH CRON_EVERY_QUARTER CRON_EVERY_15_MINUTES CRON_EVERY_30_MINUTES CRON_EVERY_HOUR CRON_EVERY_2_HOURS CRON_EVERY_3_HOURS CRON_EVERY_4_HOURS CRON_EVERY_5_HOURS CRON_EVERY_6_HOURS CRON_EVERY_8_HOURS CRON_EVERY_12_HOURS CRON_EVERY_2_DAYS CRON_EVERY_30_DAYS CRON_EVERY_40_DAYS CRON_EVERY_2_WEEKS CRON_EVERY_4_WEEKS CRON_EVERY_6_MONTHS CRON_EVERY_YEAR

  • cron_typestring

    Defaults to 'day' when omitted on a schedule entry.

  • cron_intervalinteger

    Min 0 · Max 2147483647

  • cron_start_of_daystring · time

    At what time the day starts.

  • cron_interval_startinteger

    Min 0 · Max 32767

  • time_range_presetinteger

    Select one of the time range presets.

    • 0 - Custom Time Range
    • 13 - Yesterday
    • 10 - Today
    • 11 - Current Week
    • 6 - Current Month
    • 7 - Previous Month
    • 17 - Last Quarter
    • 18 - Last 2 Days
    • 16 - Last 3 Days
    • 23 - Last 4 Days
    • 19 - Last 5 Days
    • 24 - Last 6 Days
    • 4 - Last 7 Days
    • 25 - Last 8 Days
    • 26 - Last 9 Days
    • 22 - Last 10 Days
    • 14 - Last 14 Days
    • 15 - Last 28 Days
    • 2 - Last 30 Days
    • 20 - Last 40 Days
    • 21 - Last 60 Days
    • 5 - Last 90 Days
    • 31 - Last 120 Days
    • 28 - Last 180 Days
    • 3 - Last 365 Days
    • 27 - Last 730 Days
    • 8 - Previous Week
    • 9 - Previous Year
    • 29 - Current Quarter
    • 12 - Current Year
    • 30 - Last Hour
    • 1000 - Lifetime
    • 50 - Tomorrow
    • 51 - Next 2 Days
    • 52 - Next 7 Days
    • 53 - Next 30 Days
    • 54 - Current Week (incl Future Days)
    • 55 - Next Week
    • 56 - Current Month (incl Future Days)
    • 57 - Next Month
    • 58 - Current Year (incl Future Days)
    • 59 - Next Year

    One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59 · Min 0 · Max 32767

  • time_range_preset_labelstringrequiredread-only
  • delta_typeinteger
    • 0 - minute(s)
    • 1 - hour(s)
    • 2 - day(s)
    • 3 - week(s)
    • 4 - month(s)
    • 6 - quarters(s)
    • 5 - year(s)
    • 7 - once

    One of 0 1 2 3 4 6 5 7 · Min -32768 · Max 32767

  • delta_intervalinteger

    Min 0 · Max 2147483647

  • delta_start_of_daystring · time

    At what time the day starts.

  • delta_interval_startinteger

    Min 0 · Max 32767

  • fixed_startstring · datenullable

    First day to fetch.

  • fixed_endstring · datenullable

    Last day to fetch.

  • offset_daysinteger

    Number of days to shift the fetched date range into the past.

    Min -32768 · Max 32767

  • not_before_datestring · datenullable

    Do not fetch before this date.

  • not_before_timestring · timenullable

    Do not fetch before this time.

• datastream_type_idintegerrequiredread-only
• datastream_type_namestringrequiredread-only
• datastream_type_slugstringrequiredread-only
• datatypestring

  Projection of destination state: reads Live if any destination is enabled, otherwise Staging. Writing 'Live' enables all destinations and 'Staging' disables them.

  • Live - Live
  • Staging - Staging

  One of Live Staging

• actionsstringrequiredread-only
• overwrite_key_columnsboolean

  Overwrite rows according to Key defined in Data Mapping.

• manage_extract_namesboolean

  Split by selected date column and name extracts with pre-defined pattern to consolidate data.

• extract_name_keysstringnullable

  Max length 128

• retention_typeinteger
  • 1 - Retain all
  • 2 - Retain N fetches
  • 4 - Retain N extracts
  • 3 - Retain N days

  One of 1 2 4 3 · Min 0 · Max 32767

• retention_numberintegernullable

  The amount (N) of fetches/extracts/days to retain (raw extracts are not counted). Must be an integer greater than or equal to zero.

  Min 0 · Max 32767

• remove_if_emptyboolean

  When enabled, fetches resulting in only empty rows ("empty extracts") will be silently discarded.

• skip_empty_rowsboolean

  When enabled, empty data rows in fetches will be silently ignored.

• prune_instantlyboolean

  When enabled, deleted files will not be kept for the configured grace period.

• overwrite_datastreamboolean

  Delete/Drop all existing rows (created by this datastream) in the destination before inserting a new import.

• overwrite_filenameboolean

  Overwrite rows from same extract file.

• logo_urlstringrequiredread-only
• extracts_stream_urlstringrequiredread-only
• active_destinationstringrequiredread-only
• supports_passive_destinationsbooleanrequiredread-only
• passive_destinationsstringrequiredread-only
• columnsstring · urirequiredread-only
• supports_extended_intervalsstringrequiredread-only
• updatedstring · date-timerequiredread-only
• createdstring · date-timerequiredread-only
• creatorstringrequiredread-onlynullable
• has_schema_mappingbooleanrequiredread-only
• is_insights_mediaplanboolean

  If checked, generated extracts will be treated as Insights mediaplans.

• cron_typestring
• cron_intervalinteger

  Min 0

• cron_start_of_daystring · time
• cron_interval_startinteger

  Min 0

• time_range_presetinteger
  • 0 - Custom Time Range
  • 13 - Yesterday
  • 10 - Today
  • 11 - Current Week
  • 6 - Current Month
  • 7 - Previous Month
  • 17 - Last Quarter
  • 18 - Last 2 Days
  • 16 - Last 3 Days
  • 23 - Last 4 Days
  • 19 - Last 5 Days
  • 24 - Last 6 Days
  • 4 - Last 7 Days
  • 25 - Last 8 Days
  • 26 - Last 9 Days
  • 22 - Last 10 Days
  • 14 - Last 14 Days
  • 15 - Last 28 Days
  • 2 - Last 30 Days
  • 20 - Last 40 Days
  • 21 - Last 60 Days
  • 5 - Last 90 Days
  • 31 - Last 120 Days
  • 28 - Last 180 Days
  • 3 - Last 365 Days
  • 27 - Last 730 Days
  • 8 - Previous Week
  • 9 - Previous Year
  • 29 - Current Quarter
  • 12 - Current Year
  • 30 - Last Hour
  • 1000 - Lifetime
  • 50 - Tomorrow
  • 51 - Next 2 Days
  • 52 - Next 7 Days
  • 53 - Next 30 Days
  • 54 - Current Week (incl Future Days)
  • 55 - Next Week
  • 56 - Current Month (incl Future Days)
  • 57 - Next Month
  • 58 - Current Year (incl Future Days)
  • 59 - Next Year

  One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59

• delta_intervalinteger

  Min 0

• delta_interval_startinteger

  Min 0

• delta_start_of_daystring · time
• delta_typeinteger
  • 0 - minute(s)
  • 1 - hour(s)
  • 2 - day(s)
  • 3 - week(s)
  • 4 - month(s)
  • 6 - quarters(s)
  • 5 - year(s)
  • 7 - once

  One of 0 1 2 3 4 6 5 7

• time_range_maxstringrequiredread-only
• time_range_availablestringrequiredread-only
• has_schema_mapping_dimensionbooleanrequiredread-only
• feature_smart_naming_conventionstringrequiredread-only
• auto_fetchstringrequiredread-only
• assigned_destinationsarray of objectrequiredread-only
  Items · AssignedDestination

  • target_idintegerrequiredread-only
  • destination_namestringrequiredread-only
  • destination_typestringrequiredread-only
  • enabledbooleanrequiredread-only
  • destination_settingsobjectrequiredread-only
• can_be_fetchedbooleanrequiredread-only

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/datastreams/{id}/extracts/most-recent/download/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "id": 1,
  "uuid": "00000000-0000-0000-0000-000000000000",
  "url": "https://example.com",
  "stack": {
    "id": 1,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "slug": "string",
    "url": "https://example.com",
    "change_url": "string",
    "extracts_url": "string",
    "issues_url": "string",
    "overview_url": "string",
    "permissions": "string"
  },
  "auth": 1,
  "auth_change_url": "string",
  "app_label": "string",
  "name": "string",
  "slug": "string",
  "description": "string",
  "enabled": true,
  "frequency": "string",
  "next_run": "2024-01-01T00:00:00Z",
  "last_fetch": "2024-01-01T00:00:00Z",
  "absolute_url": "string",
  "change_url": "string",
  "extracts_url": "string",
  "fetch_url": "string",
  "overview_url": "string",
  "schema_mapping_url": "string",
  "issues_url": "string",
  "transformers": [
    {
      "id": 1,
      "name": "string",
      "stack": 1,
      "change_url": "string",
      "smart_naming_convention": {
        "id": 1,
        "column_name": "string",
        "datastream_names": "string",
        "delimiters_characters": "string",
        "sorted_columns_names": "string",
        "email_for_error": true,
        "email_for_warning": true,
        "raise_for_warning": true,
        "add_status_columns": true,
        "columns_rule_phrasing": "string"
      }
    }
  ],
  "schedules": [
    {
      "id": 1,
      "cron_preset": "ONCE",
      "cron_type": "string",
      "cron_interval": 1,
      "cron_start_of_day": "string",
      "cron_interval_start": 1,
      "time_range_preset": 0,
      "time_range_preset_label": "string",
      "delta_type": 0,
      "delta_interval": 1,
      "delta_start_of_day": "string",
      "delta_interval_start": 1,
      "fixed_start": "2024-01-01",
      "fixed_end": "2024-01-01",
      "offset_days": 1,
      "not_before_date": "2024-01-01",
      "not_before_time": "string"
    }
  ],
  "datastream_type_id": 1,
  "datastream_type_name": "string",
  "datastream_type_slug": "string",
  "datatype": "Live",
  "actions": "string",
  "overwrite_key_columns": true,
  "manage_extract_names": true,
  "extract_name_keys": "string",
  "retention_type": 1,
  "retention_number": 1,
  "remove_if_empty": true,
  "skip_empty_rows": true,
  "prune_instantly": true,
  "overwrite_datastream": true,
  "overwrite_filename": true,
  "logo_url": "string",
  "extracts_stream_url": "string",
  "active_destination": "string",
  "supports_passive_destinations": true,
  "passive_destinations": "string",
  "columns": "https://example.com",
  "supports_extended_intervals": "string",
  "updated": "2024-01-01T00:00:00Z",
  "created": "2024-01-01T00:00:00Z",
  "creator": "string",
  "has_schema_mapping": true,
  "is_insights_mediaplan": true,
  "cron_type": "string",
  "cron_interval": 1,
  "cron_start_of_day": "string",
  "cron_interval_start": 1,
  "time_range_preset": 0,
  "delta_interval": 1,
  "delta_interval_start": 1,
  "delta_start_of_day": "string",
  "delta_type": 0,
  "time_range_max": "string",
  "time_range_available": "string",
  "has_schema_mapping_dimension": true,
  "feature_smart_naming_convention": "string",
  "auto_fetch": "string",
  "assigned_destinations": [
    {
      "target_id": 1,
      "destination_name": "string",
      "destination_type": "string",
      "enabled": true,
      "destination_settings": {
        "key": null
      }
    }
  ],
  "can_be_fetched": true
}

Get datastreams extracts streaming download

GET/api/datastreams/{id}/extracts/streaming/download/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream.

Responses

200OKapplication/json

Response schema

object APIDatastreamFull

• idintegerrequiredread-only
• uuidstring · uuidrequiredread-only
• urlstring · urirequiredread-only
• stackobjectrequiredread-only
  Attributes · StackBasic

  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • namestringrequired

    Max length 60

  • slugstringrequiredread-only
  • urlstring · urirequiredread-only
  • change_urlstringrequiredread-only
  • extracts_urlstringrequiredread-only
  • issues_urlstringrequiredread-only
  • overview_urlstringrequiredread-only
  • permissionsstringrequiredread-only
• authintegernullable

  Which authorization the datastream uses.

• auth_change_urlstringrequiredread-only
• app_labelstringrequiredread-only
• namestringrequired

  A human readable name. Numbers and special characters are supported.

  Max length 150

• slugstringrequiredread-only
• descriptionstring

  Max length 1000

• enabledboolean

  Streams that are not scheduled will not be fetched automatically.

• frequencystringrequiredread-only
• next_runstring · date-timerequiredread-only
• last_fetchstring · date-timerequiredread-only
• absolute_urlstringrequiredread-only
• change_urlstringrequiredread-only
• extracts_urlstringrequiredread-only
• fetch_urlstringrequiredread-only
• overview_urlstringrequiredread-only
• schema_mapping_urlstringrequiredread-only
• issues_urlstringrequiredread-only
• transformersarray of objectrequiredread-only
  Items · TransformerBasic

  • idintegerrequiredread-only
  • namestringrequired

    Max length 200

  • stackintegernullable
  • change_urlstringrequiredread-only
  • smart_naming_conventionobjectrequiredread-only
    Attributes · SmartNamingConventionSummary

    • idintegerrequiredread-only
    • column_namestringrequiredread-only
    • datastream_namesstringrequiredread-only
    • delimiters_charactersstringrequiredread-only
    • sorted_columns_namesstringrequiredread-only
    • email_for_errorbooleanrequired
    • email_for_warningbooleanrequired
    • raise_for_warningbooleanrequired
    • add_status_columnsbooleanrequired
    • columns_rule_phrasingstringrequiredread-only
• schedulesarray of objectrequiredread-only
  Items · FetchSchedule

  • idintegerrequiredread-only
  • cron_presetstring
    • ONCE - Once
    • CRON_EVERY_DAY - Every day
    • CRON_EVERY_WEEK - Every week
    • CRON_EVERY_MONTH - Every month
    • CRON_EVERY_QUARTER - Every quarter
    • CRON_EVERY_15_MINUTES - Every 15 minutes
    • CRON_EVERY_30_MINUTES - Every 30 minutes
    • CRON_EVERY_HOUR - Every hour
    • CRON_EVERY_2_HOURS - Every 2 hours
    • CRON_EVERY_3_HOURS - Every 3 hours
    • CRON_EVERY_4_HOURS - Every 4 hours
    • CRON_EVERY_5_HOURS - Every 5 hours
    • CRON_EVERY_6_HOURS - Every 6 hours
    • CRON_EVERY_8_HOURS - Every 8 hours
    • CRON_EVERY_12_HOURS - Every 12 hours
    • CRON_EVERY_2_DAYS - Every 2 days
    • CRON_EVERY_30_DAYS - Every 30 days
    • CRON_EVERY_40_DAYS - Every 40 days
    • CRON_EVERY_2_WEEKS - Every 2 weeks
    • CRON_EVERY_4_WEEKS - Every 4 weeks
    • CRON_EVERY_6_MONTHS - Every 6 months
    • CRON_EVERY_YEAR - Every year

    One of ONCE CRON_EVERY_DAY CRON_EVERY_WEEK CRON_EVERY_MONTH CRON_EVERY_QUARTER CRON_EVERY_15_MINUTES CRON_EVERY_30_MINUTES CRON_EVERY_HOUR CRON_EVERY_2_HOURS CRON_EVERY_3_HOURS CRON_EVERY_4_HOURS CRON_EVERY_5_HOURS CRON_EVERY_6_HOURS CRON_EVERY_8_HOURS CRON_EVERY_12_HOURS CRON_EVERY_2_DAYS CRON_EVERY_30_DAYS CRON_EVERY_40_DAYS CRON_EVERY_2_WEEKS CRON_EVERY_4_WEEKS CRON_EVERY_6_MONTHS CRON_EVERY_YEAR

  • cron_typestring

    Defaults to 'day' when omitted on a schedule entry.

  • cron_intervalinteger

    Min 0 · Max 2147483647

  • cron_start_of_daystring · time

    At what time the day starts.

  • cron_interval_startinteger

    Min 0 · Max 32767

  • time_range_presetinteger

    Select one of the time range presets.

    • 0 - Custom Time Range
    • 13 - Yesterday
    • 10 - Today
    • 11 - Current Week
    • 6 - Current Month
    • 7 - Previous Month
    • 17 - Last Quarter
    • 18 - Last 2 Days
    • 16 - Last 3 Days
    • 23 - Last 4 Days
    • 19 - Last 5 Days
    • 24 - Last 6 Days
    • 4 - Last 7 Days
    • 25 - Last 8 Days
    • 26 - Last 9 Days
    • 22 - Last 10 Days
    • 14 - Last 14 Days
    • 15 - Last 28 Days
    • 2 - Last 30 Days
    • 20 - Last 40 Days
    • 21 - Last 60 Days
    • 5 - Last 90 Days
    • 31 - Last 120 Days
    • 28 - Last 180 Days
    • 3 - Last 365 Days
    • 27 - Last 730 Days
    • 8 - Previous Week
    • 9 - Previous Year
    • 29 - Current Quarter
    • 12 - Current Year
    • 30 - Last Hour
    • 1000 - Lifetime
    • 50 - Tomorrow
    • 51 - Next 2 Days
    • 52 - Next 7 Days
    • 53 - Next 30 Days
    • 54 - Current Week (incl Future Days)
    • 55 - Next Week
    • 56 - Current Month (incl Future Days)
    • 57 - Next Month
    • 58 - Current Year (incl Future Days)
    • 59 - Next Year

    One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59 · Min 0 · Max 32767

  • time_range_preset_labelstringrequiredread-only
  • delta_typeinteger
    • 0 - minute(s)
    • 1 - hour(s)
    • 2 - day(s)
    • 3 - week(s)
    • 4 - month(s)
    • 6 - quarters(s)
    • 5 - year(s)
    • 7 - once

    One of 0 1 2 3 4 6 5 7 · Min -32768 · Max 32767

  • delta_intervalinteger

    Min 0 · Max 2147483647

  • delta_start_of_daystring · time

    At what time the day starts.

  • delta_interval_startinteger

    Min 0 · Max 32767

  • fixed_startstring · datenullable

    First day to fetch.

  • fixed_endstring · datenullable

    Last day to fetch.

  • offset_daysinteger

    Number of days to shift the fetched date range into the past.

    Min -32768 · Max 32767

  • not_before_datestring · datenullable

    Do not fetch before this date.

  • not_before_timestring · timenullable

    Do not fetch before this time.

• datastream_type_idintegerrequiredread-only
• datastream_type_namestringrequiredread-only
• datastream_type_slugstringrequiredread-only
• datatypestring

  Projection of destination state: reads Live if any destination is enabled, otherwise Staging. Writing 'Live' enables all destinations and 'Staging' disables them.

  • Live - Live
  • Staging - Staging

  One of Live Staging

• actionsstringrequiredread-only
• overwrite_key_columnsboolean

  Overwrite rows according to Key defined in Data Mapping.

• manage_extract_namesboolean

  Split by selected date column and name extracts with pre-defined pattern to consolidate data.

• extract_name_keysstringnullable

  Max length 128

• retention_typeinteger
  • 1 - Retain all
  • 2 - Retain N fetches
  • 4 - Retain N extracts
  • 3 - Retain N days

  One of 1 2 4 3 · Min 0 · Max 32767

• retention_numberintegernullable

  The amount (N) of fetches/extracts/days to retain (raw extracts are not counted). Must be an integer greater than or equal to zero.

  Min 0 · Max 32767

• remove_if_emptyboolean

  When enabled, fetches resulting in only empty rows ("empty extracts") will be silently discarded.

• skip_empty_rowsboolean

  When enabled, empty data rows in fetches will be silently ignored.

• prune_instantlyboolean

  When enabled, deleted files will not be kept for the configured grace period.

• overwrite_datastreamboolean

  Delete/Drop all existing rows (created by this datastream) in the destination before inserting a new import.

• overwrite_filenameboolean

  Overwrite rows from same extract file.

• logo_urlstringrequiredread-only
• extracts_stream_urlstringrequiredread-only
• active_destinationstringrequiredread-only
• supports_passive_destinationsbooleanrequiredread-only
• passive_destinationsstringrequiredread-only
• columnsstring · urirequiredread-only
• supports_extended_intervalsstringrequiredread-only
• updatedstring · date-timerequiredread-only
• createdstring · date-timerequiredread-only
• creatorstringrequiredread-onlynullable
• has_schema_mappingbooleanrequiredread-only
• is_insights_mediaplanboolean

  If checked, generated extracts will be treated as Insights mediaplans.

• cron_typestring
• cron_intervalinteger

  Min 0

• cron_start_of_daystring · time
• cron_interval_startinteger

  Min 0

• time_range_presetinteger
  • 0 - Custom Time Range
  • 13 - Yesterday
  • 10 - Today
  • 11 - Current Week
  • 6 - Current Month
  • 7 - Previous Month
  • 17 - Last Quarter
  • 18 - Last 2 Days
  • 16 - Last 3 Days
  • 23 - Last 4 Days
  • 19 - Last 5 Days
  • 24 - Last 6 Days
  • 4 - Last 7 Days
  • 25 - Last 8 Days
  • 26 - Last 9 Days
  • 22 - Last 10 Days
  • 14 - Last 14 Days
  • 15 - Last 28 Days
  • 2 - Last 30 Days
  • 20 - Last 40 Days
  • 21 - Last 60 Days
  • 5 - Last 90 Days
  • 31 - Last 120 Days
  • 28 - Last 180 Days
  • 3 - Last 365 Days
  • 27 - Last 730 Days
  • 8 - Previous Week
  • 9 - Previous Year
  • 29 - Current Quarter
  • 12 - Current Year
  • 30 - Last Hour
  • 1000 - Lifetime
  • 50 - Tomorrow
  • 51 - Next 2 Days
  • 52 - Next 7 Days
  • 53 - Next 30 Days
  • 54 - Current Week (incl Future Days)
  • 55 - Next Week
  • 56 - Current Month (incl Future Days)
  • 57 - Next Month
  • 58 - Current Year (incl Future Days)
  • 59 - Next Year

  One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59

• delta_intervalinteger

  Min 0

• delta_interval_startinteger

  Min 0

• delta_start_of_daystring · time
• delta_typeinteger
  • 0 - minute(s)
  • 1 - hour(s)
  • 2 - day(s)
  • 3 - week(s)
  • 4 - month(s)
  • 6 - quarters(s)
  • 5 - year(s)
  • 7 - once

  One of 0 1 2 3 4 6 5 7

• time_range_maxstringrequiredread-only
• time_range_availablestringrequiredread-only
• has_schema_mapping_dimensionbooleanrequiredread-only
• feature_smart_naming_conventionstringrequiredread-only
• auto_fetchstringrequiredread-only
• assigned_destinationsarray of objectrequiredread-only
  Items · AssignedDestination

  • target_idintegerrequiredread-only
  • destination_namestringrequiredread-only
  • destination_typestringrequiredread-only
  • enabledbooleanrequiredread-only
  • destination_settingsobjectrequiredread-only
• can_be_fetchedbooleanrequiredread-only

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/datastreams/{id}/extracts/streaming/download/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "id": 1,
  "uuid": "00000000-0000-0000-0000-000000000000",
  "url": "https://example.com",
  "stack": {
    "id": 1,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "slug": "string",
    "url": "https://example.com",
    "change_url": "string",
    "extracts_url": "string",
    "issues_url": "string",
    "overview_url": "string",
    "permissions": "string"
  },
  "auth": 1,
  "auth_change_url": "string",
  "app_label": "string",
  "name": "string",
  "slug": "string",
  "description": "string",
  "enabled": true,
  "frequency": "string",
  "next_run": "2024-01-01T00:00:00Z",
  "last_fetch": "2024-01-01T00:00:00Z",
  "absolute_url": "string",
  "change_url": "string",
  "extracts_url": "string",
  "fetch_url": "string",
  "overview_url": "string",
  "schema_mapping_url": "string",
  "issues_url": "string",
  "transformers": [
    {
      "id": 1,
      "name": "string",
      "stack": 1,
      "change_url": "string",
      "smart_naming_convention": {
        "id": 1,
        "column_name": "string",
        "datastream_names": "string",
        "delimiters_characters": "string",
        "sorted_columns_names": "string",
        "email_for_error": true,
        "email_for_warning": true,
        "raise_for_warning": true,
        "add_status_columns": true,
        "columns_rule_phrasing": "string"
      }
    }
  ],
  "schedules": [
    {
      "id": 1,
      "cron_preset": "ONCE",
      "cron_type": "string",
      "cron_interval": 1,
      "cron_start_of_day": "string",
      "cron_interval_start": 1,
      "time_range_preset": 0,
      "time_range_preset_label": "string",
      "delta_type": 0,
      "delta_interval": 1,
      "delta_start_of_day": "string",
      "delta_interval_start": 1,
      "fixed_start": "2024-01-01",
      "fixed_end": "2024-01-01",
      "offset_days": 1,
      "not_before_date": "2024-01-01",
      "not_before_time": "string"
    }
  ],
  "datastream_type_id": 1,
  "datastream_type_name": "string",
  "datastream_type_slug": "string",
  "datatype": "Live",
  "actions": "string",
  "overwrite_key_columns": true,
  "manage_extract_names": true,
  "extract_name_keys": "string",
  "retention_type": 1,
  "retention_number": 1,
  "remove_if_empty": true,
  "skip_empty_rows": true,
  "prune_instantly": true,
  "overwrite_datastream": true,
  "overwrite_filename": true,
  "logo_url": "string",
  "extracts_stream_url": "string",
  "active_destination": "string",
  "supports_passive_destinations": true,
  "passive_destinations": "string",
  "columns": "https://example.com",
  "supports_extended_intervals": "string",
  "updated": "2024-01-01T00:00:00Z",
  "created": "2024-01-01T00:00:00Z",
  "creator": "string",
  "has_schema_mapping": true,
  "is_insights_mediaplan": true,
  "cron_type": "string",
  "cron_interval": 1,
  "cron_start_of_day": "string",
  "cron_interval_start": 1,
  "time_range_preset": 0,
  "delta_interval": 1,
  "delta_interval_start": 1,
  "delta_start_of_day": "string",
  "delta_type": 0,
  "time_range_max": "string",
  "time_range_available": "string",
  "has_schema_mapping_dimension": true,
  "feature_smart_naming_convention": "string",
  "auto_fetch": "string",
  "assigned_destinations": [
    {
      "target_id": 1,
      "destination_name": "string",
      "destination_type": "string",
      "enabled": true,
      "destination_settings": {
        "key": null
      }
    }
  ],
  "can_be_fetched": true
}

Get datastreams fetch

GET/api/datastreams/{id}/fetch/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream.

Responses

200OKapplication/json

Response schema

object APIDatastreamFull

• idintegerrequiredread-only
• uuidstring · uuidrequiredread-only
• urlstring · urirequiredread-only
• stackobjectrequiredread-only
  Attributes · StackBasic

  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • namestringrequired

    Max length 60

  • slugstringrequiredread-only
  • urlstring · urirequiredread-only
  • change_urlstringrequiredread-only
  • extracts_urlstringrequiredread-only
  • issues_urlstringrequiredread-only
  • overview_urlstringrequiredread-only
  • permissionsstringrequiredread-only
• authintegernullable

  Which authorization the datastream uses.

• auth_change_urlstringrequiredread-only
• app_labelstringrequiredread-only
• namestringrequired

  A human readable name. Numbers and special characters are supported.

  Max length 150

• slugstringrequiredread-only
• descriptionstring

  Max length 1000

• enabledboolean

  Streams that are not scheduled will not be fetched automatically.

• frequencystringrequiredread-only
• next_runstring · date-timerequiredread-only
• last_fetchstring · date-timerequiredread-only
• absolute_urlstringrequiredread-only
• change_urlstringrequiredread-only
• extracts_urlstringrequiredread-only
• fetch_urlstringrequiredread-only
• overview_urlstringrequiredread-only
• schema_mapping_urlstringrequiredread-only
• issues_urlstringrequiredread-only
• transformersarray of objectrequiredread-only
  Items · TransformerBasic

  • idintegerrequiredread-only
  • namestringrequired

    Max length 200

  • stackintegernullable
  • change_urlstringrequiredread-only
  • smart_naming_conventionobjectrequiredread-only
    Attributes · SmartNamingConventionSummary

    • idintegerrequiredread-only
    • column_namestringrequiredread-only
    • datastream_namesstringrequiredread-only
    • delimiters_charactersstringrequiredread-only
    • sorted_columns_namesstringrequiredread-only
    • email_for_errorbooleanrequired
    • email_for_warningbooleanrequired
    • raise_for_warningbooleanrequired
    • add_status_columnsbooleanrequired
    • columns_rule_phrasingstringrequiredread-only
• schedulesarray of objectrequiredread-only
  Items · FetchSchedule

  • idintegerrequiredread-only
  • cron_presetstring
    • ONCE - Once
    • CRON_EVERY_DAY - Every day
    • CRON_EVERY_WEEK - Every week
    • CRON_EVERY_MONTH - Every month
    • CRON_EVERY_QUARTER - Every quarter
    • CRON_EVERY_15_MINUTES - Every 15 minutes
    • CRON_EVERY_30_MINUTES - Every 30 minutes
    • CRON_EVERY_HOUR - Every hour
    • CRON_EVERY_2_HOURS - Every 2 hours
    • CRON_EVERY_3_HOURS - Every 3 hours
    • CRON_EVERY_4_HOURS - Every 4 hours
    • CRON_EVERY_5_HOURS - Every 5 hours
    • CRON_EVERY_6_HOURS - Every 6 hours
    • CRON_EVERY_8_HOURS - Every 8 hours
    • CRON_EVERY_12_HOURS - Every 12 hours
    • CRON_EVERY_2_DAYS - Every 2 days
    • CRON_EVERY_30_DAYS - Every 30 days
    • CRON_EVERY_40_DAYS - Every 40 days
    • CRON_EVERY_2_WEEKS - Every 2 weeks
    • CRON_EVERY_4_WEEKS - Every 4 weeks
    • CRON_EVERY_6_MONTHS - Every 6 months
    • CRON_EVERY_YEAR - Every year

    One of ONCE CRON_EVERY_DAY CRON_EVERY_WEEK CRON_EVERY_MONTH CRON_EVERY_QUARTER CRON_EVERY_15_MINUTES CRON_EVERY_30_MINUTES CRON_EVERY_HOUR CRON_EVERY_2_HOURS CRON_EVERY_3_HOURS CRON_EVERY_4_HOURS CRON_EVERY_5_HOURS CRON_EVERY_6_HOURS CRON_EVERY_8_HOURS CRON_EVERY_12_HOURS CRON_EVERY_2_DAYS CRON_EVERY_30_DAYS CRON_EVERY_40_DAYS CRON_EVERY_2_WEEKS CRON_EVERY_4_WEEKS CRON_EVERY_6_MONTHS CRON_EVERY_YEAR

  • cron_typestring

    Defaults to 'day' when omitted on a schedule entry.

  • cron_intervalinteger

    Min 0 · Max 2147483647

  • cron_start_of_daystring · time

    At what time the day starts.

  • cron_interval_startinteger

    Min 0 · Max 32767

  • time_range_presetinteger

    Select one of the time range presets.

    • 0 - Custom Time Range
    • 13 - Yesterday
    • 10 - Today
    • 11 - Current Week
    • 6 - Current Month
    • 7 - Previous Month
    • 17 - Last Quarter
    • 18 - Last 2 Days
    • 16 - Last 3 Days
    • 23 - Last 4 Days
    • 19 - Last 5 Days
    • 24 - Last 6 Days
    • 4 - Last 7 Days
    • 25 - Last 8 Days
    • 26 - Last 9 Days
    • 22 - Last 10 Days
    • 14 - Last 14 Days
    • 15 - Last 28 Days
    • 2 - Last 30 Days
    • 20 - Last 40 Days
    • 21 - Last 60 Days
    • 5 - Last 90 Days
    • 31 - Last 120 Days
    • 28 - Last 180 Days
    • 3 - Last 365 Days
    • 27 - Last 730 Days
    • 8 - Previous Week
    • 9 - Previous Year
    • 29 - Current Quarter
    • 12 - Current Year
    • 30 - Last Hour
    • 1000 - Lifetime
    • 50 - Tomorrow
    • 51 - Next 2 Days
    • 52 - Next 7 Days
    • 53 - Next 30 Days
    • 54 - Current Week (incl Future Days)
    • 55 - Next Week
    • 56 - Current Month (incl Future Days)
    • 57 - Next Month
    • 58 - Current Year (incl Future Days)
    • 59 - Next Year

    One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59 · Min 0 · Max 32767

  • time_range_preset_labelstringrequiredread-only
  • delta_typeinteger
    • 0 - minute(s)
    • 1 - hour(s)
    • 2 - day(s)
    • 3 - week(s)
    • 4 - month(s)
    • 6 - quarters(s)
    • 5 - year(s)
    • 7 - once

    One of 0 1 2 3 4 6 5 7 · Min -32768 · Max 32767

  • delta_intervalinteger

    Min 0 · Max 2147483647

  • delta_start_of_daystring · time

    At what time the day starts.

  • delta_interval_startinteger

    Min 0 · Max 32767

  • fixed_startstring · datenullable

    First day to fetch.

  • fixed_endstring · datenullable

    Last day to fetch.

  • offset_daysinteger

    Number of days to shift the fetched date range into the past.

    Min -32768 · Max 32767

  • not_before_datestring · datenullable

    Do not fetch before this date.

  • not_before_timestring · timenullable

    Do not fetch before this time.

• datastream_type_idintegerrequiredread-only
• datastream_type_namestringrequiredread-only
• datastream_type_slugstringrequiredread-only
• datatypestring

  Projection of destination state: reads Live if any destination is enabled, otherwise Staging. Writing 'Live' enables all destinations and 'Staging' disables them.

  • Live - Live
  • Staging - Staging

  One of Live Staging

• actionsstringrequiredread-only
• overwrite_key_columnsboolean

  Overwrite rows according to Key defined in Data Mapping.

• manage_extract_namesboolean

  Split by selected date column and name extracts with pre-defined pattern to consolidate data.

• extract_name_keysstringnullable

  Max length 128

• retention_typeinteger
  • 1 - Retain all
  • 2 - Retain N fetches
  • 4 - Retain N extracts
  • 3 - Retain N days

  One of 1 2 4 3 · Min 0 · Max 32767

• retention_numberintegernullable

  The amount (N) of fetches/extracts/days to retain (raw extracts are not counted). Must be an integer greater than or equal to zero.

  Min 0 · Max 32767

• remove_if_emptyboolean

  When enabled, fetches resulting in only empty rows ("empty extracts") will be silently discarded.

• skip_empty_rowsboolean

  When enabled, empty data rows in fetches will be silently ignored.

• prune_instantlyboolean

  When enabled, deleted files will not be kept for the configured grace period.

• overwrite_datastreamboolean

  Delete/Drop all existing rows (created by this datastream) in the destination before inserting a new import.

• overwrite_filenameboolean

  Overwrite rows from same extract file.

• logo_urlstringrequiredread-only
• extracts_stream_urlstringrequiredread-only
• active_destinationstringrequiredread-only
• supports_passive_destinationsbooleanrequiredread-only
• passive_destinationsstringrequiredread-only
• columnsstring · urirequiredread-only
• supports_extended_intervalsstringrequiredread-only
• updatedstring · date-timerequiredread-only
• createdstring · date-timerequiredread-only
• creatorstringrequiredread-onlynullable
• has_schema_mappingbooleanrequiredread-only
• is_insights_mediaplanboolean

  If checked, generated extracts will be treated as Insights mediaplans.

• cron_typestring
• cron_intervalinteger

  Min 0

• cron_start_of_daystring · time
• cron_interval_startinteger

  Min 0

• time_range_presetinteger
  • 0 - Custom Time Range
  • 13 - Yesterday
  • 10 - Today
  • 11 - Current Week
  • 6 - Current Month
  • 7 - Previous Month
  • 17 - Last Quarter
  • 18 - Last 2 Days
  • 16 - Last 3 Days
  • 23 - Last 4 Days
  • 19 - Last 5 Days
  • 24 - Last 6 Days
  • 4 - Last 7 Days
  • 25 - Last 8 Days
  • 26 - Last 9 Days
  • 22 - Last 10 Days
  • 14 - Last 14 Days
  • 15 - Last 28 Days
  • 2 - Last 30 Days
  • 20 - Last 40 Days
  • 21 - Last 60 Days
  • 5 - Last 90 Days
  • 31 - Last 120 Days
  • 28 - Last 180 Days
  • 3 - Last 365 Days
  • 27 - Last 730 Days
  • 8 - Previous Week
  • 9 - Previous Year
  • 29 - Current Quarter
  • 12 - Current Year
  • 30 - Last Hour
  • 1000 - Lifetime
  • 50 - Tomorrow
  • 51 - Next 2 Days
  • 52 - Next 7 Days
  • 53 - Next 30 Days
  • 54 - Current Week (incl Future Days)
  • 55 - Next Week
  • 56 - Current Month (incl Future Days)
  • 57 - Next Month
  • 58 - Current Year (incl Future Days)
  • 59 - Next Year

  One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59

• delta_intervalinteger

  Min 0

• delta_interval_startinteger

  Min 0

• delta_start_of_daystring · time
• delta_typeinteger
  • 0 - minute(s)
  • 1 - hour(s)
  • 2 - day(s)
  • 3 - week(s)
  • 4 - month(s)
  • 6 - quarters(s)
  • 5 - year(s)
  • 7 - once

  One of 0 1 2 3 4 6 5 7

• time_range_maxstringrequiredread-only
• time_range_availablestringrequiredread-only
• has_schema_mapping_dimensionbooleanrequiredread-only
• feature_smart_naming_conventionstringrequiredread-only
• auto_fetchstringrequiredread-only
• assigned_destinationsarray of objectrequiredread-only
  Items · AssignedDestination

  • target_idintegerrequiredread-only
  • destination_namestringrequiredread-only
  • destination_typestringrequiredread-only
  • enabledbooleanrequiredread-only
  • destination_settingsobjectrequiredread-only
• can_be_fetchedbooleanrequiredread-only

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/datastreams/{id}/fetch/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "id": 1,
  "uuid": "00000000-0000-0000-0000-000000000000",
  "url": "https://example.com",
  "stack": {
    "id": 1,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "slug": "string",
    "url": "https://example.com",
    "change_url": "string",
    "extracts_url": "string",
    "issues_url": "string",
    "overview_url": "string",
    "permissions": "string"
  },
  "auth": 1,
  "auth_change_url": "string",
  "app_label": "string",
  "name": "string",
  "slug": "string",
  "description": "string",
  "enabled": true,
  "frequency": "string",
  "next_run": "2024-01-01T00:00:00Z",
  "last_fetch": "2024-01-01T00:00:00Z",
  "absolute_url": "string",
  "change_url": "string",
  "extracts_url": "string",
  "fetch_url": "string",
  "overview_url": "string",
  "schema_mapping_url": "string",
  "issues_url": "string",
  "transformers": [
    {
      "id": 1,
      "name": "string",
      "stack": 1,
      "change_url": "string",
      "smart_naming_convention": {
        "id": 1,
        "column_name": "string",
        "datastream_names": "string",
        "delimiters_characters": "string",
        "sorted_columns_names": "string",
        "email_for_error": true,
        "email_for_warning": true,
        "raise_for_warning": true,
        "add_status_columns": true,
        "columns_rule_phrasing": "string"
      }
    }
  ],
  "schedules": [
    {
      "id": 1,
      "cron_preset": "ONCE",
      "cron_type": "string",
      "cron_interval": 1,
      "cron_start_of_day": "string",
      "cron_interval_start": 1,
      "time_range_preset": 0,
      "time_range_preset_label": "string",
      "delta_type": 0,
      "delta_interval": 1,
      "delta_start_of_day": "string",
      "delta_interval_start": 1,
      "fixed_start": "2024-01-01",
      "fixed_end": "2024-01-01",
      "offset_days": 1,
      "not_before_date": "2024-01-01",
      "not_before_time": "string"
    }
  ],
  "datastream_type_id": 1,
  "datastream_type_name": "string",
  "datastream_type_slug": "string",
  "datatype": "Live",
  "actions": "string",
  "overwrite_key_columns": true,
  "manage_extract_names": true,
  "extract_name_keys": "string",
  "retention_type": 1,
  "retention_number": 1,
  "remove_if_empty": true,
  "skip_empty_rows": true,
  "prune_instantly": true,
  "overwrite_datastream": true,
  "overwrite_filename": true,
  "logo_url": "string",
  "extracts_stream_url": "string",
  "active_destination": "string",
  "supports_passive_destinations": true,
  "passive_destinations": "string",
  "columns": "https://example.com",
  "supports_extended_intervals": "string",
  "updated": "2024-01-01T00:00:00Z",
  "created": "2024-01-01T00:00:00Z",
  "creator": "string",
  "has_schema_mapping": true,
  "is_insights_mediaplan": true,
  "cron_type": "string",
  "cron_interval": 1,
  "cron_start_of_day": "string",
  "cron_interval_start": 1,
  "time_range_preset": 0,
  "delta_interval": 1,
  "delta_interval_start": 1,
  "delta_start_of_day": "string",
  "delta_type": 0,
  "time_range_max": "string",
  "time_range_available": "string",
  "has_schema_mapping_dimension": true,
  "feature_smart_naming_convention": "string",
  "auto_fetch": "string",
  "assigned_destinations": [
    {
      "target_id": 1,
      "destination_name": "string",
      "destination_type": "string",
      "enabled": true,
      "destination_settings": {
        "key": null
      }
    }
  ],
  "can_be_fetched": true
}

Create datastreams fetch

POST/api/datastreams/{id}/fetch/

API key permissionDatastream: Writedatastream:write

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream.

Request bodyrequired

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object APIDatastreamFull

• stack_idintegerrequiredwrite-only
• authintegernullable

  Which authorization the datastream uses.

• namestringrequired

  A human readable name. Numbers and special characters are supported.

  Max length 150

• descriptionstring

  Max length 1000

• enabledboolean

  Streams that are not scheduled will not be fetched automatically.

• transformer_idsarray of integerrequiredwrite-only
• datatypestring

  Projection of destination state: reads Live if any destination is enabled, otherwise Staging. Writing 'Live' enables all destinations and 'Staging' disables them.

  • Live - Live
  • Staging - Staging

  One of Live Staging

• overwrite_key_columnsboolean

  Overwrite rows according to Key defined in Data Mapping.

• manage_extract_namesboolean

  Split by selected date column and name extracts with pre-defined pattern to consolidate data.

• extract_name_keysstringnullable

  Max length 128

• retention_typeinteger
  • 1 - Retain all
  • 2 - Retain N fetches
  • 4 - Retain N extracts
  • 3 - Retain N days

  One of 1 2 4 3 · Min 0 · Max 32767

• retention_numberintegernullable

  The amount (N) of fetches/extracts/days to retain (raw extracts are not counted). Must be an integer greater than or equal to zero.

  Min 0 · Max 32767

• remove_if_emptyboolean

  When enabled, fetches resulting in only empty rows ("empty extracts") will be silently discarded.

• skip_empty_rowsboolean

  When enabled, empty data rows in fetches will be silently ignored.

• prune_instantlyboolean

  When enabled, deleted files will not be kept for the configured grace period.

• overwrite_datastreamboolean

  Delete/Drop all existing rows (created by this datastream) in the destination before inserting a new import.

• overwrite_filenameboolean

  Overwrite rows from same extract file.

• is_insights_mediaplanboolean

  If checked, generated extracts will be treated as Insights mediaplans.

• cron_typestring
• cron_intervalinteger

  Min 0

• cron_start_of_daystring · time
• cron_interval_startinteger

  Min 0

• time_range_presetinteger
  • 0 - Custom Time Range
  • 13 - Yesterday
  • 10 - Today
  • 11 - Current Week
  • 6 - Current Month
  • 7 - Previous Month
  • 17 - Last Quarter
  • 18 - Last 2 Days
  • 16 - Last 3 Days
  • 23 - Last 4 Days
  • 19 - Last 5 Days
  • 24 - Last 6 Days
  • 4 - Last 7 Days
  • 25 - Last 8 Days
  • 26 - Last 9 Days
  • 22 - Last 10 Days
  • 14 - Last 14 Days
  • 15 - Last 28 Days
  • 2 - Last 30 Days
  • 20 - Last 40 Days
  • 21 - Last 60 Days
  • 5 - Last 90 Days
  • 31 - Last 120 Days
  • 28 - Last 180 Days
  • 3 - Last 365 Days
  • 27 - Last 730 Days
  • 8 - Previous Week
  • 9 - Previous Year
  • 29 - Current Quarter
  • 12 - Current Year
  • 30 - Last Hour
  • 1000 - Lifetime
  • 50 - Tomorrow
  • 51 - Next 2 Days
  • 52 - Next 7 Days
  • 53 - Next 30 Days
  • 54 - Current Week (incl Future Days)
  • 55 - Next Week
  • 56 - Current Month (incl Future Days)
  • 57 - Next Month
  • 58 - Current Year (incl Future Days)
  • 59 - Next Year

  One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59

• delta_intervalinteger

  Min 0

• delta_interval_startinteger

  Min 0

• delta_start_of_daystring · time
• delta_typeinteger
  • 0 - minute(s)
  • 1 - hour(s)
  • 2 - day(s)
  • 3 - week(s)
  • 4 - month(s)
  • 6 - quarters(s)
  • 5 - year(s)
  • 7 - once

  One of 0 1 2 3 4 6 5 7

Responses

200OKapplication/json

Response schema

object APIDatastreamFull

• idintegerrequiredread-only
• uuidstring · uuidrequiredread-only
• urlstring · urirequiredread-only
• stackobjectrequiredread-only
  Attributes · StackBasic

  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • namestringrequired

    Max length 60

  • slugstringrequiredread-only
  • urlstring · urirequiredread-only
  • change_urlstringrequiredread-only
  • extracts_urlstringrequiredread-only
  • issues_urlstringrequiredread-only
  • overview_urlstringrequiredread-only
  • permissionsstringrequiredread-only
• authintegernullable

  Which authorization the datastream uses.

• auth_change_urlstringrequiredread-only
• app_labelstringrequiredread-only
• namestringrequired

  A human readable name. Numbers and special characters are supported.

  Max length 150

• slugstringrequiredread-only
• descriptionstring

  Max length 1000

• enabledboolean

  Streams that are not scheduled will not be fetched automatically.

• frequencystringrequiredread-only
• next_runstring · date-timerequiredread-only
• last_fetchstring · date-timerequiredread-only
• absolute_urlstringrequiredread-only
• change_urlstringrequiredread-only
• extracts_urlstringrequiredread-only
• fetch_urlstringrequiredread-only
• overview_urlstringrequiredread-only
• schema_mapping_urlstringrequiredread-only
• issues_urlstringrequiredread-only
• transformersarray of objectrequiredread-only
  Items · TransformerBasic

  • idintegerrequiredread-only
  • namestringrequired

    Max length 200

  • stackintegernullable
  • change_urlstringrequiredread-only
  • smart_naming_conventionobjectrequiredread-only
    Attributes · SmartNamingConventionSummary

    • idintegerrequiredread-only
    • column_namestringrequiredread-only
    • datastream_namesstringrequiredread-only
    • delimiters_charactersstringrequiredread-only
    • sorted_columns_namesstringrequiredread-only
    • email_for_errorbooleanrequired
    • email_for_warningbooleanrequired
    • raise_for_warningbooleanrequired
    • add_status_columnsbooleanrequired
    • columns_rule_phrasingstringrequiredread-only
• schedulesarray of objectrequiredread-only
  Items · FetchSchedule

  • idintegerrequiredread-only
  • cron_presetstring
    • ONCE - Once
    • CRON_EVERY_DAY - Every day
    • CRON_EVERY_WEEK - Every week
    • CRON_EVERY_MONTH - Every month
    • CRON_EVERY_QUARTER - Every quarter
    • CRON_EVERY_15_MINUTES - Every 15 minutes
    • CRON_EVERY_30_MINUTES - Every 30 minutes
    • CRON_EVERY_HOUR - Every hour
    • CRON_EVERY_2_HOURS - Every 2 hours
    • CRON_EVERY_3_HOURS - Every 3 hours
    • CRON_EVERY_4_HOURS - Every 4 hours
    • CRON_EVERY_5_HOURS - Every 5 hours
    • CRON_EVERY_6_HOURS - Every 6 hours
    • CRON_EVERY_8_HOURS - Every 8 hours
    • CRON_EVERY_12_HOURS - Every 12 hours
    • CRON_EVERY_2_DAYS - Every 2 days
    • CRON_EVERY_30_DAYS - Every 30 days
    • CRON_EVERY_40_DAYS - Every 40 days
    • CRON_EVERY_2_WEEKS - Every 2 weeks
    • CRON_EVERY_4_WEEKS - Every 4 weeks
    • CRON_EVERY_6_MONTHS - Every 6 months
    • CRON_EVERY_YEAR - Every year

    One of ONCE CRON_EVERY_DAY CRON_EVERY_WEEK CRON_EVERY_MONTH CRON_EVERY_QUARTER CRON_EVERY_15_MINUTES CRON_EVERY_30_MINUTES CRON_EVERY_HOUR CRON_EVERY_2_HOURS CRON_EVERY_3_HOURS CRON_EVERY_4_HOURS CRON_EVERY_5_HOURS CRON_EVERY_6_HOURS CRON_EVERY_8_HOURS CRON_EVERY_12_HOURS CRON_EVERY_2_DAYS CRON_EVERY_30_DAYS CRON_EVERY_40_DAYS CRON_EVERY_2_WEEKS CRON_EVERY_4_WEEKS CRON_EVERY_6_MONTHS CRON_EVERY_YEAR

  • cron_typestring

    Defaults to 'day' when omitted on a schedule entry.

  • cron_intervalinteger

    Min 0 · Max 2147483647

  • cron_start_of_daystring · time

    At what time the day starts.

  • cron_interval_startinteger

    Min 0 · Max 32767

  • time_range_presetinteger

    Select one of the time range presets.

    • 0 - Custom Time Range
    • 13 - Yesterday
    • 10 - Today
    • 11 - Current Week
    • 6 - Current Month
    • 7 - Previous Month
    • 17 - Last Quarter
    • 18 - Last 2 Days
    • 16 - Last 3 Days
    • 23 - Last 4 Days
    • 19 - Last 5 Days
    • 24 - Last 6 Days
    • 4 - Last 7 Days
    • 25 - Last 8 Days
    • 26 - Last 9 Days
    • 22 - Last 10 Days
    • 14 - Last 14 Days
    • 15 - Last 28 Days
    • 2 - Last 30 Days
    • 20 - Last 40 Days
    • 21 - Last 60 Days
    • 5 - Last 90 Days
    • 31 - Last 120 Days
    • 28 - Last 180 Days
    • 3 - Last 365 Days
    • 27 - Last 730 Days
    • 8 - Previous Week
    • 9 - Previous Year
    • 29 - Current Quarter
    • 12 - Current Year
    • 30 - Last Hour
    • 1000 - Lifetime
    • 50 - Tomorrow
    • 51 - Next 2 Days
    • 52 - Next 7 Days
    • 53 - Next 30 Days
    • 54 - Current Week (incl Future Days)
    • 55 - Next Week
    • 56 - Current Month (incl Future Days)
    • 57 - Next Month
    • 58 - Current Year (incl Future Days)
    • 59 - Next Year

    One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59 · Min 0 · Max 32767

  • time_range_preset_labelstringrequiredread-only
  • delta_typeinteger
    • 0 - minute(s)
    • 1 - hour(s)
    • 2 - day(s)
    • 3 - week(s)
    • 4 - month(s)
    • 6 - quarters(s)
    • 5 - year(s)
    • 7 - once

    One of 0 1 2 3 4 6 5 7 · Min -32768 · Max 32767

  • delta_intervalinteger

    Min 0 · Max 2147483647

  • delta_start_of_daystring · time

    At what time the day starts.

  • delta_interval_startinteger

    Min 0 · Max 32767

  • fixed_startstring · datenullable

    First day to fetch.

  • fixed_endstring · datenullable

    Last day to fetch.

  • offset_daysinteger

    Number of days to shift the fetched date range into the past.

    Min -32768 · Max 32767

  • not_before_datestring · datenullable

    Do not fetch before this date.

  • not_before_timestring · timenullable

    Do not fetch before this time.

• datastream_type_idintegerrequiredread-only
• datastream_type_namestringrequiredread-only
• datastream_type_slugstringrequiredread-only
• datatypestring

  Projection of destination state: reads Live if any destination is enabled, otherwise Staging. Writing 'Live' enables all destinations and 'Staging' disables them.

  • Live - Live
  • Staging - Staging

  One of Live Staging

• actionsstringrequiredread-only
• overwrite_key_columnsboolean

  Overwrite rows according to Key defined in Data Mapping.

• manage_extract_namesboolean

  Split by selected date column and name extracts with pre-defined pattern to consolidate data.

• extract_name_keysstringnullable

  Max length 128

• retention_typeinteger
  • 1 - Retain all
  • 2 - Retain N fetches
  • 4 - Retain N extracts
  • 3 - Retain N days

  One of 1 2 4 3 · Min 0 · Max 32767

• retention_numberintegernullable

  The amount (N) of fetches/extracts/days to retain (raw extracts are not counted). Must be an integer greater than or equal to zero.

  Min 0 · Max 32767

• remove_if_emptyboolean

  When enabled, fetches resulting in only empty rows ("empty extracts") will be silently discarded.

• skip_empty_rowsboolean

  When enabled, empty data rows in fetches will be silently ignored.

• prune_instantlyboolean

  When enabled, deleted files will not be kept for the configured grace period.

• overwrite_datastreamboolean

  Delete/Drop all existing rows (created by this datastream) in the destination before inserting a new import.

• overwrite_filenameboolean

  Overwrite rows from same extract file.

• logo_urlstringrequiredread-only
• extracts_stream_urlstringrequiredread-only
• active_destinationstringrequiredread-only
• supports_passive_destinationsbooleanrequiredread-only
• passive_destinationsstringrequiredread-only
• columnsstring · urirequiredread-only
• supports_extended_intervalsstringrequiredread-only
• updatedstring · date-timerequiredread-only
• createdstring · date-timerequiredread-only
• creatorstringrequiredread-onlynullable
• has_schema_mappingbooleanrequiredread-only
• is_insights_mediaplanboolean

  If checked, generated extracts will be treated as Insights mediaplans.

• cron_typestring
• cron_intervalinteger

  Min 0

• cron_start_of_daystring · time
• cron_interval_startinteger

  Min 0

• time_range_presetinteger
  • 0 - Custom Time Range
  • 13 - Yesterday
  • 10 - Today
  • 11 - Current Week
  • 6 - Current Month
  • 7 - Previous Month
  • 17 - Last Quarter
  • 18 - Last 2 Days
  • 16 - Last 3 Days
  • 23 - Last 4 Days
  • 19 - Last 5 Days
  • 24 - Last 6 Days
  • 4 - Last 7 Days
  • 25 - Last 8 Days
  • 26 - Last 9 Days
  • 22 - Last 10 Days
  • 14 - Last 14 Days
  • 15 - Last 28 Days
  • 2 - Last 30 Days
  • 20 - Last 40 Days
  • 21 - Last 60 Days
  • 5 - Last 90 Days
  • 31 - Last 120 Days
  • 28 - Last 180 Days
  • 3 - Last 365 Days
  • 27 - Last 730 Days
  • 8 - Previous Week
  • 9 - Previous Year
  • 29 - Current Quarter
  • 12 - Current Year
  • 30 - Last Hour
  • 1000 - Lifetime
  • 50 - Tomorrow
  • 51 - Next 2 Days
  • 52 - Next 7 Days
  • 53 - Next 30 Days
  • 54 - Current Week (incl Future Days)
  • 55 - Next Week
  • 56 - Current Month (incl Future Days)
  • 57 - Next Month
  • 58 - Current Year (incl Future Days)
  • 59 - Next Year

  One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59

• delta_intervalinteger

  Min 0

• delta_interval_startinteger

  Min 0

• delta_start_of_daystring · time
• delta_typeinteger
  • 0 - minute(s)
  • 1 - hour(s)
  • 2 - day(s)
  • 3 - week(s)
  • 4 - month(s)
  • 6 - quarters(s)
  • 5 - year(s)
  • 7 - once

  One of 0 1 2 3 4 6 5 7

• time_range_maxstringrequiredread-only
• time_range_availablestringrequiredread-only
• has_schema_mapping_dimensionbooleanrequiredread-only
• feature_smart_naming_conventionstringrequiredread-only
• auto_fetchstringrequiredread-only
• assigned_destinationsarray of objectrequiredread-only
  Items · AssignedDestination

  • target_idintegerrequiredread-only
  • destination_namestringrequiredread-only
  • destination_typestringrequiredread-only
  • enabledbooleanrequiredread-only
  • destination_settingsobjectrequiredread-only
• can_be_fetchedbooleanrequiredread-only

RequestcURL

curl --request POST 'https://{{INSTANCE}}/api/datastreams/{id}/fetch/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "stack_id": 1,
    "auth": 1,
    "name": "string",
    "description": "string",
    "enabled": true,
    "transformer_ids": [
      1
    ],
    "datatype": "Live",
    "overwrite_key_columns": true,
    "manage_extract_names": true,
    "extract_name_keys": "string",
    "retention_type": 1,
    "retention_number": 1,
    "remove_if_empty": true,
    "skip_empty_rows": true,
    "prune_instantly": true,
    "overwrite_datastream": true,
    "overwrite_filename": true,
    "is_insights_mediaplan": true,
    "cron_type": "string",
    "cron_interval": 1,
    "cron_start_of_day": "string",
    "cron_interval_start": 1,
    "time_range_preset": 0,
    "delta_interval": 1,
    "delta_interval_start": 1,
    "delta_start_of_day": "string",
    "delta_type": 0
  }'

Response200

{
  "id": 1,
  "uuid": "00000000-0000-0000-0000-000000000000",
  "url": "https://example.com",
  "stack": {
    "id": 1,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "slug": "string",
    "url": "https://example.com",
    "change_url": "string",
    "extracts_url": "string",
    "issues_url": "string",
    "overview_url": "string",
    "permissions": "string"
  },
  "auth": 1,
  "auth_change_url": "string",
  "app_label": "string",
  "name": "string",
  "slug": "string",
  "description": "string",
  "enabled": true,
  "frequency": "string",
  "next_run": "2024-01-01T00:00:00Z",
  "last_fetch": "2024-01-01T00:00:00Z",
  "absolute_url": "string",
  "change_url": "string",
  "extracts_url": "string",
  "fetch_url": "string",
  "overview_url": "string",
  "schema_mapping_url": "string",
  "issues_url": "string",
  "transformers": [
    {
      "id": 1,
      "name": "string",
      "stack": 1,
      "change_url": "string",
      "smart_naming_convention": {
        "id": 1,
        "column_name": "string",
        "datastream_names": "string",
        "delimiters_characters": "string",
        "sorted_columns_names": "string",
        "email_for_error": true,
        "email_for_warning": true,
        "raise_for_warning": true,
        "add_status_columns": true,
        "columns_rule_phrasing": "string"
      }
    }
  ],
  "schedules": [
    {
      "id": 1,
      "cron_preset": "ONCE",
      "cron_type": "string",
      "cron_interval": 1,
      "cron_start_of_day": "string",
      "cron_interval_start": 1,
      "time_range_preset": 0,
      "time_range_preset_label": "string",
      "delta_type": 0,
      "delta_interval": 1,
      "delta_start_of_day": "string",
      "delta_interval_start": 1,
      "fixed_start": "2024-01-01",
      "fixed_end": "2024-01-01",
      "offset_days": 1,
      "not_before_date": "2024-01-01",
      "not_before_time": "string"
    }
  ],
  "datastream_type_id": 1,
  "datastream_type_name": "string",
  "datastream_type_slug": "string",
  "datatype": "Live",
  "actions": "string",
  "overwrite_key_columns": true,
  "manage_extract_names": true,
  "extract_name_keys": "string",
  "retention_type": 1,
  "retention_number": 1,
  "remove_if_empty": true,
  "skip_empty_rows": true,
  "prune_instantly": true,
  "overwrite_datastream": true,
  "overwrite_filename": true,
  "logo_url": "string",
  "extracts_stream_url": "string",
  "active_destination": "string",
  "supports_passive_destinations": true,
  "passive_destinations": "string",
  "columns": "https://example.com",
  "supports_extended_intervals": "string",
  "updated": "2024-01-01T00:00:00Z",
  "created": "2024-01-01T00:00:00Z",
  "creator": "string",
  "has_schema_mapping": true,
  "is_insights_mediaplan": true,
  "cron_type": "string",
  "cron_interval": 1,
  "cron_start_of_day": "string",
  "cron_interval_start": 1,
  "time_range_preset": 0,
  "delta_interval": 1,
  "delta_interval_start": 1,
  "delta_start_of_day": "string",
  "delta_type": 0,
  "time_range_max": "string",
  "time_range_available": "string",
  "has_schema_mapping_dimension": true,
  "feature_smart_naming_convention": "string",
  "auto_fetch": "string",
  "assigned_destinations": [
    {
      "target_id": 1,
      "destination_name": "string",
      "destination_type": "string",
      "enabled": true,
      "destination_settings": {
        "key": null
      }
    }
  ],
  "can_be_fetched": true
}

Create datastreams fetch fixed

POST/api/datastreams/{id}/fetch_fixed/

API key permissionDatastream: Writedatastream:write

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream.

Request bodyrequired

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object APIDatastreamFull

• stack_idintegerrequiredwrite-only
• authintegernullable

  Which authorization the datastream uses.

• namestringrequired

  A human readable name. Numbers and special characters are supported.

  Max length 150

• descriptionstring

  Max length 1000

• enabledboolean

  Streams that are not scheduled will not be fetched automatically.

• transformer_idsarray of integerrequiredwrite-only
• datatypestring

  Projection of destination state: reads Live if any destination is enabled, otherwise Staging. Writing 'Live' enables all destinations and 'Staging' disables them.

  • Live - Live
  • Staging - Staging

  One of Live Staging

• overwrite_key_columnsboolean

  Overwrite rows according to Key defined in Data Mapping.

• manage_extract_namesboolean

  Split by selected date column and name extracts with pre-defined pattern to consolidate data.

• extract_name_keysstringnullable

  Max length 128

• retention_typeinteger
  • 1 - Retain all
  • 2 - Retain N fetches
  • 4 - Retain N extracts
  • 3 - Retain N days

  One of 1 2 4 3 · Min 0 · Max 32767

• retention_numberintegernullable

  The amount (N) of fetches/extracts/days to retain (raw extracts are not counted). Must be an integer greater than or equal to zero.

  Min 0 · Max 32767

• remove_if_emptyboolean

  When enabled, fetches resulting in only empty rows ("empty extracts") will be silently discarded.

• skip_empty_rowsboolean

  When enabled, empty data rows in fetches will be silently ignored.

• prune_instantlyboolean

  When enabled, deleted files will not be kept for the configured grace period.

• overwrite_datastreamboolean

  Delete/Drop all existing rows (created by this datastream) in the destination before inserting a new import.

• overwrite_filenameboolean

  Overwrite rows from same extract file.

• is_insights_mediaplanboolean

  If checked, generated extracts will be treated as Insights mediaplans.

• cron_typestring
• cron_intervalinteger

  Min 0

• cron_start_of_daystring · time
• cron_interval_startinteger

  Min 0

• time_range_presetinteger
  • 0 - Custom Time Range
  • 13 - Yesterday
  • 10 - Today
  • 11 - Current Week
  • 6 - Current Month
  • 7 - Previous Month
  • 17 - Last Quarter
  • 18 - Last 2 Days
  • 16 - Last 3 Days
  • 23 - Last 4 Days
  • 19 - Last 5 Days
  • 24 - Last 6 Days
  • 4 - Last 7 Days
  • 25 - Last 8 Days
  • 26 - Last 9 Days
  • 22 - Last 10 Days
  • 14 - Last 14 Days
  • 15 - Last 28 Days
  • 2 - Last 30 Days
  • 20 - Last 40 Days
  • 21 - Last 60 Days
  • 5 - Last 90 Days
  • 31 - Last 120 Days
  • 28 - Last 180 Days
  • 3 - Last 365 Days
  • 27 - Last 730 Days
  • 8 - Previous Week
  • 9 - Previous Year
  • 29 - Current Quarter
  • 12 - Current Year
  • 30 - Last Hour
  • 1000 - Lifetime
  • 50 - Tomorrow
  • 51 - Next 2 Days
  • 52 - Next 7 Days
  • 53 - Next 30 Days
  • 54 - Current Week (incl Future Days)
  • 55 - Next Week
  • 56 - Current Month (incl Future Days)
  • 57 - Next Month
  • 58 - Current Year (incl Future Days)
  • 59 - Next Year

  One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59

• delta_intervalinteger

  Min 0

• delta_interval_startinteger

  Min 0

• delta_start_of_daystring · time
• delta_typeinteger
  • 0 - minute(s)
  • 1 - hour(s)
  • 2 - day(s)
  • 3 - week(s)
  • 4 - month(s)
  • 6 - quarters(s)
  • 5 - year(s)
  • 7 - once

  One of 0 1 2 3 4 6 5 7

Responses

200OKapplication/json

Response schema

object APIDatastreamFull

• idintegerrequiredread-only
• uuidstring · uuidrequiredread-only
• urlstring · urirequiredread-only
• stackobjectrequiredread-only
  Attributes · StackBasic

  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • namestringrequired

    Max length 60

  • slugstringrequiredread-only
  • urlstring · urirequiredread-only
  • change_urlstringrequiredread-only
  • extracts_urlstringrequiredread-only
  • issues_urlstringrequiredread-only
  • overview_urlstringrequiredread-only
  • permissionsstringrequiredread-only
• authintegernullable

  Which authorization the datastream uses.

• auth_change_urlstringrequiredread-only
• app_labelstringrequiredread-only
• namestringrequired

  A human readable name. Numbers and special characters are supported.

  Max length 150

• slugstringrequiredread-only
• descriptionstring

  Max length 1000

• enabledboolean

  Streams that are not scheduled will not be fetched automatically.

• frequencystringrequiredread-only
• next_runstring · date-timerequiredread-only
• last_fetchstring · date-timerequiredread-only
• absolute_urlstringrequiredread-only
• change_urlstringrequiredread-only
• extracts_urlstringrequiredread-only
• fetch_urlstringrequiredread-only
• overview_urlstringrequiredread-only
• schema_mapping_urlstringrequiredread-only
• issues_urlstringrequiredread-only
• transformersarray of objectrequiredread-only
  Items · TransformerBasic

  • idintegerrequiredread-only
  • namestringrequired

    Max length 200

  • stackintegernullable
  • change_urlstringrequiredread-only
  • smart_naming_conventionobjectrequiredread-only
    Attributes · SmartNamingConventionSummary

    • idintegerrequiredread-only
    • column_namestringrequiredread-only
    • datastream_namesstringrequiredread-only
    • delimiters_charactersstringrequiredread-only
    • sorted_columns_namesstringrequiredread-only
    • email_for_errorbooleanrequired
    • email_for_warningbooleanrequired
    • raise_for_warningbooleanrequired
    • add_status_columnsbooleanrequired
    • columns_rule_phrasingstringrequiredread-only
• schedulesarray of objectrequiredread-only
  Items · FetchSchedule

  • idintegerrequiredread-only
  • cron_presetstring
    • ONCE - Once
    • CRON_EVERY_DAY - Every day
    • CRON_EVERY_WEEK - Every week
    • CRON_EVERY_MONTH - Every month
    • CRON_EVERY_QUARTER - Every quarter
    • CRON_EVERY_15_MINUTES - Every 15 minutes
    • CRON_EVERY_30_MINUTES - Every 30 minutes
    • CRON_EVERY_HOUR - Every hour
    • CRON_EVERY_2_HOURS - Every 2 hours
    • CRON_EVERY_3_HOURS - Every 3 hours
    • CRON_EVERY_4_HOURS - Every 4 hours
    • CRON_EVERY_5_HOURS - Every 5 hours
    • CRON_EVERY_6_HOURS - Every 6 hours
    • CRON_EVERY_8_HOURS - Every 8 hours
    • CRON_EVERY_12_HOURS - Every 12 hours
    • CRON_EVERY_2_DAYS - Every 2 days
    • CRON_EVERY_30_DAYS - Every 30 days
    • CRON_EVERY_40_DAYS - Every 40 days
    • CRON_EVERY_2_WEEKS - Every 2 weeks
    • CRON_EVERY_4_WEEKS - Every 4 weeks
    • CRON_EVERY_6_MONTHS - Every 6 months
    • CRON_EVERY_YEAR - Every year

    One of ONCE CRON_EVERY_DAY CRON_EVERY_WEEK CRON_EVERY_MONTH CRON_EVERY_QUARTER CRON_EVERY_15_MINUTES CRON_EVERY_30_MINUTES CRON_EVERY_HOUR CRON_EVERY_2_HOURS CRON_EVERY_3_HOURS CRON_EVERY_4_HOURS CRON_EVERY_5_HOURS CRON_EVERY_6_HOURS CRON_EVERY_8_HOURS CRON_EVERY_12_HOURS CRON_EVERY_2_DAYS CRON_EVERY_30_DAYS CRON_EVERY_40_DAYS CRON_EVERY_2_WEEKS CRON_EVERY_4_WEEKS CRON_EVERY_6_MONTHS CRON_EVERY_YEAR

  • cron_typestring

    Defaults to 'day' when omitted on a schedule entry.

  • cron_intervalinteger

    Min 0 · Max 2147483647

  • cron_start_of_daystring · time

    At what time the day starts.

  • cron_interval_startinteger

    Min 0 · Max 32767

  • time_range_presetinteger

    Select one of the time range presets.

    • 0 - Custom Time Range
    • 13 - Yesterday
    • 10 - Today
    • 11 - Current Week
    • 6 - Current Month
    • 7 - Previous Month
    • 17 - Last Quarter
    • 18 - Last 2 Days
    • 16 - Last 3 Days
    • 23 - Last 4 Days
    • 19 - Last 5 Days
    • 24 - Last 6 Days
    • 4 - Last 7 Days
    • 25 - Last 8 Days
    • 26 - Last 9 Days
    • 22 - Last 10 Days
    • 14 - Last 14 Days
    • 15 - Last 28 Days
    • 2 - Last 30 Days
    • 20 - Last 40 Days
    • 21 - Last 60 Days
    • 5 - Last 90 Days
    • 31 - Last 120 Days
    • 28 - Last 180 Days
    • 3 - Last 365 Days
    • 27 - Last 730 Days
    • 8 - Previous Week
    • 9 - Previous Year
    • 29 - Current Quarter
    • 12 - Current Year
    • 30 - Last Hour
    • 1000 - Lifetime
    • 50 - Tomorrow
    • 51 - Next 2 Days
    • 52 - Next 7 Days
    • 53 - Next 30 Days
    • 54 - Current Week (incl Future Days)
    • 55 - Next Week
    • 56 - Current Month (incl Future Days)
    • 57 - Next Month
    • 58 - Current Year (incl Future Days)
    • 59 - Next Year

    One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59 · Min 0 · Max 32767

  • time_range_preset_labelstringrequiredread-only
  • delta_typeinteger
    • 0 - minute(s)
    • 1 - hour(s)
    • 2 - day(s)
    • 3 - week(s)
    • 4 - month(s)
    • 6 - quarters(s)
    • 5 - year(s)
    • 7 - once

    One of 0 1 2 3 4 6 5 7 · Min -32768 · Max 32767

  • delta_intervalinteger

    Min 0 · Max 2147483647

  • delta_start_of_daystring · time

    At what time the day starts.

  • delta_interval_startinteger

    Min 0 · Max 32767

  • fixed_startstring · datenullable

    First day to fetch.

  • fixed_endstring · datenullable

    Last day to fetch.

  • offset_daysinteger

    Number of days to shift the fetched date range into the past.

    Min -32768 · Max 32767

  • not_before_datestring · datenullable

    Do not fetch before this date.

  • not_before_timestring · timenullable

    Do not fetch before this time.

• datastream_type_idintegerrequiredread-only
• datastream_type_namestringrequiredread-only
• datastream_type_slugstringrequiredread-only
• datatypestring

  Projection of destination state: reads Live if any destination is enabled, otherwise Staging. Writing 'Live' enables all destinations and 'Staging' disables them.

  • Live - Live
  • Staging - Staging

  One of Live Staging

• actionsstringrequiredread-only
• overwrite_key_columnsboolean

  Overwrite rows according to Key defined in Data Mapping.

• manage_extract_namesboolean

  Split by selected date column and name extracts with pre-defined pattern to consolidate data.

• extract_name_keysstringnullable

  Max length 128

• retention_typeinteger
  • 1 - Retain all
  • 2 - Retain N fetches
  • 4 - Retain N extracts
  • 3 - Retain N days

  One of 1 2 4 3 · Min 0 · Max 32767

• retention_numberintegernullable

  The amount (N) of fetches/extracts/days to retain (raw extracts are not counted). Must be an integer greater than or equal to zero.

  Min 0 · Max 32767

• remove_if_emptyboolean

  When enabled, fetches resulting in only empty rows ("empty extracts") will be silently discarded.

• skip_empty_rowsboolean

  When enabled, empty data rows in fetches will be silently ignored.

• prune_instantlyboolean

  When enabled, deleted files will not be kept for the configured grace period.

• overwrite_datastreamboolean

  Delete/Drop all existing rows (created by this datastream) in the destination before inserting a new import.

• overwrite_filenameboolean

  Overwrite rows from same extract file.

• logo_urlstringrequiredread-only
• extracts_stream_urlstringrequiredread-only
• active_destinationstringrequiredread-only
• supports_passive_destinationsbooleanrequiredread-only
• passive_destinationsstringrequiredread-only
• columnsstring · urirequiredread-only
• supports_extended_intervalsstringrequiredread-only
• updatedstring · date-timerequiredread-only
• createdstring · date-timerequiredread-only
• creatorstringrequiredread-onlynullable
• has_schema_mappingbooleanrequiredread-only
• is_insights_mediaplanboolean

  If checked, generated extracts will be treated as Insights mediaplans.

• cron_typestring
• cron_intervalinteger

  Min 0

• cron_start_of_daystring · time
• cron_interval_startinteger

  Min 0

• time_range_presetinteger
  • 0 - Custom Time Range
  • 13 - Yesterday
  • 10 - Today
  • 11 - Current Week
  • 6 - Current Month
  • 7 - Previous Month
  • 17 - Last Quarter
  • 18 - Last 2 Days
  • 16 - Last 3 Days
  • 23 - Last 4 Days
  • 19 - Last 5 Days
  • 24 - Last 6 Days
  • 4 - Last 7 Days
  • 25 - Last 8 Days
  • 26 - Last 9 Days
  • 22 - Last 10 Days
  • 14 - Last 14 Days
  • 15 - Last 28 Days
  • 2 - Last 30 Days
  • 20 - Last 40 Days
  • 21 - Last 60 Days
  • 5 - Last 90 Days
  • 31 - Last 120 Days
  • 28 - Last 180 Days
  • 3 - Last 365 Days
  • 27 - Last 730 Days
  • 8 - Previous Week
  • 9 - Previous Year
  • 29 - Current Quarter
  • 12 - Current Year
  • 30 - Last Hour
  • 1000 - Lifetime
  • 50 - Tomorrow
  • 51 - Next 2 Days
  • 52 - Next 7 Days
  • 53 - Next 30 Days
  • 54 - Current Week (incl Future Days)
  • 55 - Next Week
  • 56 - Current Month (incl Future Days)
  • 57 - Next Month
  • 58 - Current Year (incl Future Days)
  • 59 - Next Year

  One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59

• delta_intervalinteger

  Min 0

• delta_interval_startinteger

  Min 0

• delta_start_of_daystring · time
• delta_typeinteger
  • 0 - minute(s)
  • 1 - hour(s)
  • 2 - day(s)
  • 3 - week(s)
  • 4 - month(s)
  • 6 - quarters(s)
  • 5 - year(s)
  • 7 - once

  One of 0 1 2 3 4 6 5 7

• time_range_maxstringrequiredread-only
• time_range_availablestringrequiredread-only
• has_schema_mapping_dimensionbooleanrequiredread-only
• feature_smart_naming_conventionstringrequiredread-only
• auto_fetchstringrequiredread-only
• assigned_destinationsarray of objectrequiredread-only
  Items · AssignedDestination

  • target_idintegerrequiredread-only
  • destination_namestringrequiredread-only
  • destination_typestringrequiredread-only
  • enabledbooleanrequiredread-only
  • destination_settingsobjectrequiredread-only
• can_be_fetchedbooleanrequiredread-only

RequestcURL

curl --request POST 'https://{{INSTANCE}}/api/datastreams/{id}/fetch_fixed/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "stack_id": 1,
    "auth": 1,
    "name": "string",
    "description": "string",
    "enabled": true,
    "transformer_ids": [
      1
    ],
    "datatype": "Live",
    "overwrite_key_columns": true,
    "manage_extract_names": true,
    "extract_name_keys": "string",
    "retention_type": 1,
    "retention_number": 1,
    "remove_if_empty": true,
    "skip_empty_rows": true,
    "prune_instantly": true,
    "overwrite_datastream": true,
    "overwrite_filename": true,
    "is_insights_mediaplan": true,
    "cron_type": "string",
    "cron_interval": 1,
    "cron_start_of_day": "string",
    "cron_interval_start": 1,
    "time_range_preset": 0,
    "delta_interval": 1,
    "delta_interval_start": 1,
    "delta_start_of_day": "string",
    "delta_type": 0
  }'

Response200

{
  "id": 1,
  "uuid": "00000000-0000-0000-0000-000000000000",
  "url": "https://example.com",
  "stack": {
    "id": 1,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "slug": "string",
    "url": "https://example.com",
    "change_url": "string",
    "extracts_url": "string",
    "issues_url": "string",
    "overview_url": "string",
    "permissions": "string"
  },
  "auth": 1,
  "auth_change_url": "string",
  "app_label": "string",
  "name": "string",
  "slug": "string",
  "description": "string",
  "enabled": true,
  "frequency": "string",
  "next_run": "2024-01-01T00:00:00Z",
  "last_fetch": "2024-01-01T00:00:00Z",
  "absolute_url": "string",
  "change_url": "string",
  "extracts_url": "string",
  "fetch_url": "string",
  "overview_url": "string",
  "schema_mapping_url": "string",
  "issues_url": "string",
  "transformers": [
    {
      "id": 1,
      "name": "string",
      "stack": 1,
      "change_url": "string",
      "smart_naming_convention": {
        "id": 1,
        "column_name": "string",
        "datastream_names": "string",
        "delimiters_characters": "string",
        "sorted_columns_names": "string",
        "email_for_error": true,
        "email_for_warning": true,
        "raise_for_warning": true,
        "add_status_columns": true,
        "columns_rule_phrasing": "string"
      }
    }
  ],
  "schedules": [
    {
      "id": 1,
      "cron_preset": "ONCE",
      "cron_type": "string",
      "cron_interval": 1,
      "cron_start_of_day": "string",
      "cron_interval_start": 1,
      "time_range_preset": 0,
      "time_range_preset_label": "string",
      "delta_type": 0,
      "delta_interval": 1,
      "delta_start_of_day": "string",
      "delta_interval_start": 1,
      "fixed_start": "2024-01-01",
      "fixed_end": "2024-01-01",
      "offset_days": 1,
      "not_before_date": "2024-01-01",
      "not_before_time": "string"
    }
  ],
  "datastream_type_id": 1,
  "datastream_type_name": "string",
  "datastream_type_slug": "string",
  "datatype": "Live",
  "actions": "string",
  "overwrite_key_columns": true,
  "manage_extract_names": true,
  "extract_name_keys": "string",
  "retention_type": 1,
  "retention_number": 1,
  "remove_if_empty": true,
  "skip_empty_rows": true,
  "prune_instantly": true,
  "overwrite_datastream": true,
  "overwrite_filename": true,
  "logo_url": "string",
  "extracts_stream_url": "string",
  "active_destination": "string",
  "supports_passive_destinations": true,
  "passive_destinations": "string",
  "columns": "https://example.com",
  "supports_extended_intervals": "string",
  "updated": "2024-01-01T00:00:00Z",
  "created": "2024-01-01T00:00:00Z",
  "creator": "string",
  "has_schema_mapping": true,
  "is_insights_mediaplan": true,
  "cron_type": "string",
  "cron_interval": 1,
  "cron_start_of_day": "string",
  "cron_interval_start": 1,
  "time_range_preset": 0,
  "delta_interval": 1,
  "delta_interval_start": 1,
  "delta_start_of_day": "string",
  "delta_type": 0,
  "time_range_max": "string",
  "time_range_available": "string",
  "has_schema_mapping_dimension": true,
  "feature_smart_naming_convention": "string",
  "auto_fetch": "string",
  "assigned_destinations": [
    {
      "target_id": 1,
      "destination_name": "string",
      "destination_type": "string",
      "enabled": true,
      "destination_settings": {
        "key": null
      }
    }
  ],
  "can_be_fetched": true
}

List datastreams jobs

GET/api/datastreams/{id}/jobs/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream.

Query parameters

• pageinteger

  A page number within the paginated result set.

• page_sizeinteger

  Number of results to return per page.

Responses

200OKapplication/json

Response schema

object PaginatedFetchJobList

• countintegerrequired

  Example 123

• nextstring · urinullable

  Example "http://api.example.org/accounts/?page=4"

• previousstring · urinullable

  Example "http://api.example.org/accounts/?page=2"

• resultsarray of objectrequired
  Items · FetchJob

  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • urlstring · urirequiredread-only
  • job_startstring · date-timerequiredread-only
  • job_endstring · date-timerequiredread-only
  • progressstringrequiredread-only
  • statestringrequiredread-only
  • state_labelstringrequiredread-only

    Display label for the job state. "Retrying" while the job is waiting out a retry/backoff; otherwise the label matching state. state itself is unchanged while "Retrying". The signal is derived per job group, so while a group waits out a backoff every running job in it reports the label, regardless of which stage's task is being retried.

  • state_colorstringrequiredread-only
  • datastreamobjectrequiredread-onlynullable
    Attributes

    • APIDatastreamBasic

      • idintegerrequiredread-only
      • uuidstring · uuidrequiredread-only
      • stackobjectrequiredread-only
        Attributes · StackBasic

        • idintegerrequiredread-only
        • uuidstring · uuidrequiredread-only
        • namestringrequired

          Max length 60

        • slugstringrequiredread-only
        • urlstring · urirequiredread-only
        • change_urlstringrequiredread-only
        • extracts_urlstringrequiredread-only
        • issues_urlstringrequiredread-only
        • overview_urlstringrequiredread-only
        • permissionsstringrequiredread-only
      • stack_idintegerrequiredread-only

        Which workspace the datastream belongs to.

      • authintegernullable

        Which authorization the datastream uses.

      • namestringrequired

        A human readable name. Numbers and special characters are supported.

        Max length 150

      • slugstringrequiredread-only
      • app_labelstringrequiredread-only
      • absolute_urlstringrequiredread-only
      • change_urlstringrequiredread-only
      • extracts_urlstringrequiredread-only
      • fetch_urlstringrequiredread-only
      • overview_urlstringrequiredread-only
      • schema_mapping_urlstringrequiredread-only
      • enabledboolean

        Streams that are not scheduled will not be fetched automatically.

      • next_runstring · date-timerequiredread-only
      • urlstring · urirequiredread-only
      • datastream_type_idintegerrequiredread-only
      • logo_urlstringrequiredread-only
      • extracts_stream_urlstringrequiredread-only
      • supports_extended_intervalsstringrequiredread-only
      • updatedstring · date-timerequiredread-only
      • createdstring · date-timerequiredread-only
      • creatorstringrequiredread-onlynullable
      • can_be_fetchedbooleanrequiredread-only

    • null

  • issuesarray of objectrequiredread-only
    Items · CompactDatastreamExtractionLog

    • messagestringnullable
    • type_labelstringrequiredread-only
    • extraction_stage_labelstringrequiredread-only
    • urlstring · urirequiredread-only
  • last_executedstring · date-timerequiredread-onlynullable

    When a job in this job group last started executing. Job-group level: it reflects any job in the group, not this job alone. Null until the first job in the group starts - fall back to scheduled to age a group that has not started yet. The write is debounced by 5 minutes, so the value may lag real activity by up to that much - do not build staleness alarms with a tighter threshold.

  • userstringrequiredread-onlynullable
  • range_startstring · date-timerequiredread-only
  • range_endstring · date-timerequiredread-only
  • scheduledstring · date-timerequiredread-only
  • manualstringrequiredread-only

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/datastreams/{id}/jobs/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 1,
      "uuid": "00000000-0000-0000-0000-000000000000",
      "url": "https://example.com",
      "job_start": "2024-01-01T00:00:00Z",
      "job_end": "2024-01-01T00:00:00Z",
      "progress": "string",
      "state": "string",
      "state_label": "string",
      "state_color": "string",
      "datastream": {
        "id": 1,
        "uuid": "00000000-0000-0000-0000-000000000000",
        "stack": {
          "id": null,
          "uuid": null,
          "name": null,
          "slug": null,
          "url": null,
          "change_url": null,
          "extracts_url": null,
          "issues_url": null,
          "overview_url": null,
          "permissions": null
        },
        "stack_id": 1,
        "auth": 1,
        "name": "string",
        "slug": "string",
        "app_label": "string",
        "absolute_url": "string",
        "change_url": "string",
        "extracts_url": "string",
        "fetch_url": "string",
        "overview_url": "string",
        "schema_mapping_url": "string",
        "enabled": true,
        "next_run": "2024-01-01T00:00:00Z",
        "url": "https://example.com",
        "datastream_type_id": 1,
        "logo_url": "string",
        "extracts_stream_url": "string",
        "supports_extended_intervals": "string",
        "updated": "2024-01-01T00:00:00Z",
        "created": "2024-01-01T00:00:00Z",
        "creator": "string",
        "can_be_fetched": true
      },
      "issues": [
        {
          "message": "string",
          "type_label": "string",
          "extraction_stage_label": "string",
          "url": "https://example.com"
        }
      ],
      "last_executed": "2024-01-01T00:00:00Z",
      "user": "string",
      "range_start": "2024-01-01T00:00:00Z",
      "range_end": "2024-01-01T00:00:00Z",
      "scheduled": "2024-01-01T00:00:00Z",
      "manual": "string"
    }
  ]
}

Get datastreams passive destinations

GET/api/datastreams/{id}/passive-destinations/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream.

Responses

200OKapplication/json

Response schema

object PassiveTokenUpdate

• time_range_presetintegerrequired
  • 0 - 0
  • 13 - 13
  • 10 - 10
  • 11 - 11
  • 6 - 6
  • 7 - 7
  • 17 - 17
  • 18 - 18
  • 16 - 16
  • 23 - 23
  • 19 - 19
  • 24 - 24
  • 4 - 4
  • 25 - 25
  • 26 - 26
  • 22 - 22
  • 14 - 14
  • 15 - 15
  • 2 - 2
  • 20 - 20
  • 21 - 21
  • 5 - 5
  • 31 - 31
  • 28 - 28
  • 3 - 3
  • 27 - 27
  • 8 - 8
  • 9 - 9
  • 29 - 29
  • 12 - 12
  • 30 - 30
  • 1000 - 1000
  • 50 - 50
  • 51 - 51
  • 52 - 52
  • 53 - 53
  • 54 - 54
  • 55 - 55
  • 56 - 56
  • 57 - 57
  • 58 - 58
  • 59 - 59

  One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59

• time_range_startstring · date-timenullable
• time_range_endstring · date-timenullable

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/datastreams/{id}/passive-destinations/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "time_range_preset": 0,
  "time_range_start": "2024-01-01T00:00:00Z",
  "time_range_end": "2024-01-01T00:00:00Z"
}

Create datastreams passive destinations

POST/api/datastreams/{id}/passive-destinations/

API key permissionDatastream: Writedatastream:write

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream.

Request bodyrequired

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object PassiveTokenUpdate

• time_range_presetintegerrequired
  • 0 - 0
  • 13 - 13
  • 10 - 10
  • 11 - 11
  • 6 - 6
  • 7 - 7
  • 17 - 17
  • 18 - 18
  • 16 - 16
  • 23 - 23
  • 19 - 19
  • 24 - 24
  • 4 - 4
  • 25 - 25
  • 26 - 26
  • 22 - 22
  • 14 - 14
  • 15 - 15
  • 2 - 2
  • 20 - 20
  • 21 - 21
  • 5 - 5
  • 31 - 31
  • 28 - 28
  • 3 - 3
  • 27 - 27
  • 8 - 8
  • 9 - 9
  • 29 - 29
  • 12 - 12
  • 30 - 30
  • 1000 - 1000
  • 50 - 50
  • 51 - 51
  • 52 - 52
  • 53 - 53
  • 54 - 54
  • 55 - 55
  • 56 - 56
  • 57 - 57
  • 58 - 58
  • 59 - 59

  One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59

• time_range_startstring · date-timenullable
• time_range_endstring · date-timenullable

Responses

200OKapplication/json

Response schema

object PassiveTokenUpdate

• time_range_presetintegerrequired
  • 0 - 0
  • 13 - 13
  • 10 - 10
  • 11 - 11
  • 6 - 6
  • 7 - 7
  • 17 - 17
  • 18 - 18
  • 16 - 16
  • 23 - 23
  • 19 - 19
  • 24 - 24
  • 4 - 4
  • 25 - 25
  • 26 - 26
  • 22 - 22
  • 14 - 14
  • 15 - 15
  • 2 - 2
  • 20 - 20
  • 21 - 21
  • 5 - 5
  • 31 - 31
  • 28 - 28
  • 3 - 3
  • 27 - 27
  • 8 - 8
  • 9 - 9
  • 29 - 29
  • 12 - 12
  • 30 - 30
  • 1000 - 1000
  • 50 - 50
  • 51 - 51
  • 52 - 52
  • 53 - 53
  • 54 - 54
  • 55 - 55
  • 56 - 56
  • 57 - 57
  • 58 - 58
  • 59 - 59

  One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59

• time_range_startstring · date-timenullable
• time_range_endstring · date-timenullable

RequestcURL

curl --request POST 'https://{{INSTANCE}}/api/datastreams/{id}/passive-destinations/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "time_range_preset": 0,
    "time_range_start": "2024-01-01T00:00:00Z",
    "time_range_end": "2024-01-01T00:00:00Z"
  }'

Response200

{
  "time_range_preset": 0,
  "time_range_start": "2024-01-01T00:00:00Z",
  "time_range_end": "2024-01-01T00:00:00Z"
}

Get datastreams stats

GET/api/datastreams/{id}/stats/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream.

Responses

200OKapplication/json

Response schema

object APIDatastreamFull

• idintegerrequiredread-only
• uuidstring · uuidrequiredread-only
• urlstring · urirequiredread-only
• stackobjectrequiredread-only
  Attributes · StackBasic

  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • namestringrequired

    Max length 60

  • slugstringrequiredread-only
  • urlstring · urirequiredread-only
  • change_urlstringrequiredread-only
  • extracts_urlstringrequiredread-only
  • issues_urlstringrequiredread-only
  • overview_urlstringrequiredread-only
  • permissionsstringrequiredread-only
• authintegernullable

  Which authorization the datastream uses.

• auth_change_urlstringrequiredread-only
• app_labelstringrequiredread-only
• namestringrequired

  A human readable name. Numbers and special characters are supported.

  Max length 150

• slugstringrequiredread-only
• descriptionstring

  Max length 1000

• enabledboolean

  Streams that are not scheduled will not be fetched automatically.

• frequencystringrequiredread-only
• next_runstring · date-timerequiredread-only
• last_fetchstring · date-timerequiredread-only
• absolute_urlstringrequiredread-only
• change_urlstringrequiredread-only
• extracts_urlstringrequiredread-only
• fetch_urlstringrequiredread-only
• overview_urlstringrequiredread-only
• schema_mapping_urlstringrequiredread-only
• issues_urlstringrequiredread-only
• transformersarray of objectrequiredread-only
  Items · TransformerBasic

  • idintegerrequiredread-only
  • namestringrequired

    Max length 200

  • stackintegernullable
  • change_urlstringrequiredread-only
  • smart_naming_conventionobjectrequiredread-only
    Attributes · SmartNamingConventionSummary

    • idintegerrequiredread-only
    • column_namestringrequiredread-only
    • datastream_namesstringrequiredread-only
    • delimiters_charactersstringrequiredread-only
    • sorted_columns_namesstringrequiredread-only
    • email_for_errorbooleanrequired
    • email_for_warningbooleanrequired
    • raise_for_warningbooleanrequired
    • add_status_columnsbooleanrequired
    • columns_rule_phrasingstringrequiredread-only
• schedulesarray of objectrequiredread-only
  Items · FetchSchedule

  • idintegerrequiredread-only
  • cron_presetstring
    • ONCE - Once
    • CRON_EVERY_DAY - Every day
    • CRON_EVERY_WEEK - Every week
    • CRON_EVERY_MONTH - Every month
    • CRON_EVERY_QUARTER - Every quarter
    • CRON_EVERY_15_MINUTES - Every 15 minutes
    • CRON_EVERY_30_MINUTES - Every 30 minutes
    • CRON_EVERY_HOUR - Every hour
    • CRON_EVERY_2_HOURS - Every 2 hours
    • CRON_EVERY_3_HOURS - Every 3 hours
    • CRON_EVERY_4_HOURS - Every 4 hours
    • CRON_EVERY_5_HOURS - Every 5 hours
    • CRON_EVERY_6_HOURS - Every 6 hours
    • CRON_EVERY_8_HOURS - Every 8 hours
    • CRON_EVERY_12_HOURS - Every 12 hours
    • CRON_EVERY_2_DAYS - Every 2 days
    • CRON_EVERY_30_DAYS - Every 30 days
    • CRON_EVERY_40_DAYS - Every 40 days
    • CRON_EVERY_2_WEEKS - Every 2 weeks
    • CRON_EVERY_4_WEEKS - Every 4 weeks
    • CRON_EVERY_6_MONTHS - Every 6 months
    • CRON_EVERY_YEAR - Every year

    One of ONCE CRON_EVERY_DAY CRON_EVERY_WEEK CRON_EVERY_MONTH CRON_EVERY_QUARTER CRON_EVERY_15_MINUTES CRON_EVERY_30_MINUTES CRON_EVERY_HOUR CRON_EVERY_2_HOURS CRON_EVERY_3_HOURS CRON_EVERY_4_HOURS CRON_EVERY_5_HOURS CRON_EVERY_6_HOURS CRON_EVERY_8_HOURS CRON_EVERY_12_HOURS CRON_EVERY_2_DAYS CRON_EVERY_30_DAYS CRON_EVERY_40_DAYS CRON_EVERY_2_WEEKS CRON_EVERY_4_WEEKS CRON_EVERY_6_MONTHS CRON_EVERY_YEAR

  • cron_typestring

    Defaults to 'day' when omitted on a schedule entry.

  • cron_intervalinteger

    Min 0 · Max 2147483647

  • cron_start_of_daystring · time

    At what time the day starts.

  • cron_interval_startinteger

    Min 0 · Max 32767

  • time_range_presetinteger

    Select one of the time range presets.

    • 0 - Custom Time Range
    • 13 - Yesterday
    • 10 - Today
    • 11 - Current Week
    • 6 - Current Month
    • 7 - Previous Month
    • 17 - Last Quarter
    • 18 - Last 2 Days
    • 16 - Last 3 Days
    • 23 - Last 4 Days
    • 19 - Last 5 Days
    • 24 - Last 6 Days
    • 4 - Last 7 Days
    • 25 - Last 8 Days
    • 26 - Last 9 Days
    • 22 - Last 10 Days
    • 14 - Last 14 Days
    • 15 - Last 28 Days
    • 2 - Last 30 Days
    • 20 - Last 40 Days
    • 21 - Last 60 Days
    • 5 - Last 90 Days
    • 31 - Last 120 Days
    • 28 - Last 180 Days
    • 3 - Last 365 Days
    • 27 - Last 730 Days
    • 8 - Previous Week
    • 9 - Previous Year
    • 29 - Current Quarter
    • 12 - Current Year
    • 30 - Last Hour
    • 1000 - Lifetime
    • 50 - Tomorrow
    • 51 - Next 2 Days
    • 52 - Next 7 Days
    • 53 - Next 30 Days
    • 54 - Current Week (incl Future Days)
    • 55 - Next Week
    • 56 - Current Month (incl Future Days)
    • 57 - Next Month
    • 58 - Current Year (incl Future Days)
    • 59 - Next Year

    One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59 · Min 0 · Max 32767

  • time_range_preset_labelstringrequiredread-only
  • delta_typeinteger
    • 0 - minute(s)
    • 1 - hour(s)
    • 2 - day(s)
    • 3 - week(s)
    • 4 - month(s)
    • 6 - quarters(s)
    • 5 - year(s)
    • 7 - once

    One of 0 1 2 3 4 6 5 7 · Min -32768 · Max 32767

  • delta_intervalinteger

    Min 0 · Max 2147483647

  • delta_start_of_daystring · time

    At what time the day starts.

  • delta_interval_startinteger

    Min 0 · Max 32767

  • fixed_startstring · datenullable

    First day to fetch.

  • fixed_endstring · datenullable

    Last day to fetch.

  • offset_daysinteger

    Number of days to shift the fetched date range into the past.

    Min -32768 · Max 32767

  • not_before_datestring · datenullable

    Do not fetch before this date.

  • not_before_timestring · timenullable

    Do not fetch before this time.

• datastream_type_idintegerrequiredread-only
• datastream_type_namestringrequiredread-only
• datastream_type_slugstringrequiredread-only
• datatypestring

  Projection of destination state: reads Live if any destination is enabled, otherwise Staging. Writing 'Live' enables all destinations and 'Staging' disables them.

  • Live - Live
  • Staging - Staging

  One of Live Staging

• actionsstringrequiredread-only
• overwrite_key_columnsboolean

  Overwrite rows according to Key defined in Data Mapping.

• manage_extract_namesboolean

  Split by selected date column and name extracts with pre-defined pattern to consolidate data.

• extract_name_keysstringnullable

  Max length 128

• retention_typeinteger
  • 1 - Retain all
  • 2 - Retain N fetches
  • 4 - Retain N extracts
  • 3 - Retain N days

  One of 1 2 4 3 · Min 0 · Max 32767

• retention_numberintegernullable

  The amount (N) of fetches/extracts/days to retain (raw extracts are not counted). Must be an integer greater than or equal to zero.

  Min 0 · Max 32767

• remove_if_emptyboolean

  When enabled, fetches resulting in only empty rows ("empty extracts") will be silently discarded.

• skip_empty_rowsboolean

  When enabled, empty data rows in fetches will be silently ignored.

• prune_instantlyboolean

  When enabled, deleted files will not be kept for the configured grace period.

• overwrite_datastreamboolean

  Delete/Drop all existing rows (created by this datastream) in the destination before inserting a new import.

• overwrite_filenameboolean

  Overwrite rows from same extract file.

• logo_urlstringrequiredread-only
• extracts_stream_urlstringrequiredread-only
• active_destinationstringrequiredread-only
• supports_passive_destinationsbooleanrequiredread-only
• passive_destinationsstringrequiredread-only
• columnsstring · urirequiredread-only
• supports_extended_intervalsstringrequiredread-only
• updatedstring · date-timerequiredread-only
• createdstring · date-timerequiredread-only
• creatorstringrequiredread-onlynullable
• has_schema_mappingbooleanrequiredread-only
• is_insights_mediaplanboolean

  If checked, generated extracts will be treated as Insights mediaplans.

• cron_typestring
• cron_intervalinteger

  Min 0

• cron_start_of_daystring · time
• cron_interval_startinteger

  Min 0

• time_range_presetinteger
  • 0 - Custom Time Range
  • 13 - Yesterday
  • 10 - Today
  • 11 - Current Week
  • 6 - Current Month
  • 7 - Previous Month
  • 17 - Last Quarter
  • 18 - Last 2 Days
  • 16 - Last 3 Days
  • 23 - Last 4 Days
  • 19 - Last 5 Days
  • 24 - Last 6 Days
  • 4 - Last 7 Days
  • 25 - Last 8 Days
  • 26 - Last 9 Days
  • 22 - Last 10 Days
  • 14 - Last 14 Days
  • 15 - Last 28 Days
  • 2 - Last 30 Days
  • 20 - Last 40 Days
  • 21 - Last 60 Days
  • 5 - Last 90 Days
  • 31 - Last 120 Days
  • 28 - Last 180 Days
  • 3 - Last 365 Days
  • 27 - Last 730 Days
  • 8 - Previous Week
  • 9 - Previous Year
  • 29 - Current Quarter
  • 12 - Current Year
  • 30 - Last Hour
  • 1000 - Lifetime
  • 50 - Tomorrow
  • 51 - Next 2 Days
  • 52 - Next 7 Days
  • 53 - Next 30 Days
  • 54 - Current Week (incl Future Days)
  • 55 - Next Week
  • 56 - Current Month (incl Future Days)
  • 57 - Next Month
  • 58 - Current Year (incl Future Days)
  • 59 - Next Year

  One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59

• delta_intervalinteger

  Min 0

• delta_interval_startinteger

  Min 0

• delta_start_of_daystring · time
• delta_typeinteger
  • 0 - minute(s)
  • 1 - hour(s)
  • 2 - day(s)
  • 3 - week(s)
  • 4 - month(s)
  • 6 - quarters(s)
  • 5 - year(s)
  • 7 - once

  One of 0 1 2 3 4 6 5 7

• time_range_maxstringrequiredread-only
• time_range_availablestringrequiredread-only
• has_schema_mapping_dimensionbooleanrequiredread-only
• feature_smart_naming_conventionstringrequiredread-only
• auto_fetchstringrequiredread-only
• assigned_destinationsarray of objectrequiredread-only
  Items · AssignedDestination

  • target_idintegerrequiredread-only
  • destination_namestringrequiredread-only
  • destination_typestringrequiredread-only
  • enabledbooleanrequiredread-only
  • destination_settingsobjectrequiredread-only
• can_be_fetchedbooleanrequiredread-only

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/datastreams/{id}/stats/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "id": 1,
  "uuid": "00000000-0000-0000-0000-000000000000",
  "url": "https://example.com",
  "stack": {
    "id": 1,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "slug": "string",
    "url": "https://example.com",
    "change_url": "string",
    "extracts_url": "string",
    "issues_url": "string",
    "overview_url": "string",
    "permissions": "string"
  },
  "auth": 1,
  "auth_change_url": "string",
  "app_label": "string",
  "name": "string",
  "slug": "string",
  "description": "string",
  "enabled": true,
  "frequency": "string",
  "next_run": "2024-01-01T00:00:00Z",
  "last_fetch": "2024-01-01T00:00:00Z",
  "absolute_url": "string",
  "change_url": "string",
  "extracts_url": "string",
  "fetch_url": "string",
  "overview_url": "string",
  "schema_mapping_url": "string",
  "issues_url": "string",
  "transformers": [
    {
      "id": 1,
      "name": "string",
      "stack": 1,
      "change_url": "string",
      "smart_naming_convention": {
        "id": 1,
        "column_name": "string",
        "datastream_names": "string",
        "delimiters_characters": "string",
        "sorted_columns_names": "string",
        "email_for_error": true,
        "email_for_warning": true,
        "raise_for_warning": true,
        "add_status_columns": true,
        "columns_rule_phrasing": "string"
      }
    }
  ],
  "schedules": [
    {
      "id": 1,
      "cron_preset": "ONCE",
      "cron_type": "string",
      "cron_interval": 1,
      "cron_start_of_day": "string",
      "cron_interval_start": 1,
      "time_range_preset": 0,
      "time_range_preset_label": "string",
      "delta_type": 0,
      "delta_interval": 1,
      "delta_start_of_day": "string",
      "delta_interval_start": 1,
      "fixed_start": "2024-01-01",
      "fixed_end": "2024-01-01",
      "offset_days": 1,
      "not_before_date": "2024-01-01",
      "not_before_time": "string"
    }
  ],
  "datastream_type_id": 1,
  "datastream_type_name": "string",
  "datastream_type_slug": "string",
  "datatype": "Live",
  "actions": "string",
  "overwrite_key_columns": true,
  "manage_extract_names": true,
  "extract_name_keys": "string",
  "retention_type": 1,
  "retention_number": 1,
  "remove_if_empty": true,
  "skip_empty_rows": true,
  "prune_instantly": true,
  "overwrite_datastream": true,
  "overwrite_filename": true,
  "logo_url": "string",
  "extracts_stream_url": "string",
  "active_destination": "string",
  "supports_passive_destinations": true,
  "passive_destinations": "string",
  "columns": "https://example.com",
  "supports_extended_intervals": "string",
  "updated": "2024-01-01T00:00:00Z",
  "created": "2024-01-01T00:00:00Z",
  "creator": "string",
  "has_schema_mapping": true,
  "is_insights_mediaplan": true,
  "cron_type": "string",
  "cron_interval": 1,
  "cron_start_of_day": "string",
  "cron_interval_start": 1,
  "time_range_preset": 0,
  "delta_interval": 1,
  "delta_interval_start": 1,
  "delta_start_of_day": "string",
  "delta_type": 0,
  "time_range_max": "string",
  "time_range_available": "string",
  "has_schema_mapping_dimension": true,
  "feature_smart_naming_convention": "string",
  "auto_fetch": "string",
  "assigned_destinations": [
    {
      "target_id": 1,
      "destination_name": "string",
      "destination_type": "string",
      "enabled": true,
      "destination_settings": {
        "key": null
      }
    }
  ],
  "can_be_fetched": true
}

Get datastreams transformer

GET/api/datastreams/{id}/transformer/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream.

Responses

200OKapplication/json

Response schema

object APIDatastreamFull

• idintegerrequiredread-only
• uuidstring · uuidrequiredread-only
• urlstring · urirequiredread-only
• stackobjectrequiredread-only
  Attributes · StackBasic

  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • namestringrequired

    Max length 60

  • slugstringrequiredread-only
  • urlstring · urirequiredread-only
  • change_urlstringrequiredread-only
  • extracts_urlstringrequiredread-only
  • issues_urlstringrequiredread-only
  • overview_urlstringrequiredread-only
  • permissionsstringrequiredread-only
• authintegernullable

  Which authorization the datastream uses.

• auth_change_urlstringrequiredread-only
• app_labelstringrequiredread-only
• namestringrequired

  A human readable name. Numbers and special characters are supported.

  Max length 150

• slugstringrequiredread-only
• descriptionstring

  Max length 1000

• enabledboolean

  Streams that are not scheduled will not be fetched automatically.

• frequencystringrequiredread-only
• next_runstring · date-timerequiredread-only
• last_fetchstring · date-timerequiredread-only
• absolute_urlstringrequiredread-only
• change_urlstringrequiredread-only
• extracts_urlstringrequiredread-only
• fetch_urlstringrequiredread-only
• overview_urlstringrequiredread-only
• schema_mapping_urlstringrequiredread-only
• issues_urlstringrequiredread-only
• transformersarray of objectrequiredread-only
  Items · TransformerBasic

  • idintegerrequiredread-only
  • namestringrequired

    Max length 200

  • stackintegernullable
  • change_urlstringrequiredread-only
  • smart_naming_conventionobjectrequiredread-only
    Attributes · SmartNamingConventionSummary

    • idintegerrequiredread-only
    • column_namestringrequiredread-only
    • datastream_namesstringrequiredread-only
    • delimiters_charactersstringrequiredread-only
    • sorted_columns_namesstringrequiredread-only
    • email_for_errorbooleanrequired
    • email_for_warningbooleanrequired
    • raise_for_warningbooleanrequired
    • add_status_columnsbooleanrequired
    • columns_rule_phrasingstringrequiredread-only
• schedulesarray of objectrequiredread-only
  Items · FetchSchedule

  • idintegerrequiredread-only
  • cron_presetstring
    • ONCE - Once
    • CRON_EVERY_DAY - Every day
    • CRON_EVERY_WEEK - Every week
    • CRON_EVERY_MONTH - Every month
    • CRON_EVERY_QUARTER - Every quarter
    • CRON_EVERY_15_MINUTES - Every 15 minutes
    • CRON_EVERY_30_MINUTES - Every 30 minutes
    • CRON_EVERY_HOUR - Every hour
    • CRON_EVERY_2_HOURS - Every 2 hours
    • CRON_EVERY_3_HOURS - Every 3 hours
    • CRON_EVERY_4_HOURS - Every 4 hours
    • CRON_EVERY_5_HOURS - Every 5 hours
    • CRON_EVERY_6_HOURS - Every 6 hours
    • CRON_EVERY_8_HOURS - Every 8 hours
    • CRON_EVERY_12_HOURS - Every 12 hours
    • CRON_EVERY_2_DAYS - Every 2 days
    • CRON_EVERY_30_DAYS - Every 30 days
    • CRON_EVERY_40_DAYS - Every 40 days
    • CRON_EVERY_2_WEEKS - Every 2 weeks
    • CRON_EVERY_4_WEEKS - Every 4 weeks
    • CRON_EVERY_6_MONTHS - Every 6 months
    • CRON_EVERY_YEAR - Every year

    One of ONCE CRON_EVERY_DAY CRON_EVERY_WEEK CRON_EVERY_MONTH CRON_EVERY_QUARTER CRON_EVERY_15_MINUTES CRON_EVERY_30_MINUTES CRON_EVERY_HOUR CRON_EVERY_2_HOURS CRON_EVERY_3_HOURS CRON_EVERY_4_HOURS CRON_EVERY_5_HOURS CRON_EVERY_6_HOURS CRON_EVERY_8_HOURS CRON_EVERY_12_HOURS CRON_EVERY_2_DAYS CRON_EVERY_30_DAYS CRON_EVERY_40_DAYS CRON_EVERY_2_WEEKS CRON_EVERY_4_WEEKS CRON_EVERY_6_MONTHS CRON_EVERY_YEAR

  • cron_typestring

    Defaults to 'day' when omitted on a schedule entry.

  • cron_intervalinteger

    Min 0 · Max 2147483647

  • cron_start_of_daystring · time

    At what time the day starts.

  • cron_interval_startinteger

    Min 0 · Max 32767

  • time_range_presetinteger

    Select one of the time range presets.

    • 0 - Custom Time Range
    • 13 - Yesterday
    • 10 - Today
    • 11 - Current Week
    • 6 - Current Month
    • 7 - Previous Month
    • 17 - Last Quarter
    • 18 - Last 2 Days
    • 16 - Last 3 Days
    • 23 - Last 4 Days
    • 19 - Last 5 Days
    • 24 - Last 6 Days
    • 4 - Last 7 Days
    • 25 - Last 8 Days
    • 26 - Last 9 Days
    • 22 - Last 10 Days
    • 14 - Last 14 Days
    • 15 - Last 28 Days
    • 2 - Last 30 Days
    • 20 - Last 40 Days
    • 21 - Last 60 Days
    • 5 - Last 90 Days
    • 31 - Last 120 Days
    • 28 - Last 180 Days
    • 3 - Last 365 Days
    • 27 - Last 730 Days
    • 8 - Previous Week
    • 9 - Previous Year
    • 29 - Current Quarter
    • 12 - Current Year
    • 30 - Last Hour
    • 1000 - Lifetime
    • 50 - Tomorrow
    • 51 - Next 2 Days
    • 52 - Next 7 Days
    • 53 - Next 30 Days
    • 54 - Current Week (incl Future Days)
    • 55 - Next Week
    • 56 - Current Month (incl Future Days)
    • 57 - Next Month
    • 58 - Current Year (incl Future Days)
    • 59 - Next Year

    One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59 · Min 0 · Max 32767

  • time_range_preset_labelstringrequiredread-only
  • delta_typeinteger
    • 0 - minute(s)
    • 1 - hour(s)
    • 2 - day(s)
    • 3 - week(s)
    • 4 - month(s)
    • 6 - quarters(s)
    • 5 - year(s)
    • 7 - once

    One of 0 1 2 3 4 6 5 7 · Min -32768 · Max 32767

  • delta_intervalinteger

    Min 0 · Max 2147483647

  • delta_start_of_daystring · time

    At what time the day starts.

  • delta_interval_startinteger

    Min 0 · Max 32767

  • fixed_startstring · datenullable

    First day to fetch.

  • fixed_endstring · datenullable

    Last day to fetch.

  • offset_daysinteger

    Number of days to shift the fetched date range into the past.

    Min -32768 · Max 32767

  • not_before_datestring · datenullable

    Do not fetch before this date.

  • not_before_timestring · timenullable

    Do not fetch before this time.

• datastream_type_idintegerrequiredread-only
• datastream_type_namestringrequiredread-only
• datastream_type_slugstringrequiredread-only
• datatypestring

  Projection of destination state: reads Live if any destination is enabled, otherwise Staging. Writing 'Live' enables all destinations and 'Staging' disables them.

  • Live - Live
  • Staging - Staging

  One of Live Staging

• actionsstringrequiredread-only
• overwrite_key_columnsboolean

  Overwrite rows according to Key defined in Data Mapping.

• manage_extract_namesboolean

  Split by selected date column and name extracts with pre-defined pattern to consolidate data.

• extract_name_keysstringnullable

  Max length 128

• retention_typeinteger
  • 1 - Retain all
  • 2 - Retain N fetches
  • 4 - Retain N extracts
  • 3 - Retain N days

  One of 1 2 4 3 · Min 0 · Max 32767

• retention_numberintegernullable

  The amount (N) of fetches/extracts/days to retain (raw extracts are not counted). Must be an integer greater than or equal to zero.

  Min 0 · Max 32767

• remove_if_emptyboolean

  When enabled, fetches resulting in only empty rows ("empty extracts") will be silently discarded.

• skip_empty_rowsboolean

  When enabled, empty data rows in fetches will be silently ignored.

• prune_instantlyboolean

  When enabled, deleted files will not be kept for the configured grace period.

• overwrite_datastreamboolean

  Delete/Drop all existing rows (created by this datastream) in the destination before inserting a new import.

• overwrite_filenameboolean

  Overwrite rows from same extract file.

• logo_urlstringrequiredread-only
• extracts_stream_urlstringrequiredread-only
• active_destinationstringrequiredread-only
• supports_passive_destinationsbooleanrequiredread-only
• passive_destinationsstringrequiredread-only
• columnsstring · urirequiredread-only
• supports_extended_intervalsstringrequiredread-only
• updatedstring · date-timerequiredread-only
• createdstring · date-timerequiredread-only
• creatorstringrequiredread-onlynullable
• has_schema_mappingbooleanrequiredread-only
• is_insights_mediaplanboolean

  If checked, generated extracts will be treated as Insights mediaplans.

• cron_typestring
• cron_intervalinteger

  Min 0

• cron_start_of_daystring · time
• cron_interval_startinteger

  Min 0

• time_range_presetinteger
  • 0 - Custom Time Range
  • 13 - Yesterday
  • 10 - Today
  • 11 - Current Week
  • 6 - Current Month
  • 7 - Previous Month
  • 17 - Last Quarter
  • 18 - Last 2 Days
  • 16 - Last 3 Days
  • 23 - Last 4 Days
  • 19 - Last 5 Days
  • 24 - Last 6 Days
  • 4 - Last 7 Days
  • 25 - Last 8 Days
  • 26 - Last 9 Days
  • 22 - Last 10 Days
  • 14 - Last 14 Days
  • 15 - Last 28 Days
  • 2 - Last 30 Days
  • 20 - Last 40 Days
  • 21 - Last 60 Days
  • 5 - Last 90 Days
  • 31 - Last 120 Days
  • 28 - Last 180 Days
  • 3 - Last 365 Days
  • 27 - Last 730 Days
  • 8 - Previous Week
  • 9 - Previous Year
  • 29 - Current Quarter
  • 12 - Current Year
  • 30 - Last Hour
  • 1000 - Lifetime
  • 50 - Tomorrow
  • 51 - Next 2 Days
  • 52 - Next 7 Days
  • 53 - Next 30 Days
  • 54 - Current Week (incl Future Days)
  • 55 - Next Week
  • 56 - Current Month (incl Future Days)
  • 57 - Next Month
  • 58 - Current Year (incl Future Days)
  • 59 - Next Year

  One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59

• delta_intervalinteger

  Min 0

• delta_interval_startinteger

  Min 0

• delta_start_of_daystring · time
• delta_typeinteger
  • 0 - minute(s)
  • 1 - hour(s)
  • 2 - day(s)
  • 3 - week(s)
  • 4 - month(s)
  • 6 - quarters(s)
  • 5 - year(s)
  • 7 - once

  One of 0 1 2 3 4 6 5 7

• time_range_maxstringrequiredread-only
• time_range_availablestringrequiredread-only
• has_schema_mapping_dimensionbooleanrequiredread-only
• feature_smart_naming_conventionstringrequiredread-only
• auto_fetchstringrequiredread-only
• assigned_destinationsarray of objectrequiredread-only
  Items · AssignedDestination

  • target_idintegerrequiredread-only
  • destination_namestringrequiredread-only
  • destination_typestringrequiredread-only
  • enabledbooleanrequiredread-only
  • destination_settingsobjectrequiredread-only
• can_be_fetchedbooleanrequiredread-only

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/datastreams/{id}/transformer/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "id": 1,
  "uuid": "00000000-0000-0000-0000-000000000000",
  "url": "https://example.com",
  "stack": {
    "id": 1,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "slug": "string",
    "url": "https://example.com",
    "change_url": "string",
    "extracts_url": "string",
    "issues_url": "string",
    "overview_url": "string",
    "permissions": "string"
  },
  "auth": 1,
  "auth_change_url": "string",
  "app_label": "string",
  "name": "string",
  "slug": "string",
  "description": "string",
  "enabled": true,
  "frequency": "string",
  "next_run": "2024-01-01T00:00:00Z",
  "last_fetch": "2024-01-01T00:00:00Z",
  "absolute_url": "string",
  "change_url": "string",
  "extracts_url": "string",
  "fetch_url": "string",
  "overview_url": "string",
  "schema_mapping_url": "string",
  "issues_url": "string",
  "transformers": [
    {
      "id": 1,
      "name": "string",
      "stack": 1,
      "change_url": "string",
      "smart_naming_convention": {
        "id": 1,
        "column_name": "string",
        "datastream_names": "string",
        "delimiters_characters": "string",
        "sorted_columns_names": "string",
        "email_for_error": true,
        "email_for_warning": true,
        "raise_for_warning": true,
        "add_status_columns": true,
        "columns_rule_phrasing": "string"
      }
    }
  ],
  "schedules": [
    {
      "id": 1,
      "cron_preset": "ONCE",
      "cron_type": "string",
      "cron_interval": 1,
      "cron_start_of_day": "string",
      "cron_interval_start": 1,
      "time_range_preset": 0,
      "time_range_preset_label": "string",
      "delta_type": 0,
      "delta_interval": 1,
      "delta_start_of_day": "string",
      "delta_interval_start": 1,
      "fixed_start": "2024-01-01",
      "fixed_end": "2024-01-01",
      "offset_days": 1,
      "not_before_date": "2024-01-01",
      "not_before_time": "string"
    }
  ],
  "datastream_type_id": 1,
  "datastream_type_name": "string",
  "datastream_type_slug": "string",
  "datatype": "Live",
  "actions": "string",
  "overwrite_key_columns": true,
  "manage_extract_names": true,
  "extract_name_keys": "string",
  "retention_type": 1,
  "retention_number": 1,
  "remove_if_empty": true,
  "skip_empty_rows": true,
  "prune_instantly": true,
  "overwrite_datastream": true,
  "overwrite_filename": true,
  "logo_url": "string",
  "extracts_stream_url": "string",
  "active_destination": "string",
  "supports_passive_destinations": true,
  "passive_destinations": "string",
  "columns": "https://example.com",
  "supports_extended_intervals": "string",
  "updated": "2024-01-01T00:00:00Z",
  "created": "2024-01-01T00:00:00Z",
  "creator": "string",
  "has_schema_mapping": true,
  "is_insights_mediaplan": true,
  "cron_type": "string",
  "cron_interval": 1,
  "cron_start_of_day": "string",
  "cron_interval_start": 1,
  "time_range_preset": 0,
  "delta_interval": 1,
  "delta_interval_start": 1,
  "delta_start_of_day": "string",
  "delta_type": 0,
  "time_range_max": "string",
  "time_range_available": "string",
  "has_schema_mapping_dimension": true,
  "feature_smart_naming_convention": "string",
  "auto_fetch": "string",
  "assigned_destinations": [
    {
      "target_id": 1,
      "destination_name": "string",
      "destination_type": "string",
      "enabled": true,
      "destination_settings": {
        "key": null
      }
    }
  ],
  "can_be_fetched": true
}

List datastreams schedules

GET/api/datastreams/{parent_lookup_datastream_id}/schedules/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• parent_lookup_datastream_idstringrequired

Query parameters

• orderingstring

  Which field to use when ordering the results.

• pageinteger

  A page number within the paginated result set.

Responses

200OKapplication/json

Response schema

object PaginatedFetchScheduleList

• countintegerrequired

  Example 123

• nextstring · urinullable

  Example "http://api.example.org/accounts/?page=4"

• previousstring · urinullable

  Example "http://api.example.org/accounts/?page=2"

• resultsarray of objectrequired
  Items · FetchSchedule

  • idintegerrequiredread-only
  • cron_presetstring
    • ONCE - Once
    • CRON_EVERY_DAY - Every day
    • CRON_EVERY_WEEK - Every week
    • CRON_EVERY_MONTH - Every month
    • CRON_EVERY_QUARTER - Every quarter
    • CRON_EVERY_15_MINUTES - Every 15 minutes
    • CRON_EVERY_30_MINUTES - Every 30 minutes
    • CRON_EVERY_HOUR - Every hour
    • CRON_EVERY_2_HOURS - Every 2 hours
    • CRON_EVERY_3_HOURS - Every 3 hours
    • CRON_EVERY_4_HOURS - Every 4 hours
    • CRON_EVERY_5_HOURS - Every 5 hours
    • CRON_EVERY_6_HOURS - Every 6 hours
    • CRON_EVERY_8_HOURS - Every 8 hours
    • CRON_EVERY_12_HOURS - Every 12 hours
    • CRON_EVERY_2_DAYS - Every 2 days
    • CRON_EVERY_30_DAYS - Every 30 days
    • CRON_EVERY_40_DAYS - Every 40 days
    • CRON_EVERY_2_WEEKS - Every 2 weeks
    • CRON_EVERY_4_WEEKS - Every 4 weeks
    • CRON_EVERY_6_MONTHS - Every 6 months
    • CRON_EVERY_YEAR - Every year

    One of ONCE CRON_EVERY_DAY CRON_EVERY_WEEK CRON_EVERY_MONTH CRON_EVERY_QUARTER CRON_EVERY_15_MINUTES CRON_EVERY_30_MINUTES CRON_EVERY_HOUR CRON_EVERY_2_HOURS CRON_EVERY_3_HOURS CRON_EVERY_4_HOURS CRON_EVERY_5_HOURS CRON_EVERY_6_HOURS CRON_EVERY_8_HOURS CRON_EVERY_12_HOURS CRON_EVERY_2_DAYS CRON_EVERY_30_DAYS CRON_EVERY_40_DAYS CRON_EVERY_2_WEEKS CRON_EVERY_4_WEEKS CRON_EVERY_6_MONTHS CRON_EVERY_YEAR

  • cron_typestring

    Defaults to 'day' when omitted on a schedule entry.

  • cron_intervalinteger

    Min 0 · Max 2147483647

  • cron_start_of_daystring · time

    At what time the day starts.

  • cron_interval_startinteger

    Min 0 · Max 32767

  • time_range_presetinteger

    Select one of the time range presets.

    • 0 - Custom Time Range
    • 13 - Yesterday
    • 10 - Today
    • 11 - Current Week
    • 6 - Current Month
    • 7 - Previous Month
    • 17 - Last Quarter
    • 18 - Last 2 Days
    • 16 - Last 3 Days
    • 23 - Last 4 Days
    • 19 - Last 5 Days
    • 24 - Last 6 Days
    • 4 - Last 7 Days
    • 25 - Last 8 Days
    • 26 - Last 9 Days
    • 22 - Last 10 Days
    • 14 - Last 14 Days
    • 15 - Last 28 Days
    • 2 - Last 30 Days
    • 20 - Last 40 Days
    • 21 - Last 60 Days
    • 5 - Last 90 Days
    • 31 - Last 120 Days
    • 28 - Last 180 Days
    • 3 - Last 365 Days
    • 27 - Last 730 Days
    • 8 - Previous Week
    • 9 - Previous Year
    • 29 - Current Quarter
    • 12 - Current Year
    • 30 - Last Hour
    • 1000 - Lifetime
    • 50 - Tomorrow
    • 51 - Next 2 Days
    • 52 - Next 7 Days
    • 53 - Next 30 Days
    • 54 - Current Week (incl Future Days)
    • 55 - Next Week
    • 56 - Current Month (incl Future Days)
    • 57 - Next Month
    • 58 - Current Year (incl Future Days)
    • 59 - Next Year

    One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59 · Min 0 · Max 32767

  • time_range_preset_labelstringrequiredread-only
  • delta_typeinteger
    • 0 - minute(s)
    • 1 - hour(s)
    • 2 - day(s)
    • 3 - week(s)
    • 4 - month(s)
    • 6 - quarters(s)
    • 5 - year(s)
    • 7 - once

    One of 0 1 2 3 4 6 5 7 · Min -32768 · Max 32767

  • delta_intervalinteger

    Min 0 · Max 2147483647

  • delta_start_of_daystring · time

    At what time the day starts.

  • delta_interval_startinteger

    Min 0 · Max 32767

  • fixed_startstring · datenullable

    First day to fetch.

  • fixed_endstring · datenullable

    Last day to fetch.

  • offset_daysinteger

    Number of days to shift the fetched date range into the past.

    Min -32768 · Max 32767

  • not_before_datestring · datenullable

    Do not fetch before this date.

  • not_before_timestring · timenullable

    Do not fetch before this time.

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/datastreams/{parent_lookup_datastream_id}/schedules/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 1,
      "cron_preset": "ONCE",
      "cron_type": "string",
      "cron_interval": 1,
      "cron_start_of_day": "string",
      "cron_interval_start": 1,
      "time_range_preset": 0,
      "time_range_preset_label": "string",
      "delta_type": 0,
      "delta_interval": 1,
      "delta_start_of_day": "string",
      "delta_interval_start": 1,
      "fixed_start": "2024-01-01",
      "fixed_end": "2024-01-01",
      "offset_days": 1,
      "not_before_date": "2024-01-01",
      "not_before_time": "string"
    }
  ]
}

Create datastreams schedules

POST/api/datastreams/{parent_lookup_datastream_id}/schedules/

API key permissionDatastream: Writedatastream:write

Path parameters

• parent_lookup_datastream_idstringrequired

Request body

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object FetchSchedule

• cron_presetstring
  • ONCE - Once
  • CRON_EVERY_DAY - Every day
  • CRON_EVERY_WEEK - Every week
  • CRON_EVERY_MONTH - Every month
  • CRON_EVERY_QUARTER - Every quarter
  • CRON_EVERY_15_MINUTES - Every 15 minutes
  • CRON_EVERY_30_MINUTES - Every 30 minutes
  • CRON_EVERY_HOUR - Every hour
  • CRON_EVERY_2_HOURS - Every 2 hours
  • CRON_EVERY_3_HOURS - Every 3 hours
  • CRON_EVERY_4_HOURS - Every 4 hours
  • CRON_EVERY_5_HOURS - Every 5 hours
  • CRON_EVERY_6_HOURS - Every 6 hours
  • CRON_EVERY_8_HOURS - Every 8 hours
  • CRON_EVERY_12_HOURS - Every 12 hours
  • CRON_EVERY_2_DAYS - Every 2 days
  • CRON_EVERY_30_DAYS - Every 30 days
  • CRON_EVERY_40_DAYS - Every 40 days
  • CRON_EVERY_2_WEEKS - Every 2 weeks
  • CRON_EVERY_4_WEEKS - Every 4 weeks
  • CRON_EVERY_6_MONTHS - Every 6 months
  • CRON_EVERY_YEAR - Every year

  One of ONCE CRON_EVERY_DAY CRON_EVERY_WEEK CRON_EVERY_MONTH CRON_EVERY_QUARTER CRON_EVERY_15_MINUTES CRON_EVERY_30_MINUTES CRON_EVERY_HOUR CRON_EVERY_2_HOURS CRON_EVERY_3_HOURS CRON_EVERY_4_HOURS CRON_EVERY_5_HOURS CRON_EVERY_6_HOURS CRON_EVERY_8_HOURS CRON_EVERY_12_HOURS CRON_EVERY_2_DAYS CRON_EVERY_30_DAYS CRON_EVERY_40_DAYS CRON_EVERY_2_WEEKS CRON_EVERY_4_WEEKS CRON_EVERY_6_MONTHS CRON_EVERY_YEAR

• cron_typestring

  Defaults to 'day' when omitted on a schedule entry.

• cron_intervalinteger

  Min 0 · Max 2147483647

• cron_start_of_daystring · time

  At what time the day starts.

• cron_interval_startinteger

  Min 0 · Max 32767

• time_range_presetinteger

  Select one of the time range presets.

  • 0 - Custom Time Range
  • 13 - Yesterday
  • 10 - Today
  • 11 - Current Week
  • 6 - Current Month
  • 7 - Previous Month
  • 17 - Last Quarter
  • 18 - Last 2 Days
  • 16 - Last 3 Days
  • 23 - Last 4 Days
  • 19 - Last 5 Days
  • 24 - Last 6 Days
  • 4 - Last 7 Days
  • 25 - Last 8 Days
  • 26 - Last 9 Days
  • 22 - Last 10 Days
  • 14 - Last 14 Days
  • 15 - Last 28 Days
  • 2 - Last 30 Days
  • 20 - Last 40 Days
  • 21 - Last 60 Days
  • 5 - Last 90 Days
  • 31 - Last 120 Days
  • 28 - Last 180 Days
  • 3 - Last 365 Days
  • 27 - Last 730 Days
  • 8 - Previous Week
  • 9 - Previous Year
  • 29 - Current Quarter
  • 12 - Current Year
  • 30 - Last Hour
  • 1000 - Lifetime
  • 50 - Tomorrow
  • 51 - Next 2 Days
  • 52 - Next 7 Days
  • 53 - Next 30 Days
  • 54 - Current Week (incl Future Days)
  • 55 - Next Week
  • 56 - Current Month (incl Future Days)
  • 57 - Next Month
  • 58 - Current Year (incl Future Days)
  • 59 - Next Year

  One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59 · Min 0 · Max 32767

• delta_typeinteger
  • 0 - minute(s)
  • 1 - hour(s)
  • 2 - day(s)
  • 3 - week(s)
  • 4 - month(s)
  • 6 - quarters(s)
  • 5 - year(s)
  • 7 - once

  One of 0 1 2 3 4 6 5 7 · Min -32768 · Max 32767

• delta_intervalinteger

  Min 0 · Max 2147483647

• delta_start_of_daystring · time

  At what time the day starts.

• delta_interval_startinteger

  Min 0 · Max 32767

• fixed_startstring · datenullable

  First day to fetch.

• fixed_endstring · datenullable

  Last day to fetch.

• offset_daysinteger

  Number of days to shift the fetched date range into the past.

  Min -32768 · Max 32767

• not_before_datestring · datenullable

  Do not fetch before this date.

• not_before_timestring · timenullable

  Do not fetch before this time.

Responses

201Createdapplication/json

Response schema

object FetchSchedule

• idintegerrequiredread-only
• cron_presetstring
  • ONCE - Once
  • CRON_EVERY_DAY - Every day
  • CRON_EVERY_WEEK - Every week
  • CRON_EVERY_MONTH - Every month
  • CRON_EVERY_QUARTER - Every quarter
  • CRON_EVERY_15_MINUTES - Every 15 minutes
  • CRON_EVERY_30_MINUTES - Every 30 minutes
  • CRON_EVERY_HOUR - Every hour
  • CRON_EVERY_2_HOURS - Every 2 hours
  • CRON_EVERY_3_HOURS - Every 3 hours
  • CRON_EVERY_4_HOURS - Every 4 hours
  • CRON_EVERY_5_HOURS - Every 5 hours
  • CRON_EVERY_6_HOURS - Every 6 hours
  • CRON_EVERY_8_HOURS - Every 8 hours
  • CRON_EVERY_12_HOURS - Every 12 hours
  • CRON_EVERY_2_DAYS - Every 2 days
  • CRON_EVERY_30_DAYS - Every 30 days
  • CRON_EVERY_40_DAYS - Every 40 days
  • CRON_EVERY_2_WEEKS - Every 2 weeks
  • CRON_EVERY_4_WEEKS - Every 4 weeks
  • CRON_EVERY_6_MONTHS - Every 6 months
  • CRON_EVERY_YEAR - Every year

  One of ONCE CRON_EVERY_DAY CRON_EVERY_WEEK CRON_EVERY_MONTH CRON_EVERY_QUARTER CRON_EVERY_15_MINUTES CRON_EVERY_30_MINUTES CRON_EVERY_HOUR CRON_EVERY_2_HOURS CRON_EVERY_3_HOURS CRON_EVERY_4_HOURS CRON_EVERY_5_HOURS CRON_EVERY_6_HOURS CRON_EVERY_8_HOURS CRON_EVERY_12_HOURS CRON_EVERY_2_DAYS CRON_EVERY_30_DAYS CRON_EVERY_40_DAYS CRON_EVERY_2_WEEKS CRON_EVERY_4_WEEKS CRON_EVERY_6_MONTHS CRON_EVERY_YEAR

• cron_typestring

  Defaults to 'day' when omitted on a schedule entry.

• cron_intervalinteger

  Min 0 · Max 2147483647

• cron_start_of_daystring · time

  At what time the day starts.

• cron_interval_startinteger

  Min 0 · Max 32767

• time_range_presetinteger

  Select one of the time range presets.

  • 0 - Custom Time Range
  • 13 - Yesterday
  • 10 - Today
  • 11 - Current Week
  • 6 - Current Month
  • 7 - Previous Month
  • 17 - Last Quarter
  • 18 - Last 2 Days
  • 16 - Last 3 Days
  • 23 - Last 4 Days
  • 19 - Last 5 Days
  • 24 - Last 6 Days
  • 4 - Last 7 Days
  • 25 - Last 8 Days
  • 26 - Last 9 Days
  • 22 - Last 10 Days
  • 14 - Last 14 Days
  • 15 - Last 28 Days
  • 2 - Last 30 Days
  • 20 - Last 40 Days
  • 21 - Last 60 Days
  • 5 - Last 90 Days
  • 31 - Last 120 Days
  • 28 - Last 180 Days
  • 3 - Last 365 Days
  • 27 - Last 730 Days
  • 8 - Previous Week
  • 9 - Previous Year
  • 29 - Current Quarter
  • 12 - Current Year
  • 30 - Last Hour
  • 1000 - Lifetime
  • 50 - Tomorrow
  • 51 - Next 2 Days
  • 52 - Next 7 Days
  • 53 - Next 30 Days
  • 54 - Current Week (incl Future Days)
  • 55 - Next Week
  • 56 - Current Month (incl Future Days)
  • 57 - Next Month
  • 58 - Current Year (incl Future Days)
  • 59 - Next Year

  One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59 · Min 0 · Max 32767

• time_range_preset_labelstringrequiredread-only
• delta_typeinteger
  • 0 - minute(s)
  • 1 - hour(s)
  • 2 - day(s)
  • 3 - week(s)
  • 4 - month(s)
  • 6 - quarters(s)
  • 5 - year(s)
  • 7 - once

  One of 0 1 2 3 4 6 5 7 · Min -32768 · Max 32767

• delta_intervalinteger

  Min 0 · Max 2147483647

• delta_start_of_daystring · time

  At what time the day starts.

• delta_interval_startinteger

  Min 0 · Max 32767

• fixed_startstring · datenullable

  First day to fetch.

• fixed_endstring · datenullable

  Last day to fetch.

• offset_daysinteger

  Number of days to shift the fetched date range into the past.

  Min -32768 · Max 32767

• not_before_datestring · datenullable

  Do not fetch before this date.

• not_before_timestring · timenullable

  Do not fetch before this time.

RequestcURL

curl --request POST 'https://{{INSTANCE}}/api/datastreams/{parent_lookup_datastream_id}/schedules/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "cron_preset": "ONCE",
    "cron_type": "string",
    "cron_interval": 1,
    "cron_start_of_day": "string",
    "cron_interval_start": 1,
    "time_range_preset": 0,
    "delta_type": 0,
    "delta_interval": 1,
    "delta_start_of_day": "string",
    "delta_interval_start": 1,
    "fixed_start": "2024-01-01",
    "fixed_end": "2024-01-01",
    "offset_days": 1,
    "not_before_date": "2024-01-01",
    "not_before_time": "string"
  }'

Response201

{
  "id": 1,
  "cron_preset": "ONCE",
  "cron_type": "string",
  "cron_interval": 1,
  "cron_start_of_day": "string",
  "cron_interval_start": 1,
  "time_range_preset": 0,
  "time_range_preset_label": "string",
  "delta_type": 0,
  "delta_interval": 1,
  "delta_start_of_day": "string",
  "delta_interval_start": 1,
  "fixed_start": "2024-01-01",
  "fixed_end": "2024-01-01",
  "offset_days": 1,
  "not_before_date": "2024-01-01",
  "not_before_time": "string"
}

Get datastreams schedules

GET/api/datastreams/{parent_lookup_datastream_id}/schedules/{id}/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• idintegerrequired

  A unique integer value identifying this fetch schedule.

• parent_lookup_datastream_idstringrequired

Responses

200OKapplication/json

Response schema

object FetchSchedule

• idintegerrequiredread-only
• cron_presetstring
  • ONCE - Once
  • CRON_EVERY_DAY - Every day
  • CRON_EVERY_WEEK - Every week
  • CRON_EVERY_MONTH - Every month
  • CRON_EVERY_QUARTER - Every quarter
  • CRON_EVERY_15_MINUTES - Every 15 minutes
  • CRON_EVERY_30_MINUTES - Every 30 minutes
  • CRON_EVERY_HOUR - Every hour
  • CRON_EVERY_2_HOURS - Every 2 hours
  • CRON_EVERY_3_HOURS - Every 3 hours
  • CRON_EVERY_4_HOURS - Every 4 hours
  • CRON_EVERY_5_HOURS - Every 5 hours
  • CRON_EVERY_6_HOURS - Every 6 hours
  • CRON_EVERY_8_HOURS - Every 8 hours
  • CRON_EVERY_12_HOURS - Every 12 hours
  • CRON_EVERY_2_DAYS - Every 2 days
  • CRON_EVERY_30_DAYS - Every 30 days
  • CRON_EVERY_40_DAYS - Every 40 days
  • CRON_EVERY_2_WEEKS - Every 2 weeks
  • CRON_EVERY_4_WEEKS - Every 4 weeks
  • CRON_EVERY_6_MONTHS - Every 6 months
  • CRON_EVERY_YEAR - Every year

  One of ONCE CRON_EVERY_DAY CRON_EVERY_WEEK CRON_EVERY_MONTH CRON_EVERY_QUARTER CRON_EVERY_15_MINUTES CRON_EVERY_30_MINUTES CRON_EVERY_HOUR CRON_EVERY_2_HOURS CRON_EVERY_3_HOURS CRON_EVERY_4_HOURS CRON_EVERY_5_HOURS CRON_EVERY_6_HOURS CRON_EVERY_8_HOURS CRON_EVERY_12_HOURS CRON_EVERY_2_DAYS CRON_EVERY_30_DAYS CRON_EVERY_40_DAYS CRON_EVERY_2_WEEKS CRON_EVERY_4_WEEKS CRON_EVERY_6_MONTHS CRON_EVERY_YEAR

• cron_typestring

  Defaults to 'day' when omitted on a schedule entry.

• cron_intervalinteger

  Min 0 · Max 2147483647

• cron_start_of_daystring · time

  At what time the day starts.

• cron_interval_startinteger

  Min 0 · Max 32767

• time_range_presetinteger

  Select one of the time range presets.

  • 0 - Custom Time Range
  • 13 - Yesterday
  • 10 - Today
  • 11 - Current Week
  • 6 - Current Month
  • 7 - Previous Month
  • 17 - Last Quarter
  • 18 - Last 2 Days
  • 16 - Last 3 Days
  • 23 - Last 4 Days
  • 19 - Last 5 Days
  • 24 - Last 6 Days
  • 4 - Last 7 Days
  • 25 - Last 8 Days
  • 26 - Last 9 Days
  • 22 - Last 10 Days
  • 14 - Last 14 Days
  • 15 - Last 28 Days
  • 2 - Last 30 Days
  • 20 - Last 40 Days
  • 21 - Last 60 Days
  • 5 - Last 90 Days
  • 31 - Last 120 Days
  • 28 - Last 180 Days
  • 3 - Last 365 Days
  • 27 - Last 730 Days
  • 8 - Previous Week
  • 9 - Previous Year
  • 29 - Current Quarter
  • 12 - Current Year
  • 30 - Last Hour
  • 1000 - Lifetime
  • 50 - Tomorrow
  • 51 - Next 2 Days
  • 52 - Next 7 Days
  • 53 - Next 30 Days
  • 54 - Current Week (incl Future Days)
  • 55 - Next Week
  • 56 - Current Month (incl Future Days)
  • 57 - Next Month
  • 58 - Current Year (incl Future Days)
  • 59 - Next Year

  One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59 · Min 0 · Max 32767

• time_range_preset_labelstringrequiredread-only
• delta_typeinteger
  • 0 - minute(s)
  • 1 - hour(s)
  • 2 - day(s)
  • 3 - week(s)
  • 4 - month(s)
  • 6 - quarters(s)
  • 5 - year(s)
  • 7 - once

  One of 0 1 2 3 4 6 5 7 · Min -32768 · Max 32767

• delta_intervalinteger

  Min 0 · Max 2147483647

• delta_start_of_daystring · time

  At what time the day starts.

• delta_interval_startinteger

  Min 0 · Max 32767

• fixed_startstring · datenullable

  First day to fetch.

• fixed_endstring · datenullable

  Last day to fetch.

• offset_daysinteger

  Number of days to shift the fetched date range into the past.

  Min -32768 · Max 32767

• not_before_datestring · datenullable

  Do not fetch before this date.

• not_before_timestring · timenullable

  Do not fetch before this time.

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/datastreams/{parent_lookup_datastream_id}/schedules/{id}/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "id": 1,
  "cron_preset": "ONCE",
  "cron_type": "string",
  "cron_interval": 1,
  "cron_start_of_day": "string",
  "cron_interval_start": 1,
  "time_range_preset": 0,
  "time_range_preset_label": "string",
  "delta_type": 0,
  "delta_interval": 1,
  "delta_start_of_day": "string",
  "delta_interval_start": 1,
  "fixed_start": "2024-01-01",
  "fixed_end": "2024-01-01",
  "offset_days": 1,
  "not_before_date": "2024-01-01",
  "not_before_time": "string"
}

Replace datastreams schedules

PUT/api/datastreams/{parent_lookup_datastream_id}/schedules/{id}/

API key permissionDatastream: Writedatastream:write

Path parameters

• idintegerrequired

  A unique integer value identifying this fetch schedule.

• parent_lookup_datastream_idstringrequired

Request body

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object FetchSchedule

• cron_presetstring
  • ONCE - Once
  • CRON_EVERY_DAY - Every day
  • CRON_EVERY_WEEK - Every week
  • CRON_EVERY_MONTH - Every month
  • CRON_EVERY_QUARTER - Every quarter
  • CRON_EVERY_15_MINUTES - Every 15 minutes
  • CRON_EVERY_30_MINUTES - Every 30 minutes
  • CRON_EVERY_HOUR - Every hour
  • CRON_EVERY_2_HOURS - Every 2 hours
  • CRON_EVERY_3_HOURS - Every 3 hours
  • CRON_EVERY_4_HOURS - Every 4 hours
  • CRON_EVERY_5_HOURS - Every 5 hours
  • CRON_EVERY_6_HOURS - Every 6 hours
  • CRON_EVERY_8_HOURS - Every 8 hours
  • CRON_EVERY_12_HOURS - Every 12 hours
  • CRON_EVERY_2_DAYS - Every 2 days
  • CRON_EVERY_30_DAYS - Every 30 days
  • CRON_EVERY_40_DAYS - Every 40 days
  • CRON_EVERY_2_WEEKS - Every 2 weeks
  • CRON_EVERY_4_WEEKS - Every 4 weeks
  • CRON_EVERY_6_MONTHS - Every 6 months
  • CRON_EVERY_YEAR - Every year

  One of ONCE CRON_EVERY_DAY CRON_EVERY_WEEK CRON_EVERY_MONTH CRON_EVERY_QUARTER CRON_EVERY_15_MINUTES CRON_EVERY_30_MINUTES CRON_EVERY_HOUR CRON_EVERY_2_HOURS CRON_EVERY_3_HOURS CRON_EVERY_4_HOURS CRON_EVERY_5_HOURS CRON_EVERY_6_HOURS CRON_EVERY_8_HOURS CRON_EVERY_12_HOURS CRON_EVERY_2_DAYS CRON_EVERY_30_DAYS CRON_EVERY_40_DAYS CRON_EVERY_2_WEEKS CRON_EVERY_4_WEEKS CRON_EVERY_6_MONTHS CRON_EVERY_YEAR

• cron_typestring

  Defaults to 'day' when omitted on a schedule entry.

• cron_intervalinteger

  Min 0 · Max 2147483647

• cron_start_of_daystring · time

  At what time the day starts.

• cron_interval_startinteger

  Min 0 · Max 32767

• time_range_presetinteger

  Select one of the time range presets.

  • 0 - Custom Time Range
  • 13 - Yesterday
  • 10 - Today
  • 11 - Current Week
  • 6 - Current Month
  • 7 - Previous Month
  • 17 - Last Quarter
  • 18 - Last 2 Days
  • 16 - Last 3 Days
  • 23 - Last 4 Days
  • 19 - Last 5 Days
  • 24 - Last 6 Days
  • 4 - Last 7 Days
  • 25 - Last 8 Days
  • 26 - Last 9 Days
  • 22 - Last 10 Days
  • 14 - Last 14 Days
  • 15 - Last 28 Days
  • 2 - Last 30 Days
  • 20 - Last 40 Days
  • 21 - Last 60 Days
  • 5 - Last 90 Days
  • 31 - Last 120 Days
  • 28 - Last 180 Days
  • 3 - Last 365 Days
  • 27 - Last 730 Days
  • 8 - Previous Week
  • 9 - Previous Year
  • 29 - Current Quarter
  • 12 - Current Year
  • 30 - Last Hour
  • 1000 - Lifetime
  • 50 - Tomorrow
  • 51 - Next 2 Days
  • 52 - Next 7 Days
  • 53 - Next 30 Days
  • 54 - Current Week (incl Future Days)
  • 55 - Next Week
  • 56 - Current Month (incl Future Days)
  • 57 - Next Month
  • 58 - Current Year (incl Future Days)
  • 59 - Next Year

  One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59 · Min 0 · Max 32767

• delta_typeinteger
  • 0 - minute(s)
  • 1 - hour(s)
  • 2 - day(s)
  • 3 - week(s)
  • 4 - month(s)
  • 6 - quarters(s)
  • 5 - year(s)
  • 7 - once

  One of 0 1 2 3 4 6 5 7 · Min -32768 · Max 32767

• delta_intervalinteger

  Min 0 · Max 2147483647

• delta_start_of_daystring · time

  At what time the day starts.

• delta_interval_startinteger

  Min 0 · Max 32767

• fixed_startstring · datenullable

  First day to fetch.

• fixed_endstring · datenullable

  Last day to fetch.

• offset_daysinteger

  Number of days to shift the fetched date range into the past.

  Min -32768 · Max 32767

• not_before_datestring · datenullable

  Do not fetch before this date.

• not_before_timestring · timenullable

  Do not fetch before this time.

Responses

200OKapplication/json

Response schema

object FetchSchedule

• idintegerrequiredread-only
• cron_presetstring
  • ONCE - Once
  • CRON_EVERY_DAY - Every day
  • CRON_EVERY_WEEK - Every week
  • CRON_EVERY_MONTH - Every month
  • CRON_EVERY_QUARTER - Every quarter
  • CRON_EVERY_15_MINUTES - Every 15 minutes
  • CRON_EVERY_30_MINUTES - Every 30 minutes
  • CRON_EVERY_HOUR - Every hour
  • CRON_EVERY_2_HOURS - Every 2 hours
  • CRON_EVERY_3_HOURS - Every 3 hours
  • CRON_EVERY_4_HOURS - Every 4 hours
  • CRON_EVERY_5_HOURS - Every 5 hours
  • CRON_EVERY_6_HOURS - Every 6 hours
  • CRON_EVERY_8_HOURS - Every 8 hours
  • CRON_EVERY_12_HOURS - Every 12 hours
  • CRON_EVERY_2_DAYS - Every 2 days
  • CRON_EVERY_30_DAYS - Every 30 days
  • CRON_EVERY_40_DAYS - Every 40 days
  • CRON_EVERY_2_WEEKS - Every 2 weeks
  • CRON_EVERY_4_WEEKS - Every 4 weeks
  • CRON_EVERY_6_MONTHS - Every 6 months
  • CRON_EVERY_YEAR - Every year

  One of ONCE CRON_EVERY_DAY CRON_EVERY_WEEK CRON_EVERY_MONTH CRON_EVERY_QUARTER CRON_EVERY_15_MINUTES CRON_EVERY_30_MINUTES CRON_EVERY_HOUR CRON_EVERY_2_HOURS CRON_EVERY_3_HOURS CRON_EVERY_4_HOURS CRON_EVERY_5_HOURS CRON_EVERY_6_HOURS CRON_EVERY_8_HOURS CRON_EVERY_12_HOURS CRON_EVERY_2_DAYS CRON_EVERY_30_DAYS CRON_EVERY_40_DAYS CRON_EVERY_2_WEEKS CRON_EVERY_4_WEEKS CRON_EVERY_6_MONTHS CRON_EVERY_YEAR

• cron_typestring

  Defaults to 'day' when omitted on a schedule entry.

• cron_intervalinteger

  Min 0 · Max 2147483647

• cron_start_of_daystring · time

  At what time the day starts.

• cron_interval_startinteger

  Min 0 · Max 32767

• time_range_presetinteger

  Select one of the time range presets.

  • 0 - Custom Time Range
  • 13 - Yesterday
  • 10 - Today
  • 11 - Current Week
  • 6 - Current Month
  • 7 - Previous Month
  • 17 - Last Quarter
  • 18 - Last 2 Days
  • 16 - Last 3 Days
  • 23 - Last 4 Days
  • 19 - Last 5 Days
  • 24 - Last 6 Days
  • 4 - Last 7 Days
  • 25 - Last 8 Days
  • 26 - Last 9 Days
  • 22 - Last 10 Days
  • 14 - Last 14 Days
  • 15 - Last 28 Days
  • 2 - Last 30 Days
  • 20 - Last 40 Days
  • 21 - Last 60 Days
  • 5 - Last 90 Days
  • 31 - Last 120 Days
  • 28 - Last 180 Days
  • 3 - Last 365 Days
  • 27 - Last 730 Days
  • 8 - Previous Week
  • 9 - Previous Year
  • 29 - Current Quarter
  • 12 - Current Year
  • 30 - Last Hour
  • 1000 - Lifetime
  • 50 - Tomorrow
  • 51 - Next 2 Days
  • 52 - Next 7 Days
  • 53 - Next 30 Days
  • 54 - Current Week (incl Future Days)
  • 55 - Next Week
  • 56 - Current Month (incl Future Days)
  • 57 - Next Month
  • 58 - Current Year (incl Future Days)
  • 59 - Next Year

  One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59 · Min 0 · Max 32767

• time_range_preset_labelstringrequiredread-only
• delta_typeinteger
  • 0 - minute(s)
  • 1 - hour(s)
  • 2 - day(s)
  • 3 - week(s)
  • 4 - month(s)
  • 6 - quarters(s)
  • 5 - year(s)
  • 7 - once

  One of 0 1 2 3 4 6 5 7 · Min -32768 · Max 32767

• delta_intervalinteger

  Min 0 · Max 2147483647

• delta_start_of_daystring · time

  At what time the day starts.

• delta_interval_startinteger

  Min 0 · Max 32767

• fixed_startstring · datenullable

  First day to fetch.

• fixed_endstring · datenullable

  Last day to fetch.

• offset_daysinteger

  Number of days to shift the fetched date range into the past.

  Min -32768 · Max 32767

• not_before_datestring · datenullable

  Do not fetch before this date.

• not_before_timestring · timenullable

  Do not fetch before this time.

RequestcURL

curl --request PUT 'https://{{INSTANCE}}/api/datastreams/{parent_lookup_datastream_id}/schedules/{id}/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "cron_preset": "ONCE",
    "cron_type": "string",
    "cron_interval": 1,
    "cron_start_of_day": "string",
    "cron_interval_start": 1,
    "time_range_preset": 0,
    "delta_type": 0,
    "delta_interval": 1,
    "delta_start_of_day": "string",
    "delta_interval_start": 1,
    "fixed_start": "2024-01-01",
    "fixed_end": "2024-01-01",
    "offset_days": 1,
    "not_before_date": "2024-01-01",
    "not_before_time": "string"
  }'

Response200

{
  "id": 1,
  "cron_preset": "ONCE",
  "cron_type": "string",
  "cron_interval": 1,
  "cron_start_of_day": "string",
  "cron_interval_start": 1,
  "time_range_preset": 0,
  "time_range_preset_label": "string",
  "delta_type": 0,
  "delta_interval": 1,
  "delta_start_of_day": "string",
  "delta_interval_start": 1,
  "fixed_start": "2024-01-01",
  "fixed_end": "2024-01-01",
  "offset_days": 1,
  "not_before_date": "2024-01-01",
  "not_before_time": "string"
}

Update datastreams schedules

PATCH/api/datastreams/{parent_lookup_datastream_id}/schedules/{id}/

API key permissionDatastream: Writedatastream:write

Path parameters

• idintegerrequired

  A unique integer value identifying this fetch schedule.

• parent_lookup_datastream_idstringrequired

Request body

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object PatchedFetchSchedule

• cron_presetstring
  • ONCE - Once
  • CRON_EVERY_DAY - Every day
  • CRON_EVERY_WEEK - Every week
  • CRON_EVERY_MONTH - Every month
  • CRON_EVERY_QUARTER - Every quarter
  • CRON_EVERY_15_MINUTES - Every 15 minutes
  • CRON_EVERY_30_MINUTES - Every 30 minutes
  • CRON_EVERY_HOUR - Every hour
  • CRON_EVERY_2_HOURS - Every 2 hours
  • CRON_EVERY_3_HOURS - Every 3 hours
  • CRON_EVERY_4_HOURS - Every 4 hours
  • CRON_EVERY_5_HOURS - Every 5 hours
  • CRON_EVERY_6_HOURS - Every 6 hours
  • CRON_EVERY_8_HOURS - Every 8 hours
  • CRON_EVERY_12_HOURS - Every 12 hours
  • CRON_EVERY_2_DAYS - Every 2 days
  • CRON_EVERY_30_DAYS - Every 30 days
  • CRON_EVERY_40_DAYS - Every 40 days
  • CRON_EVERY_2_WEEKS - Every 2 weeks
  • CRON_EVERY_4_WEEKS - Every 4 weeks
  • CRON_EVERY_6_MONTHS - Every 6 months
  • CRON_EVERY_YEAR - Every year

  One of ONCE CRON_EVERY_DAY CRON_EVERY_WEEK CRON_EVERY_MONTH CRON_EVERY_QUARTER CRON_EVERY_15_MINUTES CRON_EVERY_30_MINUTES CRON_EVERY_HOUR CRON_EVERY_2_HOURS CRON_EVERY_3_HOURS CRON_EVERY_4_HOURS CRON_EVERY_5_HOURS CRON_EVERY_6_HOURS CRON_EVERY_8_HOURS CRON_EVERY_12_HOURS CRON_EVERY_2_DAYS CRON_EVERY_30_DAYS CRON_EVERY_40_DAYS CRON_EVERY_2_WEEKS CRON_EVERY_4_WEEKS CRON_EVERY_6_MONTHS CRON_EVERY_YEAR

• cron_typestring

  Defaults to 'day' when omitted on a schedule entry.

• cron_intervalinteger

  Min 0 · Max 2147483647

• cron_start_of_daystring · time

  At what time the day starts.

• cron_interval_startinteger

  Min 0 · Max 32767

• time_range_presetinteger

  Select one of the time range presets.

  • 0 - Custom Time Range
  • 13 - Yesterday
  • 10 - Today
  • 11 - Current Week
  • 6 - Current Month
  • 7 - Previous Month
  • 17 - Last Quarter
  • 18 - Last 2 Days
  • 16 - Last 3 Days
  • 23 - Last 4 Days
  • 19 - Last 5 Days
  • 24 - Last 6 Days
  • 4 - Last 7 Days
  • 25 - Last 8 Days
  • 26 - Last 9 Days
  • 22 - Last 10 Days
  • 14 - Last 14 Days
  • 15 - Last 28 Days
  • 2 - Last 30 Days
  • 20 - Last 40 Days
  • 21 - Last 60 Days
  • 5 - Last 90 Days
  • 31 - Last 120 Days
  • 28 - Last 180 Days
  • 3 - Last 365 Days
  • 27 - Last 730 Days
  • 8 - Previous Week
  • 9 - Previous Year
  • 29 - Current Quarter
  • 12 - Current Year
  • 30 - Last Hour
  • 1000 - Lifetime
  • 50 - Tomorrow
  • 51 - Next 2 Days
  • 52 - Next 7 Days
  • 53 - Next 30 Days
  • 54 - Current Week (incl Future Days)
  • 55 - Next Week
  • 56 - Current Month (incl Future Days)
  • 57 - Next Month
  • 58 - Current Year (incl Future Days)
  • 59 - Next Year

  One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59 · Min 0 · Max 32767

• delta_typeinteger
  • 0 - minute(s)
  • 1 - hour(s)
  • 2 - day(s)
  • 3 - week(s)
  • 4 - month(s)
  • 6 - quarters(s)
  • 5 - year(s)
  • 7 - once

  One of 0 1 2 3 4 6 5 7 · Min -32768 · Max 32767

• delta_intervalinteger

  Min 0 · Max 2147483647

• delta_start_of_daystring · time

  At what time the day starts.

• delta_interval_startinteger

  Min 0 · Max 32767

• fixed_startstring · datenullable

  First day to fetch.

• fixed_endstring · datenullable

  Last day to fetch.

• offset_daysinteger

  Number of days to shift the fetched date range into the past.

  Min -32768 · Max 32767

• not_before_datestring · datenullable

  Do not fetch before this date.

• not_before_timestring · timenullable

  Do not fetch before this time.

Responses

200OKapplication/json

Response schema

object FetchSchedule

• idintegerrequiredread-only
• cron_presetstring
  • ONCE - Once
  • CRON_EVERY_DAY - Every day
  • CRON_EVERY_WEEK - Every week
  • CRON_EVERY_MONTH - Every month
  • CRON_EVERY_QUARTER - Every quarter
  • CRON_EVERY_15_MINUTES - Every 15 minutes
  • CRON_EVERY_30_MINUTES - Every 30 minutes
  • CRON_EVERY_HOUR - Every hour
  • CRON_EVERY_2_HOURS - Every 2 hours
  • CRON_EVERY_3_HOURS - Every 3 hours
  • CRON_EVERY_4_HOURS - Every 4 hours
  • CRON_EVERY_5_HOURS - Every 5 hours
  • CRON_EVERY_6_HOURS - Every 6 hours
  • CRON_EVERY_8_HOURS - Every 8 hours
  • CRON_EVERY_12_HOURS - Every 12 hours
  • CRON_EVERY_2_DAYS - Every 2 days
  • CRON_EVERY_30_DAYS - Every 30 days
  • CRON_EVERY_40_DAYS - Every 40 days
  • CRON_EVERY_2_WEEKS - Every 2 weeks
  • CRON_EVERY_4_WEEKS - Every 4 weeks
  • CRON_EVERY_6_MONTHS - Every 6 months
  • CRON_EVERY_YEAR - Every year

  One of ONCE CRON_EVERY_DAY CRON_EVERY_WEEK CRON_EVERY_MONTH CRON_EVERY_QUARTER CRON_EVERY_15_MINUTES CRON_EVERY_30_MINUTES CRON_EVERY_HOUR CRON_EVERY_2_HOURS CRON_EVERY_3_HOURS CRON_EVERY_4_HOURS CRON_EVERY_5_HOURS CRON_EVERY_6_HOURS CRON_EVERY_8_HOURS CRON_EVERY_12_HOURS CRON_EVERY_2_DAYS CRON_EVERY_30_DAYS CRON_EVERY_40_DAYS CRON_EVERY_2_WEEKS CRON_EVERY_4_WEEKS CRON_EVERY_6_MONTHS CRON_EVERY_YEAR

• cron_typestring

  Defaults to 'day' when omitted on a schedule entry.

• cron_intervalinteger

  Min 0 · Max 2147483647

• cron_start_of_daystring · time

  At what time the day starts.

• cron_interval_startinteger

  Min 0 · Max 32767

• time_range_presetinteger

  Select one of the time range presets.

  • 0 - Custom Time Range
  • 13 - Yesterday
  • 10 - Today
  • 11 - Current Week
  • 6 - Current Month
  • 7 - Previous Month
  • 17 - Last Quarter
  • 18 - Last 2 Days
  • 16 - Last 3 Days
  • 23 - Last 4 Days
  • 19 - Last 5 Days
  • 24 - Last 6 Days
  • 4 - Last 7 Days
  • 25 - Last 8 Days
  • 26 - Last 9 Days
  • 22 - Last 10 Days
  • 14 - Last 14 Days
  • 15 - Last 28 Days
  • 2 - Last 30 Days
  • 20 - Last 40 Days
  • 21 - Last 60 Days
  • 5 - Last 90 Days
  • 31 - Last 120 Days
  • 28 - Last 180 Days
  • 3 - Last 365 Days
  • 27 - Last 730 Days
  • 8 - Previous Week
  • 9 - Previous Year
  • 29 - Current Quarter
  • 12 - Current Year
  • 30 - Last Hour
  • 1000 - Lifetime
  • 50 - Tomorrow
  • 51 - Next 2 Days
  • 52 - Next 7 Days
  • 53 - Next 30 Days
  • 54 - Current Week (incl Future Days)
  • 55 - Next Week
  • 56 - Current Month (incl Future Days)
  • 57 - Next Month
  • 58 - Current Year (incl Future Days)
  • 59 - Next Year

  One of 0 13 10 11 6 7 17 18 16 23 19 24 4 25 26 22 14 15 2 20 21 5 31 28 3 27 8 9 29 12 30 1000 50 51 52 53 54 55 56 57 58 59 · Min 0 · Max 32767

• time_range_preset_labelstringrequiredread-only
• delta_typeinteger
  • 0 - minute(s)
  • 1 - hour(s)
  • 2 - day(s)
  • 3 - week(s)
  • 4 - month(s)
  • 6 - quarters(s)
  • 5 - year(s)
  • 7 - once

  One of 0 1 2 3 4 6 5 7 · Min -32768 · Max 32767

• delta_intervalinteger

  Min 0 · Max 2147483647

• delta_start_of_daystring · time

  At what time the day starts.

• delta_interval_startinteger

  Min 0 · Max 32767

• fixed_startstring · datenullable

  First day to fetch.

• fixed_endstring · datenullable

  Last day to fetch.

• offset_daysinteger

  Number of days to shift the fetched date range into the past.

  Min -32768 · Max 32767

• not_before_datestring · datenullable

  Do not fetch before this date.

• not_before_timestring · timenullable

  Do not fetch before this time.

RequestcURL

curl --request PATCH 'https://{{INSTANCE}}/api/datastreams/{parent_lookup_datastream_id}/schedules/{id}/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "cron_preset": "ONCE",
    "cron_type": "string",
    "cron_interval": 1,
    "cron_start_of_day": "string",
    "cron_interval_start": 1,
    "time_range_preset": 0,
    "delta_type": 0,
    "delta_interval": 1,
    "delta_start_of_day": "string",
    "delta_interval_start": 1,
    "fixed_start": "2024-01-01",
    "fixed_end": "2024-01-01",
    "offset_days": 1,
    "not_before_date": "2024-01-01",
    "not_before_time": "string"
  }'

Response200

{
  "id": 1,
  "cron_preset": "ONCE",
  "cron_type": "string",
  "cron_interval": 1,
  "cron_start_of_day": "string",
  "cron_interval_start": 1,
  "time_range_preset": 0,
  "time_range_preset_label": "string",
  "delta_type": 0,
  "delta_interval": 1,
  "delta_start_of_day": "string",
  "delta_interval_start": 1,
  "fixed_start": "2024-01-01",
  "fixed_end": "2024-01-01",
  "offset_days": 1,
  "not_before_date": "2024-01-01",
  "not_before_time": "string"
}

Delete datastreams schedules

DELETE/api/datastreams/{parent_lookup_datastream_id}/schedules/{id}/

API key permissionDatastream: Writedatastream:write

Path parameters

• idintegerrequired

  A unique integer value identifying this fetch schedule.

• parent_lookup_datastream_idstringrequired

Responses

204No response body

RequestcURL

curl --request DELETE 'https://{{INSTANCE}}/api/datastreams/{parent_lookup_datastream_id}/schedules/{id}/' \
  --header 'Authorization: Bearer {{KEY}}'

Response204

No response body.

List extracts

GET/api/extracts/

API key permissionDatastream: Read-onlydatastream:read

Query parameters

• created_fromstring · date-time
• created_tostring · date-time
• datastream_idnumber
• job_group_idinteger
• job_idinteger
• namestring
• orderingstring

  Which field to use when ordering the results.

• pageinteger

  A page number within the paginated result set.

• page_sizeinteger

  Number of results to return per page.

• scheduled_fromstring · date-time
• scheduled_tostring · date-time
• stack_idnumber
• statearray of integer
  • 3 - Processing
  • 1 - Collected
  • 5 - Notified
  • 7 - Pending
  • 2 - Transferred
  • 4 - Load error
  • 16 - Processing error
  • 8 - Deleted
  • 9 - No data collected
  • 10 - Deferred
  • 11 - Parked
  • 12 - Loaded
  • 13 - Failed
  • 14 - Raw
  • 15 - Overwritten
  • 6 - Transformation error
  • 17 - Removed - Personally Identifiable Information
• tagsstring

Responses

200OKapplication/json

Response schema

object PaginatedDatastreamExtractList

• countintegerrequired

  Example 123

• nextstring · urinullable

  Example "http://api.example.org/accounts/?page=4"

• previousstring · urinullable

  Example "http://api.example.org/accounts/?page=2"

• resultsarray of objectrequired
  Items · DatastreamExtract

  • idintegerrequiredread-only
  • createdstring · date-timerequired
  • datastreamobjectrequired
    Attributes · APIDatastreamBasic

    • idintegerrequiredread-only
    • uuidstring · uuidrequiredread-only
    • stackobjectrequiredread-only
      Attributes · StackBasic

      • idintegerrequiredread-only
      • uuidstring · uuidrequiredread-only
      • namestringrequired

        Max length 60

      • slugstringrequiredread-only
      • urlstring · urirequiredread-only
      • change_urlstringrequiredread-only
      • extracts_urlstringrequiredread-only
      • issues_urlstringrequiredread-only
      • overview_urlstringrequiredread-only
      • permissionsstringrequiredread-only
    • stack_idintegerrequiredread-only

      Which workspace the datastream belongs to.

    • authintegernullable

      Which authorization the datastream uses.

    • namestringrequired

      A human readable name. Numbers and special characters are supported.

      Max length 150

    • slugstringrequiredread-only
    • app_labelstringrequiredread-only
    • absolute_urlstringrequiredread-only
    • change_urlstringrequiredread-only
    • extracts_urlstringrequiredread-only
    • fetch_urlstringrequiredread-only
    • overview_urlstringrequiredread-only
    • schema_mapping_urlstringrequiredread-only
    • enabledboolean

      Streams that are not scheduled will not be fetched automatically.

    • next_runstring · date-timerequiredread-only
    • urlstring · urirequiredread-only
    • datastream_type_idintegerrequiredread-only
    • logo_urlstringrequiredread-only
    • extracts_stream_urlstringrequiredread-only
    • supports_extended_intervalsstringrequiredread-only
    • updatedstring · date-timerequiredread-only
    • createdstring · date-timerequiredread-only
    • creatorstringrequiredread-onlynullable
    • can_be_fetchedbooleanrequiredread-only
  • namestringrequired

    Max length 255

  • scheduledstring · date-timenullable
  • nrowsinteger · int64nullable

    Min -9223372036854775808 · Max 9223372036854775807

  • ncolsintegernullable

    Min 0 · Max 32767

  • filesizeinteger · int64nullable

    Min -9223372036854775808 · Max 9223372036854775807

  • state_labelstringrequiredread-only
  • state_colorstringrequiredread-only
  • preview_urlstringrequiredread-only
  • refetch_urlstringrequiredread-only
  • requeue_urlstringrequiredread-only
  • download_urlstringrequiredread-only
  • metadataany
  • tagsarray of stringrequired
  • explore_urlstringrequiredread-only
  • dashboard_urlstringrequiredread-only

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/extracts/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 1,
      "created": "2024-01-01T00:00:00Z",
      "datastream": {
        "id": 1,
        "uuid": "00000000-0000-0000-0000-000000000000",
        "stack": {
          "id": 1,
          "uuid": "00000000-0000-0000-0000-000000000000",
          "name": "string",
          "slug": "string",
          "url": "https://example.com",
          "change_url": "string",
          "extracts_url": "string",
          "issues_url": "string",
          "overview_url": "string",
          "permissions": "string"
        },
        "stack_id": 1,
        "auth": 1,
        "name": "string",
        "slug": "string",
        "app_label": "string",
        "absolute_url": "string",
        "change_url": "string",
        "extracts_url": "string",
        "fetch_url": "string",
        "overview_url": "string",
        "schema_mapping_url": "string",
        "enabled": true,
        "next_run": "2024-01-01T00:00:00Z",
        "url": "https://example.com",
        "datastream_type_id": 1,
        "logo_url": "string",
        "extracts_stream_url": "string",
        "supports_extended_intervals": "string",
        "updated": "2024-01-01T00:00:00Z",
        "created": "2024-01-01T00:00:00Z",
        "creator": "string",
        "can_be_fetched": true
      },
      "name": "string",
      "scheduled": "2024-01-01T00:00:00Z",
      "nrows": 1,
      "ncols": 1,
      "filesize": 1,
      "state_label": "string",
      "state_color": "string",
      "preview_url": "string",
      "refetch_url": "string",
      "requeue_url": "string",
      "download_url": "string",
      "metadata": null,
      "tags": [
        "string"
      ],
      "explore_url": "string",
      "dashboard_url": "string"
    }
  ]
}

Get extracts

GET/api/extracts/{id}/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream extract.

Responses

200OKapplication/json

Response schema

object DatastreamExtract

• idintegerrequiredread-only
• createdstring · date-timerequired
• datastreamobjectrequired
  Attributes · APIDatastreamBasic

  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • stackobjectrequiredread-only
    Attributes · StackBasic

    • idintegerrequiredread-only
    • uuidstring · uuidrequiredread-only
    • namestringrequired

      Max length 60

    • slugstringrequiredread-only
    • urlstring · urirequiredread-only
    • change_urlstringrequiredread-only
    • extracts_urlstringrequiredread-only
    • issues_urlstringrequiredread-only
    • overview_urlstringrequiredread-only
    • permissionsstringrequiredread-only
  • stack_idintegerrequiredread-only

    Which workspace the datastream belongs to.

  • authintegernullable

    Which authorization the datastream uses.

  • namestringrequired

    A human readable name. Numbers and special characters are supported.

    Max length 150

  • slugstringrequiredread-only
  • app_labelstringrequiredread-only
  • absolute_urlstringrequiredread-only
  • change_urlstringrequiredread-only
  • extracts_urlstringrequiredread-only
  • fetch_urlstringrequiredread-only
  • overview_urlstringrequiredread-only
  • schema_mapping_urlstringrequiredread-only
  • enabledboolean

    Streams that are not scheduled will not be fetched automatically.

  • next_runstring · date-timerequiredread-only
  • urlstring · urirequiredread-only
  • datastream_type_idintegerrequiredread-only
  • logo_urlstringrequiredread-only
  • extracts_stream_urlstringrequiredread-only
  • supports_extended_intervalsstringrequiredread-only
  • updatedstring · date-timerequiredread-only
  • createdstring · date-timerequiredread-only
  • creatorstringrequiredread-onlynullable
  • can_be_fetchedbooleanrequiredread-only
• namestringrequired

  Max length 255

• scheduledstring · date-timenullable
• nrowsinteger · int64nullable

  Min -9223372036854775808 · Max 9223372036854775807

• ncolsintegernullable

  Min 0 · Max 32767

• filesizeinteger · int64nullable

  Min -9223372036854775808 · Max 9223372036854775807

• state_labelstringrequiredread-only
• state_colorstringrequiredread-only
• preview_urlstringrequiredread-only
• refetch_urlstringrequiredread-only
• requeue_urlstringrequiredread-only
• download_urlstringrequiredread-only
• metadataany
• tagsarray of stringrequired
• explore_urlstringrequiredread-only
• dashboard_urlstringrequiredread-only

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/extracts/{id}/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "id": 1,
  "created": "2024-01-01T00:00:00Z",
  "datastream": {
    "id": 1,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "stack": {
      "id": 1,
      "uuid": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "slug": "string",
      "url": "https://example.com",
      "change_url": "string",
      "extracts_url": "string",
      "issues_url": "string",
      "overview_url": "string",
      "permissions": "string"
    },
    "stack_id": 1,
    "auth": 1,
    "name": "string",
    "slug": "string",
    "app_label": "string",
    "absolute_url": "string",
    "change_url": "string",
    "extracts_url": "string",
    "fetch_url": "string",
    "overview_url": "string",
    "schema_mapping_url": "string",
    "enabled": true,
    "next_run": "2024-01-01T00:00:00Z",
    "url": "https://example.com",
    "datastream_type_id": 1,
    "logo_url": "string",
    "extracts_stream_url": "string",
    "supports_extended_intervals": "string",
    "updated": "2024-01-01T00:00:00Z",
    "created": "2024-01-01T00:00:00Z",
    "creator": "string",
    "can_be_fetched": true
  },
  "name": "string",
  "scheduled": "2024-01-01T00:00:00Z",
  "nrows": 1,
  "ncols": 1,
  "filesize": 1,
  "state_label": "string",
  "state_color": "string",
  "preview_url": "string",
  "refetch_url": "string",
  "requeue_url": "string",
  "download_url": "string",
  "metadata": null,
  "tags": [
    "string"
  ],
  "explore_url": "string",
  "dashboard_url": "string"
}

Get extracts columns

GET/api/extracts/{id}/columns/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream extract.

Responses

200OKapplication/json

Response schema

object DatastreamExtract

• idintegerrequiredread-only
• createdstring · date-timerequired
• datastreamobjectrequired
  Attributes · APIDatastreamBasic

  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • stackobjectrequiredread-only
    Attributes · StackBasic

    • idintegerrequiredread-only
    • uuidstring · uuidrequiredread-only
    • namestringrequired

      Max length 60

    • slugstringrequiredread-only
    • urlstring · urirequiredread-only
    • change_urlstringrequiredread-only
    • extracts_urlstringrequiredread-only
    • issues_urlstringrequiredread-only
    • overview_urlstringrequiredread-only
    • permissionsstringrequiredread-only
  • stack_idintegerrequiredread-only

    Which workspace the datastream belongs to.

  • authintegernullable

    Which authorization the datastream uses.

  • namestringrequired

    A human readable name. Numbers and special characters are supported.

    Max length 150

  • slugstringrequiredread-only
  • app_labelstringrequiredread-only
  • absolute_urlstringrequiredread-only
  • change_urlstringrequiredread-only
  • extracts_urlstringrequiredread-only
  • fetch_urlstringrequiredread-only
  • overview_urlstringrequiredread-only
  • schema_mapping_urlstringrequiredread-only
  • enabledboolean

    Streams that are not scheduled will not be fetched automatically.

  • next_runstring · date-timerequiredread-only
  • urlstring · urirequiredread-only
  • datastream_type_idintegerrequiredread-only
  • logo_urlstringrequiredread-only
  • extracts_stream_urlstringrequiredread-only
  • supports_extended_intervalsstringrequiredread-only
  • updatedstring · date-timerequiredread-only
  • createdstring · date-timerequiredread-only
  • creatorstringrequiredread-onlynullable
  • can_be_fetchedbooleanrequiredread-only
• namestringrequired

  Max length 255

• scheduledstring · date-timenullable
• nrowsinteger · int64nullable

  Min -9223372036854775808 · Max 9223372036854775807

• ncolsintegernullable

  Min 0 · Max 32767

• filesizeinteger · int64nullable

  Min -9223372036854775808 · Max 9223372036854775807

• state_labelstringrequiredread-only
• state_colorstringrequiredread-only
• preview_urlstringrequiredread-only
• refetch_urlstringrequiredread-only
• requeue_urlstringrequiredread-only
• download_urlstringrequiredread-only
• metadataany
• tagsarray of stringrequired
• explore_urlstringrequiredread-only
• dashboard_urlstringrequiredread-only

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/extracts/{id}/columns/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "id": 1,
  "created": "2024-01-01T00:00:00Z",
  "datastream": {
    "id": 1,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "stack": {
      "id": 1,
      "uuid": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "slug": "string",
      "url": "https://example.com",
      "change_url": "string",
      "extracts_url": "string",
      "issues_url": "string",
      "overview_url": "string",
      "permissions": "string"
    },
    "stack_id": 1,
    "auth": 1,
    "name": "string",
    "slug": "string",
    "app_label": "string",
    "absolute_url": "string",
    "change_url": "string",
    "extracts_url": "string",
    "fetch_url": "string",
    "overview_url": "string",
    "schema_mapping_url": "string",
    "enabled": true,
    "next_run": "2024-01-01T00:00:00Z",
    "url": "https://example.com",
    "datastream_type_id": 1,
    "logo_url": "string",
    "extracts_stream_url": "string",
    "supports_extended_intervals": "string",
    "updated": "2024-01-01T00:00:00Z",
    "created": "2024-01-01T00:00:00Z",
    "creator": "string",
    "can_be_fetched": true
  },
  "name": "string",
  "scheduled": "2024-01-01T00:00:00Z",
  "nrows": 1,
  "ncols": 1,
  "filesize": 1,
  "state_label": "string",
  "state_color": "string",
  "preview_url": "string",
  "refetch_url": "string",
  "requeue_url": "string",
  "download_url": "string",
  "metadata": null,
  "tags": [
    "string"
  ],
  "explore_url": "string",
  "dashboard_url": "string"
}

Get extracts data

GET/api/extracts/{id}/data/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream extract.

Responses

200OKapplication/json

Response schema

object DatastreamExtract

• idintegerrequiredread-only
• createdstring · date-timerequired
• datastreamobjectrequired
  Attributes · APIDatastreamBasic

  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • stackobjectrequiredread-only
    Attributes · StackBasic

    • idintegerrequiredread-only
    • uuidstring · uuidrequiredread-only
    • namestringrequired

      Max length 60

    • slugstringrequiredread-only
    • urlstring · urirequiredread-only
    • change_urlstringrequiredread-only
    • extracts_urlstringrequiredread-only
    • issues_urlstringrequiredread-only
    • overview_urlstringrequiredread-only
    • permissionsstringrequiredread-only
  • stack_idintegerrequiredread-only

    Which workspace the datastream belongs to.

  • authintegernullable

    Which authorization the datastream uses.

  • namestringrequired

    A human readable name. Numbers and special characters are supported.

    Max length 150

  • slugstringrequiredread-only
  • app_labelstringrequiredread-only
  • absolute_urlstringrequiredread-only
  • change_urlstringrequiredread-only
  • extracts_urlstringrequiredread-only
  • fetch_urlstringrequiredread-only
  • overview_urlstringrequiredread-only
  • schema_mapping_urlstringrequiredread-only
  • enabledboolean

    Streams that are not scheduled will not be fetched automatically.

  • next_runstring · date-timerequiredread-only
  • urlstring · urirequiredread-only
  • datastream_type_idintegerrequiredread-only
  • logo_urlstringrequiredread-only
  • extracts_stream_urlstringrequiredread-only
  • supports_extended_intervalsstringrequiredread-only
  • updatedstring · date-timerequiredread-only
  • createdstring · date-timerequiredread-only
  • creatorstringrequiredread-onlynullable
  • can_be_fetchedbooleanrequiredread-only
• namestringrequired

  Max length 255

• scheduledstring · date-timenullable
• nrowsinteger · int64nullable

  Min -9223372036854775808 · Max 9223372036854775807

• ncolsintegernullable

  Min 0 · Max 32767

• filesizeinteger · int64nullable

  Min -9223372036854775808 · Max 9223372036854775807

• state_labelstringrequiredread-only
• state_colorstringrequiredread-only
• preview_urlstringrequiredread-only
• refetch_urlstringrequiredread-only
• requeue_urlstringrequiredread-only
• download_urlstringrequiredread-only
• metadataany
• tagsarray of stringrequired
• explore_urlstringrequiredread-only
• dashboard_urlstringrequiredread-only

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/extracts/{id}/data/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "id": 1,
  "created": "2024-01-01T00:00:00Z",
  "datastream": {
    "id": 1,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "stack": {
      "id": 1,
      "uuid": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "slug": "string",
      "url": "https://example.com",
      "change_url": "string",
      "extracts_url": "string",
      "issues_url": "string",
      "overview_url": "string",
      "permissions": "string"
    },
    "stack_id": 1,
    "auth": 1,
    "name": "string",
    "slug": "string",
    "app_label": "string",
    "absolute_url": "string",
    "change_url": "string",
    "extracts_url": "string",
    "fetch_url": "string",
    "overview_url": "string",
    "schema_mapping_url": "string",
    "enabled": true,
    "next_run": "2024-01-01T00:00:00Z",
    "url": "https://example.com",
    "datastream_type_id": 1,
    "logo_url": "string",
    "extracts_stream_url": "string",
    "supports_extended_intervals": "string",
    "updated": "2024-01-01T00:00:00Z",
    "created": "2024-01-01T00:00:00Z",
    "creator": "string",
    "can_be_fetched": true
  },
  "name": "string",
  "scheduled": "2024-01-01T00:00:00Z",
  "nrows": 1,
  "ncols": 1,
  "filesize": 1,
  "state_label": "string",
  "state_color": "string",
  "preview_url": "string",
  "refetch_url": "string",
  "requeue_url": "string",
  "download_url": "string",
  "metadata": null,
  "tags": [
    "string"
  ],
  "explore_url": "string",
  "dashboard_url": "string"
}

Get extracts download

GET/api/extracts/{id}/download/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream extract.

Responses

200Raw extract streamed inline (text extracts, or binary on a non-presigned backend).application/json

Response schema

string · binary

202Acceptedapplication/json

Response schema

object ExtractDownloadDispatch

• task_idstringrequired
• status_urlstringrequired

302Redirect to a presigned URL for raw binary extracts on S3/GCS backends.

400Invalid query parameters (e.g. unknown fileformat).

403Connector policy forbids extract download for API callers.

404Extract not found or no longer accessible.

406Extract too large to export to the requested format.

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/extracts/{id}/download/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

"string"

Get extracts download ready

GET/api/extracts/{id}/download/ready/{task_id}/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream extract.

• task_idstringrequired

Responses

200Staged converted file streamed as an attachment.application/json

Response schema

string · binary

403Connector policy forbids extract download for API callers.

404Download is not ready, the staged file has expired, or the task belongs to another extract.

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/extracts/{id}/download/ready/{task_id}/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

"string"

Get extracts download status

GET/api/extracts/{id}/download/status/{task_id}/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream extract.

• task_idstringrequired

Responses

200OKapplication/json

Response schema

object ExtractDownloadStatus

• statestringrequired
• ready_urlstring
• filenamestringnullable
• mimetypestringnullable
• size_bytesintegernullable
• expires_atstringnullable
• errorstring
• error_messagestring

403Connector policy forbids extract download for API callers.

404Extract no longer accessible, or the task belongs to another extract.

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/extracts/{id}/download/status/{task_id}/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "state": "string",
  "ready_url": "string",
  "filename": "string",
  "mimetype": "string",
  "size_bytes": 1,
  "expires_at": "string",
  "error": "string",
  "error_message": "string"
}

Get extracts metadata

GET/api/extracts/{id}/metadata/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream extract.

Responses

200OKapplication/json

Response schema

object DatastreamExtract

• idintegerrequiredread-only
• createdstring · date-timerequired
• datastreamobjectrequired
  Attributes · APIDatastreamBasic

  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • stackobjectrequiredread-only
    Attributes · StackBasic

    • idintegerrequiredread-only
    • uuidstring · uuidrequiredread-only
    • namestringrequired

      Max length 60

    • slugstringrequiredread-only
    • urlstring · urirequiredread-only
    • change_urlstringrequiredread-only
    • extracts_urlstringrequiredread-only
    • issues_urlstringrequiredread-only
    • overview_urlstringrequiredread-only
    • permissionsstringrequiredread-only
  • stack_idintegerrequiredread-only

    Which workspace the datastream belongs to.

  • authintegernullable

    Which authorization the datastream uses.

  • namestringrequired

    A human readable name. Numbers and special characters are supported.

    Max length 150

  • slugstringrequiredread-only
  • app_labelstringrequiredread-only
  • absolute_urlstringrequiredread-only
  • change_urlstringrequiredread-only
  • extracts_urlstringrequiredread-only
  • fetch_urlstringrequiredread-only
  • overview_urlstringrequiredread-only
  • schema_mapping_urlstringrequiredread-only
  • enabledboolean

    Streams that are not scheduled will not be fetched automatically.

  • next_runstring · date-timerequiredread-only
  • urlstring · urirequiredread-only
  • datastream_type_idintegerrequiredread-only
  • logo_urlstringrequiredread-only
  • extracts_stream_urlstringrequiredread-only
  • supports_extended_intervalsstringrequiredread-only
  • updatedstring · date-timerequiredread-only
  • createdstring · date-timerequiredread-only
  • creatorstringrequiredread-onlynullable
  • can_be_fetchedbooleanrequiredread-only
• namestringrequired

  Max length 255

• scheduledstring · date-timenullable
• nrowsinteger · int64nullable

  Min -9223372036854775808 · Max 9223372036854775807

• ncolsintegernullable

  Min 0 · Max 32767

• filesizeinteger · int64nullable

  Min -9223372036854775808 · Max 9223372036854775807

• state_labelstringrequiredread-only
• state_colorstringrequiredread-only
• preview_urlstringrequiredread-only
• refetch_urlstringrequiredread-only
• requeue_urlstringrequiredread-only
• download_urlstringrequiredread-only
• metadataany
• tagsarray of stringrequired
• explore_urlstringrequiredread-only
• dashboard_urlstringrequiredread-only

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/extracts/{id}/metadata/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "id": 1,
  "created": "2024-01-01T00:00:00Z",
  "datastream": {
    "id": 1,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "stack": {
      "id": 1,
      "uuid": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "slug": "string",
      "url": "https://example.com",
      "change_url": "string",
      "extracts_url": "string",
      "issues_url": "string",
      "overview_url": "string",
      "permissions": "string"
    },
    "stack_id": 1,
    "auth": 1,
    "name": "string",
    "slug": "string",
    "app_label": "string",
    "absolute_url": "string",
    "change_url": "string",
    "extracts_url": "string",
    "fetch_url": "string",
    "overview_url": "string",
    "schema_mapping_url": "string",
    "enabled": true,
    "next_run": "2024-01-01T00:00:00Z",
    "url": "https://example.com",
    "datastream_type_id": 1,
    "logo_url": "string",
    "extracts_stream_url": "string",
    "supports_extended_intervals": "string",
    "updated": "2024-01-01T00:00:00Z",
    "created": "2024-01-01T00:00:00Z",
    "creator": "string",
    "can_be_fetched": true
  },
  "name": "string",
  "scheduled": "2024-01-01T00:00:00Z",
  "nrows": 1,
  "ncols": 1,
  "filesize": 1,
  "state_label": "string",
  "state_color": "string",
  "preview_url": "string",
  "refetch_url": "string",
  "requeue_url": "string",
  "download_url": "string",
  "metadata": null,
  "tags": [
    "string"
  ],
  "explore_url": "string",
  "dashboard_url": "string"
}

Replace extracts tags

PUT/api/extracts/{id}/tags/

API key permissionDatastream: Writedatastream:write

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream extract.

Request bodyrequired

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object DatastreamExtract

• createdstring · date-timerequired
• datastreamobjectrequired
  Attributes · APIDatastreamBasic

  • authintegernullable

    Which authorization the datastream uses.

  • namestringrequired

    A human readable name. Numbers and special characters are supported.

    Max length 150

  • enabledboolean

    Streams that are not scheduled will not be fetched automatically.

• namestringrequired

  Max length 255

• scheduledstring · date-timenullable
• nrowsinteger · int64nullable

  Min -9223372036854775808 · Max 9223372036854775807

• ncolsintegernullable

  Min 0 · Max 32767

• filesizeinteger · int64nullable

  Min -9223372036854775808 · Max 9223372036854775807

• metadataany
• tagsarray of stringrequired

Responses

200OKapplication/json

Response schema

object DatastreamExtract

• idintegerrequiredread-only
• createdstring · date-timerequired
• datastreamobjectrequired
  Attributes · APIDatastreamBasic

  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • stackobjectrequiredread-only
    Attributes · StackBasic

    • idintegerrequiredread-only
    • uuidstring · uuidrequiredread-only
    • namestringrequired

      Max length 60

    • slugstringrequiredread-only
    • urlstring · urirequiredread-only
    • change_urlstringrequiredread-only
    • extracts_urlstringrequiredread-only
    • issues_urlstringrequiredread-only
    • overview_urlstringrequiredread-only
    • permissionsstringrequiredread-only
  • stack_idintegerrequiredread-only

    Which workspace the datastream belongs to.

  • authintegernullable

    Which authorization the datastream uses.

  • namestringrequired

    A human readable name. Numbers and special characters are supported.

    Max length 150

  • slugstringrequiredread-only
  • app_labelstringrequiredread-only
  • absolute_urlstringrequiredread-only
  • change_urlstringrequiredread-only
  • extracts_urlstringrequiredread-only
  • fetch_urlstringrequiredread-only
  • overview_urlstringrequiredread-only
  • schema_mapping_urlstringrequiredread-only
  • enabledboolean

    Streams that are not scheduled will not be fetched automatically.

  • next_runstring · date-timerequiredread-only
  • urlstring · urirequiredread-only
  • datastream_type_idintegerrequiredread-only
  • logo_urlstringrequiredread-only
  • extracts_stream_urlstringrequiredread-only
  • supports_extended_intervalsstringrequiredread-only
  • updatedstring · date-timerequiredread-only
  • createdstring · date-timerequiredread-only
  • creatorstringrequiredread-onlynullable
  • can_be_fetchedbooleanrequiredread-only
• namestringrequired

  Max length 255

• scheduledstring · date-timenullable
• nrowsinteger · int64nullable

  Min -9223372036854775808 · Max 9223372036854775807

• ncolsintegernullable

  Min 0 · Max 32767

• filesizeinteger · int64nullable

  Min -9223372036854775808 · Max 9223372036854775807

• state_labelstringrequiredread-only
• state_colorstringrequiredread-only
• preview_urlstringrequiredread-only
• refetch_urlstringrequiredread-only
• requeue_urlstringrequiredread-only
• download_urlstringrequiredread-only
• metadataany
• tagsarray of stringrequired
• explore_urlstringrequiredread-only
• dashboard_urlstringrequiredread-only

RequestcURL

curl --request PUT 'https://{{INSTANCE}}/api/extracts/{id}/tags/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "created": "2024-01-01T00:00:00Z",
    "datastream": {
      "auth": 1,
      "name": "string",
      "enabled": true
    },
    "name": "string",
    "scheduled": "2024-01-01T00:00:00Z",
    "nrows": 1,
    "ncols": 1,
    "filesize": 1,
    "metadata": null,
    "tags": [
      "string"
    ]
  }'

Response200

{
  "id": 1,
  "created": "2024-01-01T00:00:00Z",
  "datastream": {
    "id": 1,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "stack": {
      "id": 1,
      "uuid": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "slug": "string",
      "url": "https://example.com",
      "change_url": "string",
      "extracts_url": "string",
      "issues_url": "string",
      "overview_url": "string",
      "permissions": "string"
    },
    "stack_id": 1,
    "auth": 1,
    "name": "string",
    "slug": "string",
    "app_label": "string",
    "absolute_url": "string",
    "change_url": "string",
    "extracts_url": "string",
    "fetch_url": "string",
    "overview_url": "string",
    "schema_mapping_url": "string",
    "enabled": true,
    "next_run": "2024-01-01T00:00:00Z",
    "url": "https://example.com",
    "datastream_type_id": 1,
    "logo_url": "string",
    "extracts_stream_url": "string",
    "supports_extended_intervals": "string",
    "updated": "2024-01-01T00:00:00Z",
    "created": "2024-01-01T00:00:00Z",
    "creator": "string",
    "can_be_fetched": true
  },
  "name": "string",
  "scheduled": "2024-01-01T00:00:00Z",
  "nrows": 1,
  "ncols": 1,
  "filesize": 1,
  "state_label": "string",
  "state_color": "string",
  "preview_url": "string",
  "refetch_url": "string",
  "requeue_url": "string",
  "download_url": "string",
  "metadata": null,
  "tags": [
    "string"
  ],
  "explore_url": "string",
  "dashboard_url": "string"
}

Create extracts transform apply

POST/api/extracts/{id}/transform/apply/

API key permissionDatastream: Writedatastream:write

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream extract.

Request bodyrequired

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object DatastreamExtract

• createdstring · date-timerequired
• datastreamobjectrequired
  Attributes · APIDatastreamBasic

  • authintegernullable

    Which authorization the datastream uses.

  • namestringrequired

    A human readable name. Numbers and special characters are supported.

    Max length 150

  • enabledboolean

    Streams that are not scheduled will not be fetched automatically.

• namestringrequired

  Max length 255

• scheduledstring · date-timenullable
• nrowsinteger · int64nullable

  Min -9223372036854775808 · Max 9223372036854775807

• ncolsintegernullable

  Min 0 · Max 32767

• filesizeinteger · int64nullable

  Min -9223372036854775808 · Max 9223372036854775807

• metadataany
• tagsarray of stringrequired

Responses

200OKapplication/json

Response schema

object DatastreamExtract

• idintegerrequiredread-only
• createdstring · date-timerequired
• datastreamobjectrequired
  Attributes · APIDatastreamBasic

  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • stackobjectrequiredread-only
    Attributes · StackBasic

    • idintegerrequiredread-only
    • uuidstring · uuidrequiredread-only
    • namestringrequired

      Max length 60

    • slugstringrequiredread-only
    • urlstring · urirequiredread-only
    • change_urlstringrequiredread-only
    • extracts_urlstringrequiredread-only
    • issues_urlstringrequiredread-only
    • overview_urlstringrequiredread-only
    • permissionsstringrequiredread-only
  • stack_idintegerrequiredread-only

    Which workspace the datastream belongs to.

  • authintegernullable

    Which authorization the datastream uses.

  • namestringrequired

    A human readable name. Numbers and special characters are supported.

    Max length 150

  • slugstringrequiredread-only
  • app_labelstringrequiredread-only
  • absolute_urlstringrequiredread-only
  • change_urlstringrequiredread-only
  • extracts_urlstringrequiredread-only
  • fetch_urlstringrequiredread-only
  • overview_urlstringrequiredread-only
  • schema_mapping_urlstringrequiredread-only
  • enabledboolean

    Streams that are not scheduled will not be fetched automatically.

  • next_runstring · date-timerequiredread-only
  • urlstring · urirequiredread-only
  • datastream_type_idintegerrequiredread-only
  • logo_urlstringrequiredread-only
  • extracts_stream_urlstringrequiredread-only
  • supports_extended_intervalsstringrequiredread-only
  • updatedstring · date-timerequiredread-only
  • createdstring · date-timerequiredread-only
  • creatorstringrequiredread-onlynullable
  • can_be_fetchedbooleanrequiredread-only
• namestringrequired

  Max length 255

• scheduledstring · date-timenullable
• nrowsinteger · int64nullable

  Min -9223372036854775808 · Max 9223372036854775807

• ncolsintegernullable

  Min 0 · Max 32767

• filesizeinteger · int64nullable

  Min -9223372036854775808 · Max 9223372036854775807

• state_labelstringrequiredread-only
• state_colorstringrequiredread-only
• preview_urlstringrequiredread-only
• refetch_urlstringrequiredread-only
• requeue_urlstringrequiredread-only
• download_urlstringrequiredread-only
• metadataany
• tagsarray of stringrequired
• explore_urlstringrequiredread-only
• dashboard_urlstringrequiredread-only

RequestcURL

curl --request POST 'https://{{INSTANCE}}/api/extracts/{id}/transform/apply/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "created": "2024-01-01T00:00:00Z",
    "datastream": {
      "auth": 1,
      "name": "string",
      "enabled": true
    },
    "name": "string",
    "scheduled": "2024-01-01T00:00:00Z",
    "nrows": 1,
    "ncols": 1,
    "filesize": 1,
    "metadata": null,
    "tags": [
      "string"
    ]
  }'

Response200

{
  "id": 1,
  "created": "2024-01-01T00:00:00Z",
  "datastream": {
    "id": 1,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "stack": {
      "id": 1,
      "uuid": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "slug": "string",
      "url": "https://example.com",
      "change_url": "string",
      "extracts_url": "string",
      "issues_url": "string",
      "overview_url": "string",
      "permissions": "string"
    },
    "stack_id": 1,
    "auth": 1,
    "name": "string",
    "slug": "string",
    "app_label": "string",
    "absolute_url": "string",
    "change_url": "string",
    "extracts_url": "string",
    "fetch_url": "string",
    "overview_url": "string",
    "schema_mapping_url": "string",
    "enabled": true,
    "next_run": "2024-01-01T00:00:00Z",
    "url": "https://example.com",
    "datastream_type_id": 1,
    "logo_url": "string",
    "extracts_stream_url": "string",
    "supports_extended_intervals": "string",
    "updated": "2024-01-01T00:00:00Z",
    "created": "2024-01-01T00:00:00Z",
    "creator": "string",
    "can_be_fetched": true
  },
  "name": "string",
  "scheduled": "2024-01-01T00:00:00Z",
  "nrows": 1,
  "ncols": 1,
  "filesize": 1,
  "state_label": "string",
  "state_color": "string",
  "preview_url": "string",
  "refetch_url": "string",
  "requeue_url": "string",
  "download_url": "string",
  "metadata": null,
  "tags": [
    "string"
  ],
  "explore_url": "string",
  "dashboard_url": "string"
}

Create extracts transform preview

POST/api/extracts/{id}/transform/preview/

API key permissionDatastream: Writedatastream:write

Path parameters

• idintegerrequired

  A unique integer value identifying this Datastream extract.

Request bodyrequired

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object DatastreamExtract

• createdstring · date-timerequired
• datastreamobjectrequired
  Attributes · APIDatastreamBasic

  • authintegernullable

    Which authorization the datastream uses.

  • namestringrequired

    A human readable name. Numbers and special characters are supported.

    Max length 150

  • enabledboolean

    Streams that are not scheduled will not be fetched automatically.

• namestringrequired

  Max length 255

• scheduledstring · date-timenullable
• nrowsinteger · int64nullable

  Min -9223372036854775808 · Max 9223372036854775807

• ncolsintegernullable

  Min 0 · Max 32767

• filesizeinteger · int64nullable

  Min -9223372036854775808 · Max 9223372036854775807

• metadataany
• tagsarray of stringrequired

Responses

200OKapplication/json

Response schema

object DatastreamExtract

• idintegerrequiredread-only
• createdstring · date-timerequired
• datastreamobjectrequired
  Attributes · APIDatastreamBasic

  • idintegerrequiredread-only
  • uuidstring · uuidrequiredread-only
  • stackobjectrequiredread-only
    Attributes · StackBasic

    • idintegerrequiredread-only
    • uuidstring · uuidrequiredread-only
    • namestringrequired

      Max length 60

    • slugstringrequiredread-only
    • urlstring · urirequiredread-only
    • change_urlstringrequiredread-only
    • extracts_urlstringrequiredread-only
    • issues_urlstringrequiredread-only
    • overview_urlstringrequiredread-only
    • permissionsstringrequiredread-only
  • stack_idintegerrequiredread-only

    Which workspace the datastream belongs to.

  • authintegernullable

    Which authorization the datastream uses.

  • namestringrequired

    A human readable name. Numbers and special characters are supported.

    Max length 150

  • slugstringrequiredread-only
  • app_labelstringrequiredread-only
  • absolute_urlstringrequiredread-only
  • change_urlstringrequiredread-only
  • extracts_urlstringrequiredread-only
  • fetch_urlstringrequiredread-only
  • overview_urlstringrequiredread-only
  • schema_mapping_urlstringrequiredread-only
  • enabledboolean

    Streams that are not scheduled will not be fetched automatically.

  • next_runstring · date-timerequiredread-only
  • urlstring · urirequiredread-only
  • datastream_type_idintegerrequiredread-only
  • logo_urlstringrequiredread-only
  • extracts_stream_urlstringrequiredread-only
  • supports_extended_intervalsstringrequiredread-only
  • updatedstring · date-timerequiredread-only
  • createdstring · date-timerequiredread-only
  • creatorstringrequiredread-onlynullable
  • can_be_fetchedbooleanrequiredread-only
• namestringrequired

  Max length 255

• scheduledstring · date-timenullable
• nrowsinteger · int64nullable

  Min -9223372036854775808 · Max 9223372036854775807

• ncolsintegernullable

  Min 0 · Max 32767

• filesizeinteger · int64nullable

  Min -9223372036854775808 · Max 9223372036854775807

• state_labelstringrequiredread-only
• state_colorstringrequiredread-only
• preview_urlstringrequiredread-only
• refetch_urlstringrequiredread-only
• requeue_urlstringrequiredread-only
• download_urlstringrequiredread-only
• metadataany
• tagsarray of stringrequired
• explore_urlstringrequiredread-only
• dashboard_urlstringrequiredread-only

RequestcURL

curl --request POST 'https://{{INSTANCE}}/api/extracts/{id}/transform/preview/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "created": "2024-01-01T00:00:00Z",
    "datastream": {
      "auth": 1,
      "name": "string",
      "enabled": true
    },
    "name": "string",
    "scheduled": "2024-01-01T00:00:00Z",
    "nrows": 1,
    "ncols": 1,
    "filesize": 1,
    "metadata": null,
    "tags": [
      "string"
    ]
  }'

Response200

{
  "id": 1,
  "created": "2024-01-01T00:00:00Z",
  "datastream": {
    "id": 1,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "stack": {
      "id": 1,
      "uuid": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "slug": "string",
      "url": "https://example.com",
      "change_url": "string",
      "extracts_url": "string",
      "issues_url": "string",
      "overview_url": "string",
      "permissions": "string"
    },
    "stack_id": 1,
    "auth": 1,
    "name": "string",
    "slug": "string",
    "app_label": "string",
    "absolute_url": "string",
    "change_url": "string",
    "extracts_url": "string",
    "fetch_url": "string",
    "overview_url": "string",
    "schema_mapping_url": "string",
    "enabled": true,
    "next_run": "2024-01-01T00:00:00Z",
    "url": "https://example.com",
    "datastream_type_id": 1,
    "logo_url": "string",
    "extracts_stream_url": "string",
    "supports_extended_intervals": "string",
    "updated": "2024-01-01T00:00:00Z",
    "created": "2024-01-01T00:00:00Z",
    "creator": "string",
    "can_be_fetched": true
  },
  "name": "string",
  "scheduled": "2024-01-01T00:00:00Z",
  "nrows": 1,
  "ncols": 1,
  "filesize": 1,
  "state_label": "string",
  "state_color": "string",
  "preview_url": "string",
  "refetch_url": "string",
  "requeue_url": "string",
  "download_url": "string",
  "metadata": null,
  "tags": [
    "string"
  ],
  "explore_url": "string",
  "dashboard_url": "string"
}

List datastreams (GET /api/v1/datastreams/)

GET/api/v1/datastreams/

API key permissionDatastream: Read-onlydatastream:read

Retrieve datastreams with their common configuration options.

Query parameters

• workspace_scopestring
• scope_from_workspace_idstring · uuid

  Required only for workspace_scope when multiple roots exist.

• datastream_idarray of string · uuid
• workspace_idarray of string · uuid
• enabledboolean
• active_pulling_modestring
• scheduled_deletionboolean
• tagarray of string

  Tag name, ignoring case, matched in every workspace the key can see: the same name in two workspaces is two tags, and this matches both. Combine with workspace_id to match the tag of one workspace. Repeatable.

• tag_matchstring

  any: carries at least one of the given tags. all: carries every one.

  One of any all · Default "any"

• pageinteger

  Default 1 · Min 1

• page_sizeinteger

  Default 50 · Min 1

Responses

200OKapplication/json

Response schema

object PagedDatastreamListItemSchema

• itemsarray of objectrequired
  Items · DatastreamListItemSchema

  • idstring · uuidrequired
  • namestringrequired
  • enabledbooleanrequired
  • pullingobjectrequired
    Attributes · PullingSchema

    • active_modestringnullable
      Attributes

      • ActivePullingMode

      • null

    • smartobjectnullable
      Attributes

      • SmartPullingReadSchema

        • is_activebooleanrequired
        • range_specarray of objectrequired

          The fetch schedule the datastream runs: up to four rules, each pairing a frequency with the time range to re-fetch when it fires. The authoritative half of this object.

          Items · SmartPullingRangeRule

          • frequencyobjectrequired

            How often a range is (re-)pulled, e.g. {value: 40, unit: day}.

            Attributes · Frequency

            • valueintegerrequired

              Min 1

            • unitstringrequired

              One of day week month quarter year

          • rangeobjectrequired

            How much history to pull each time, e.g. {value: 1, unit: month}.

            Every range is pulled *to date*: it resolves to a window ending yesterday, never at a stale past boundary (smart_fetch.utils.date.resolve_range). {value: 7, unit: day} is the last 7 days ending yesterday; a calendar unit snaps the window's start to a period boundary, so {value: 1, unit: month} runs from the 1st of *last* month through yesterday -- the "Last Month to date" window, growing as the current month progresses.

            Hence the smallest value is 1 (inherited from TimeBase) and not 0: one period back is a to-date window's own base, and 0 -- which core.constants' plain to-date presets use for the current period *including today* -- is not expressible here.

            Attributes · Range

            • valueintegerrequired

              Min 1

            • unitstringrequired

              One of day week month quarter year

          • onobjectnullable
            Attributes

            • On

              • dayintegerrequired

                Min 1 · Max 28

              • day_typestringrequired

                One of week month

            • null

        • deadlineobjectnullable
          Attributes

          • DeadlineSchema

            • timestring · timenullable

              Time of day the data should be delivered by, on the half hour (e.g. 17:00:00). UTC only: an offset is rejected rather than converted. Null means as soon as possible.

              Attributes

              • string · time

              • null

          • null

        • startobjectnullable

          Earliest fetch start. Omit the field to keep whatever is already stored; send null to inherit the workspace default; send an object to set a per-datastream value. Must be before the effective deadline once inheritance is resolved.

          Attributes

          • StartSchema

            • timestring · timenullable

              Earliest time of day a fetch may start, on the half hour (e.g. 09:00:00). UTC only: an offset is rejected rather than converted. Null lifts the restriction for this datastream, overriding any workspace default.

              Attributes

              • string · time

              • null

          • null

        • frequencystringrequired

          One of daily weekly monthly

        • refresh_rangeobjectnullable

          History re-fetched beyond one frequency period by the rule frequency was taken from, always expressed in days. Derived and lossy, like frequency.

          Attributes

          • RefreshRangeSchema

            • valueintegerrequired
            • unitstringrequired

              One of day week month

          • null

      • null

    • smart_bundlearray of objectnullable
      Attributes

      • array of object

      • null

    • schedulearray of objectnullable
      Attributes

      • array of object

      • null

  • workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema

    • idstring · uuidrequired
    • namestringrequired
  • tagsarray of objectrequired
    Items · DatastreamTagMinimalSchema

    • idstring · uuidrequired
    • namestringrequired
• countintegerrequired

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/v1/datastreams/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "enabled": true,
      "pulling": {
        "active_mode": "smart",
        "smart": {
          "is_active": null,
          "range_spec": null,
          "deadline": null,
          "start": null,
          "frequency": null,
          "refresh_range": null
        },
        "smart_bundle": [
          {}
        ],
        "schedule": [
          {}
        ]
      },
      "workspace": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
      },
      "tags": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "string"
        }
      ]
    }
  ],
  "count": 1
}

Partially update common configuration options

PATCH/api/v1/datastreams/

API key permissionDatastream: Writedatastream:write

Query parameters

• workspace_scopestring
• scope_from_workspace_idstring · uuid

  Required only for workspace_scope when multiple roots exist.

• datastream_idarray of string · uuid
• workspace_idarray of string · uuid
• enabledboolean
• active_pulling_modestring
• scheduled_deletionboolean
• tagarray of string

  Tag name, ignoring case, matched in every workspace the key can see: the same name in two workspaces is two tags, and this matches both. Combine with workspace_id to match the tag of one workspace. Repeatable.

• tag_matchstring

  any: carries at least one of the given tags. all: carries every one.

  One of any all · Default "any"

Request bodyrequired

application/json

Body schema

object DatastreamListItemPatchSchema

• enabledbooleannullable
  Attributes

  • boolean

  • null

• pullingobjectnullable
  Attributes

  • PullingPatchSchema

    • active_modestringnullable
      Attributes

      • ActivePullingSetMode

      • null

  • null

Responses

200OKapplication/json

Response schema

object BulkActionResponseSchema

• affectedobjectrequired
  Attributes · AffectedDatastreamsSchema

  • datastream_idsarray of string · uuidrequired

RequestcURL

curl --request PATCH 'https://{{INSTANCE}}/api/v1/datastreams/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "enabled": true,
    "pulling": {
      "active_mode": "smart"
    }
  }'

Response200

{
  "affected": {
    "datastream_ids": [
      "00000000-0000-0000-0000-000000000000"
    ]
  }
}

Bulk assign monitors to datastreams

POST/api/v1/datastreams/custom-monitors/deprecated

API key permissionMonitor: Writemonitor:write

Query parameters

• workspace_scopestring
• scope_from_workspace_idstring · uuid

  Required only for workspace_scope when multiple roots exist.

• datastream_idarray of string · uuid
• workspace_idarray of string · uuid
• enabledboolean
• active_pulling_modestring
• scheduled_deletionboolean
• tagarray of string

  Tag name, ignoring case, matched in every workspace the key can see: the same name in two workspaces is two tags, and this matches both. Combine with workspace_id to match the tag of one workspace. Repeatable.

• tag_matchstring

  any: carries at least one of the given tags. all: carries every one.

  One of any all · Default "any"

Request bodyrequired

application/json

Body schema

array of string · uuid UUIDListSchema

Responses

200OKapplication/json

Response schema

object BulkMonitorAssignmentResponseSchema

• assigned_datastream_idsarray of string · uuidrequired
• skipped_datastream_idsarray of string · uuidrequired

RequestcURL

curl --request POST 'https://{{INSTANCE}}/api/v1/datastreams/custom-monitors/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '[
    "00000000-0000-0000-0000-000000000000"
  ]'

Response200

{
  "assigned_datastream_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "skipped_datastream_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

Bulk unassign monitors from datastreams

DELETE/api/v1/datastreams/custom-monitors/deprecated

API key permissionMonitor: Writemonitor:write

Query parameters

• workspace_scopestring
• scope_from_workspace_idstring · uuid

  Required only for workspace_scope when multiple roots exist.

• datastream_idarray of string · uuid
• workspace_idarray of string · uuid
• enabledboolean
• active_pulling_modestring
• scheduled_deletionboolean
• tagarray of string

  Tag name, ignoring case, matched in every workspace the key can see: the same name in two workspaces is two tags, and this matches both. Combine with workspace_id to match the tag of one workspace. Repeatable.

• tag_matchstring

  any: carries at least one of the given tags. all: carries every one.

  One of any all · Default "any"

Request bodyrequired

application/json

Body schema

array of string · uuid UUIDListSchema

Responses

200OKapplication/json

Response schema

array of string · uuid UUIDListSchema

RequestcURL

curl --request DELETE 'https://{{INSTANCE}}/api/v1/datastreams/custom-monitors/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '[
    "00000000-0000-0000-0000-000000000000"
  ]'

Response200

[
  "00000000-0000-0000-0000-000000000000"
]

Discover monitors available for bulk datastream assignment

OPTIONS/api/v1/datastreams/custom-monitors/deprecated

API key permissionMonitor: Read-onlymonitor:read

Without filters, returns all accessible monitors. With datastream filters (e.g. ?datastream_id=), returns only monitors whose workspace family covers all matched datastreams.

Query parameters

• workspace_scopestring
• scope_from_workspace_idstring · uuid

  Required only for workspace_scope when multiple roots exist.

• datastream_idarray of string · uuid
• workspace_idarray of string · uuid
• enabledboolean
• active_pulling_modestring
• scheduled_deletionboolean
• tagarray of string

  Tag name, ignoring case, matched in every workspace the key can see: the same name in two workspaces is two tags, and this matches both. Combine with workspace_id to match the tag of one workspace. Repeatable.

• tag_matchstring

  any: carries at least one of the given tags. all: carries every one.

  One of any all · Default "any"

• pageinteger

  Default 1 · Min 1

• page_sizeinteger

  Default 50 · Min 1

Responses

200OKapplication/json

Response schema

object PagedMonitorSummarySchema

• itemsarray of objectrequired
  Items · MonitorSummarySchema

  • idstring · uuidrequired
  • namestringrequired
  • severitystringrequired

    One of error warning

  • workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema

    • idstring · uuidrequired
    • namestringrequired
• countintegerrequired

RequestcURL

curl --request OPTIONS 'https://{{INSTANCE}}/api/v1/datastreams/custom-monitors/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "severity": "error",
      "workspace": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
      }
    }
  ],
  "count": 1
}

Replace smart-pulling configuration

PUT/api/v1/datastreams/pulling/smart/

API key permissionDatastream: Writedatastream:write

Upsert smart-pulling configuration for multiple datastreams. Applies the same settings to all targeted datastreams. The request carries the full range specification, so it replaces every rule the datastream had.

Query parameters

• workspace_scopestring
• scope_from_workspace_idstring · uuid

  Required only for workspace_scope when multiple roots exist.

• datastream_idarray of string · uuid
• workspace_idarray of string · uuid
• enabledboolean
• active_pulling_modestring
• scheduled_deletionboolean
• tagarray of string

  Tag name, ignoring case, matched in every workspace the key can see: the same name in two workspaces is two tags, and this matches both. Combine with workspace_id to match the tag of one workspace. Repeatable.

• tag_matchstring

  any: carries at least one of the given tags. all: carries every one.

  One of any all · Default "any"

Request bodyrequired

application/json

Body schema

object SmartPullingSchema

• is_activebooleanrequired
• range_specarray of objectrequired

  A non-empty list of SmartPullingRangeRule whose frequencies are unique.

  Two entries collide when their SmartPullingRangeRule.frequency_key values are equal (e.g. two frequency {1, day} entries, or two frequency {1, week} entries — regardless of their on day). Uniqueness is on the configured frequency alone, not on on or on evaluated trigger dates.

  The list must hold at least one entry: an empty spec on an *active* smart fetch fetches nothing and reports no reason why — get_missing_date_range simply finds no entry due today, which is indistinguishable from a non-trigger day.

  Items · SmartPullingRangeSpec

  • frequencyobjectrequired

    How often a range is (re-)pulled, e.g. {value: 40, unit: day}.

    Attributes · Frequency

    • valueintegerrequired

      Min 1

    • unitstringrequired

      One of day week month quarter year

  • rangeobjectrequired

    How much history to pull each time, e.g. {value: 1, unit: month}.

    Every range is pulled *to date*: it resolves to a window ending yesterday, never at a stale past boundary (smart_fetch.utils.date.resolve_range). {value: 7, unit: day} is the last 7 days ending yesterday; a calendar unit snaps the window's start to a period boundary, so {value: 1, unit: month} runs from the 1st of *last* month through yesterday -- the "Last Month to date" window, growing as the current month progresses.

    Hence the smallest value is 1 (inherited from TimeBase) and not 0: one period back is a to-date window's own base, and 0 -- which core.constants' plain to-date presets use for the current period *including today* -- is not expressible here.

    Attributes · Range

    • valueintegerrequired

      Min 1

    • unitstringrequired

      One of day week month quarter year

  • onobjectnullable
    Attributes

    • On

      • dayintegerrequired

        Min 1 · Max 28

      • day_typestringrequired

        One of week month

    • null

• deadlineobjectnullable
  Attributes

  • DeadlineSchema

    • timestring · timenullable

      Time of day the data should be delivered by, on the half hour (e.g. 17:00:00). UTC only: an offset is rejected rather than converted. Null means as soon as possible.

      Attributes

      • string · time

      • null

  • null

• startobjectnullable

  Earliest fetch start. Omit the field to keep whatever is already stored; send null to inherit the workspace default; send an object to set a per-datastream value. Must be before the effective deadline once inheritance is resolved.

  Attributes

  • StartSchema

    • timestring · timenullable

      Earliest time of day a fetch may start, on the half hour (e.g. 09:00:00). UTC only: an offset is rejected rather than converted. Null lifts the restriction for this datastream, overriding any workspace default.

      Attributes

      • string · time

      • null

  • null

Responses

200OKapplication/json

Response schema

object BulkActionResponseSchema

• affectedobjectrequired
  Attributes · AffectedDatastreamsSchema

  • datastream_idsarray of string · uuidrequired

RequestcURL

curl --request PUT 'https://{{INSTANCE}}/api/v1/datastreams/pulling/smart/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "is_active": true,
    "range_spec": [
      {
        "frequency": {
          "value": 1,
          "unit": "day"
        },
        "range": {
          "value": 1,
          "unit": "day"
        },
        "on": {
          "day": 1,
          "day_type": "week"
        }
      }
    ],
    "deadline": {
      "time": "string"
    },
    "start": {
      "time": "string"
    }
  }'

Response200

{
  "affected": {
    "datastream_ids": [
      "00000000-0000-0000-0000-000000000000"
    ]
  }
}

Bulk assign tags to datastreams

POST/api/v1/datastreams/tags/

API key permissionDatastream: Writedatastream:write

Adds the tags in tags to each targeted datastream: every name, looked up in the datastream's own workspace, and every tag id of that workspace (ids of other workspaces are ignored for it; an id the key cannot see rejects the whole request with 400). A datastream gets all of these or none, and is skipped with the reason when none applies, when its workspace lacks a name, or when it would carry more than 50 tags. With create_missing=true, a missing name is created in that datastream's workspace and listed in created_tags. Targets the datastreams in datastream_ids (up to 500) AND-ed with the datastream filters in the query string. A request with neither is refused with 400, and so is one that targets more than 500 datastreams. A workspace of up to 500 datastreams can be targeted with workspace_id alone; for a larger one, list its datastreams with GET /api/v1/datastreams/?workspace_id= and send their ids in batches of 500. One transaction: request-level errors change nothing, and per-datastream problems are reported in skipped while the rest is applied. Sending the same request again changes nothing.

Query parameters

• workspace_scopestring
• scope_from_workspace_idstring · uuid

  Required only for workspace_scope when multiple roots exist.

• datastream_idarray of string · uuid
• workspace_idarray of string · uuid
• enabledboolean
• active_pulling_modestring
• scheduled_deletionboolean
• tagarray of string

  Tag name, ignoring case, matched in every workspace the key can see: the same name in two workspaces is two tags, and this matches both. Combine with workspace_id to match the tag of one workspace. Repeatable.

• tag_matchstring

  any: carries at least one of the given tags. all: carries every one.

  One of any all · Default "any"

• create_missingboolean

  Default false

Request bodyrequired

application/json

Body schema

object DatastreamTagsWriteSchema

• tagsarray of stringrequired

  Tag names or tag ids. A name is looked up in each datastream's own workspace, ignoring case. An id applies to the datastreams of the tag's own workspace and is ignored for the others. An id the key cannot see rejects the whole request with 400.

• datastream_idsarray of string · uuid

  Datastreams to change. AND-ed with any filter in the query string.

Responses

200OKapplication/json

Response schema

object BulkTagAssignmentResponseSchema

• assigned_datastream_idsarray of string · uuidrequired

  Datastreams that now carry every requested tag that applies to them.

• skippedarray of objectrequired

  Datastreams left unchanged, and why. A datastream gets every tag that applies to it, or none.

  Items · SkippedDatastreamSchema

  • datastream_idstring · uuidrequired
  • reasonstringrequired

    One of not_found tag_not_in_workspace unknown_tag_name tag_limit_exceeded

  • detailstringrequired
• created_tagsarray of objectrequired

  Tags created because of create_missing=true.

  Items · DatastreamTagSchema

  • idstring · uuidrequired
  • namestringrequired
  • workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema

    • idstring · uuidrequired
    • namestringrequired
  • createdstring · date-timerequired

RequestcURL

curl --request POST 'https://{{INSTANCE}}/api/v1/datastreams/tags/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "tags": [
      "string"
    ],
    "datastream_ids": [
      "00000000-0000-0000-0000-000000000000"
    ]
  }'

Response200

{
  "assigned_datastream_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "skipped": [
    {
      "datastream_id": "00000000-0000-0000-0000-000000000000",
      "reason": "not_found",
      "detail": "string"
    }
  ],
  "created_tags": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "workspace": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
      },
      "created": "2024-01-01T00:00:00Z"
    }
  ]
}

Bulk unassign tags from datastreams

DELETE/api/v1/datastreams/tags/

API key permissionDatastream: Writedatastream:write

Removes the given tags, by name or id, from each targeted datastream that carries them. Never creates tags. Targets the datastreams in datastream_ids (up to 500) AND-ed with the datastream filters in the query string. A request with neither is refused with 400, and so is one that targets more than 500 datastreams. A workspace of up to 500 datastreams can be targeted with workspace_id alone; for a larger one, list its datastreams with GET /api/v1/datastreams/?workspace_id= and send their ids in batches of 500. One transaction: request-level errors change nothing, and per-datastream problems are reported in skipped while the rest is applied.

Query parameters

• workspace_scopestring
• scope_from_workspace_idstring · uuid

  Required only for workspace_scope when multiple roots exist.

• datastream_idarray of string · uuid
• workspace_idarray of string · uuid
• enabledboolean
• active_pulling_modestring
• scheduled_deletionboolean
• tagarray of string

  Tag name, ignoring case, matched in every workspace the key can see: the same name in two workspaces is two tags, and this matches both. Combine with workspace_id to match the tag of one workspace. Repeatable.

• tag_matchstring

  any: carries at least one of the given tags. all: carries every one.

  One of any all · Default "any"

Request bodyrequired

application/json

Body schema

object DatastreamTagsWriteSchema

• tagsarray of stringrequired

  Tag names or tag ids. A name is looked up in each datastream's own workspace, ignoring case. An id applies to the datastreams of the tag's own workspace and is ignored for the others. An id the key cannot see rejects the whole request with 400.

• datastream_idsarray of string · uuid

  Datastreams to change. AND-ed with any filter in the query string.

Responses

200OKapplication/json

Response schema

object BulkTagUnassignmentResponseSchema

• unassigned_datastream_idsarray of string · uuidrequired

  Datastreams that now carry none of the given tags.

• skippedarray of objectrequired
  Items · SkippedDatastreamSchema

  • datastream_idstring · uuidrequired
  • reasonstringrequired

    One of not_found tag_not_in_workspace unknown_tag_name tag_limit_exceeded

  • detailstringrequired

RequestcURL

curl --request DELETE 'https://{{INSTANCE}}/api/v1/datastreams/tags/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "tags": [
      "string"
    ],
    "datastream_ids": [
      "00000000-0000-0000-0000-000000000000"
    ]
  }'

Response200

{
  "unassigned_datastream_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "skipped": [
    {
      "datastream_id": "00000000-0000-0000-0000-000000000000",
      "reason": "not_found",
      "detail": "string"
    }
  ]
}

Read the tags of many datastreams

POST/api/v1/datastreams/tags/query/

API key permissionDatastream: Read-onlydatastream:read

Returns one item per id in datastream_ids (up to 500) the key can see, with its tags; unknown ids are left out. Not paginated. A POST only because the ids do not fit a URL; it changes nothing. To read tags by filter, list datastreams instead: every item carries its tags.

Request bodyrequired

application/json

Body schema

object DatastreamTagsQuerySchema

• datastream_idsarray of string · uuidrequired

Responses

200OKapplication/json

Response schema

object DatastreamTagsQueryResponseSchema

• itemsarray of objectrequired
  Items · DatastreamTagsSchema

  • datastream_idstring · uuidrequired
  • tagsarray of objectrequired
    Items · DatastreamTagMinimalSchema

    • idstring · uuidrequired
    • namestringrequired
• countintegerrequired

RequestcURL

curl --request POST 'https://{{INSTANCE}}/api/v1/datastreams/tags/query/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "datastream_ids": [
      "00000000-0000-0000-0000-000000000000"
    ]
  }'

Response200

{
  "items": [
    {
      "datastream_id": "00000000-0000-0000-0000-000000000000",
      "tags": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "string"
        }
      ]
    }
  ],
  "count": 1
}

Was this page helpful? Yes No