Generate a new data feed

post

https://api-public.klipfolio.com/v1.0-beta/data_feeds/generate

Selects a generation strategy via the type query parameter. type=queryBuilder resolves a connection and view and builds a feed from a query spec; type=dataUpload builds a feed from data carried in the request body (a CSV, spreadsheet, JSON or XML payload, described by the Content-Type header - see the uploaded-content-types entries on this request body); type=rest builds a feed on a data source that fetches an HTTP endpoint the body describes. An unsupported type returns 400. A service that can only be connected by the user themselves cannot be generated at all - see GET /data_feeds/creation_url. Requires the api:write scope.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

type

string

enum

required

The generation strategy.

Allowed:

name

string

dataUpload only. The feed name; defaults to the Content-Disposition filename, then to "Uploaded data".

description

string

dataUpload only.

sheetIndex

integer

dataUpload only, spreadsheets: which sheet to model. Defaults to the first.

format

string

enum

dataUpload only. States the upload format when Content-Type does not name one (required for application/octet-stream), or overrides it.

Allowed:

Body Params

The queryBuilder generation spec. (When type=dataUpload&format=json instead, the body is the raw JSON data to ingest, not this shape - the two strategies share this content type. type=rest takes its own body shape.)

connectionId

string

required

viewName

string

required

query

object

required

Which fields to pull and how to filter them. Use GET /query_builder/services/{serviceName}/views/{viewName}/fields to discover field names. Each field entry's filters is zero or more { values, op, inverted } filters; an empty filters array returns that field unfiltered (filterOption is then irrelevant). filterOption says how a field's own filters combine: all (every filter must match) or any (at least one must match). A field may be named at most once; a repeated field returns 400.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The generated feed, wrapped in a meta/data envelope like every other create endpoint. data is in the same public shape as GET /data_feeds/{feedId} (with the embedded datasource under source).

defaultAn error response.