Dataflows

Open Endpoints
​
get
Export Dataflow as JSON
https://data-flo.io/api/dataflows/export/:dataflow
Exports the manifest of a specific Dataflow.
Request
Response
Request
Path Parameters
dataflow
required
string
The identifier of the dataflow (e.g. LFIdYQhjg)
Response
200: OK
An array containing one element, which is the manifest of a specific Dataflow.
[
  {
    "identifier": "LFIdYQhjg",
    "name": "Geocoder (requires Mapbox API key)"
    "description": "This geocoder allows you to look up a number of locations by name and returns their geographic coordinates.",
    "manifest": {
      "input": [
        {
          "ui": {
            "x": 133,
            "y": 155
          },
          "name": "locations",
          "type": "text",
          "description": "A list of locations to be geocoded, one per line."
        },
        ...
      ],
      "transform": [
        {
          "ui": {
            "x": 563,
            "y": 284
          },
          "binding": [
            {
              "target": "list",
              "type": "transformation",
              "transformation": "transformation-2",
              "argument": "subtexts"
            },
            {
              "target": "column",
              "type": "value",
              "value": "location"
            }
          ],
          "name": "transformation-1",
          "type": "adaptor",
          "adaptor": "list-to-datatable",
          "description": null
        },
        ...
      ],
      "output": [
        {
          "ui": {
            "x": 2794,
            "y": 272
          },
          "argument": "csv",
          "description": "A CSV text containing the the original locations with latitude and longitude.",
          "name": "csv",
          "transformation": "transformation-4",
          "type": "text"
        },
        ...
      ]
    }
  }
]
get
Dataflow details
https://data-flo.io/api/dataflows/info/:dataflow
Gets the details of a specific Dataflow.
Request
Response
Request
Path Parameters
dataflow
required
string
The identifier of the dataflow (e.g. LFIdYQhjg)
Response
200: OK
{
  "id": "LFIdYQhjg",
  "name": "Geocoder",
  "description": "This geocoder allows you to look up a number of locations by name and returns their geographic coordinates.",
  "createdAt": "2019-05-29T14:46:55.464Z",
  "updatedAt": "2019-05-29T14:50:27.255Z",
  "input": [
    {
      "name": "locations",
      "type": "text",
      "description": "A list of locations to be geocoded, one per line.",
      "required": true
    },
    {
      "name": "mapboxApiKey",
      "type": "text",
      "description": "",
      "required": true
    }
  ],
  "output": [
    {
      "name": "csv",
      "type": "text",
      "description": "A CSV text containing the the original locations with latitude and longitude."
    }
  ]
}
get
List all dataflows
https://data-flo.io/api/dataflows/list
Get the details of all available Dataflows.
Request
Response
Request
Path Parameters
optional
string
​
Response
200: OK
[
  {
    "id": "kvpsi3T8V",
    "name": "Geocoder",
    "description": "This geocoder allows you to look up a number of locations by name and returns their geographic coordinates.",
    "created": "2019-05-29T14:46:55.464Z",
    "updated": "2019-05-29T14:50:27.255Z"
  },
  {
    "id": "Yu77P8ISr",
    "name": "ARIBA files",
    "description": "Imports a card summary file produced by ARIBA (https://github.com/sanger-pathogens/ariba) to a Google spreadsheet.",
    "created": "2019-05-29T14:42:47.852Z",
    "updated": "2019-06-11T10:31:26.597Z"
  },
  ...
]
get
Dataflow manifest
https://data-flo.io/api/dataflows/manifest/:dataflow
Gets the manifest of a specific Dataflow.
Request
Response
Request
Path Parameters
dataflow
required
The identifier of the dataflow (e.g. LFIdYQhjg)
Response
200: OK
[
  {
    "identifier": "LFIdYQhjg",
    "name": "Geocoder (requires Mapbox API key)"
    "description": "This geocoder allows you to look up a number of locations by name and returns their geographic coordinates.",
    "manifest": {
      "input": [
        {
          "ui": {
            "x": 133,
            "y": 155
          },
          "name": "locations",
          "type": "text",
          "description": "A list of locations to be geocoded, one per line."
        },
        ...
      ],
      "transform": [
        {
          "ui": {
            "x": 563,
            "y": 284
          },
          "binding": [
            {
              "target": "list",
              "type": "transformation",
              "transformation": "transformation-2",
              "argument": "subtexts"
            },
            {
              "target": "column",
              "type": "value",
              "value": "location"
            }
          ],
          "name": "transformation-1",
          "type": "adaptor",
          "adaptor": "list-to-datatable",
          "description": null
        },
        ...
      ],
      "output": [
        {
          "ui": {
            "x": 2794,
            "y": 272
          },
          "argument": "csv",
          "description": "A CSV text containing the the original locations with latitude and longitude.",
          "name": "csv",
          "transformation": "transformation-4",
          "type": "text"
        },
        ...
      ]
    }
  }
]
get
Run
https://data-flo.io/api/dataflows/run/:dataflow
Runs a specific Dataflow and returns the output values.
Request
Response
Request
Path Parameters
dataflow
required
string
The identifier of the dataflow (e.g. LFIdYQhjg)
Query Parameters
output
optional
string
The name of an output to be returned, in whole, as the response body.
Form Data Parameters
input-name
optional
object
A value for argument`input-name` if required.
Response
200: OK
Returns an object containing all output values keyed by output names,  or returns one output only if query string `output` parameter is specified.
{
  "csv": "location,query,latitude,longitude,type,code,locality,place,region,country,url
london,london,51.50722,-0.1275,place,4,St. James's,London,England,United Kingdom,"https://www.google.com/maps/search/?api=1&query=51.50722,-0.1275"
}
API Documentation - Previous
Adaptors
Next - API Documentation
Transformations
Last updated 6 months ago
Dataflows

Open Endpoints

getExport Dataflow as JSON

getDataflow details

getList all dataflows

getDataflow manifest

getRun

get
Export Dataflow as JSON

get
Dataflow details

get
List all dataflows

get
Dataflow manifest

get
Run
