← Back to all apps

Overview

Tools Available4
CategoryBusiness

Analyze data from 400+ apps

Available Tools

Coupler.io provides 4 tools that can be used to interact with its services.

Get-data

get-data
Full Description

Get data from a Coupler.io data flow run. Make sure to first query a sample of 5 rows from data table, e.g. SELECT * from data LIMIT 5, and then run the get-schema tool, to better understand the structure. The get-schema tool will return the JSON-encoded schema of the data table. When visualizing the data, do not try to read any files or fetch any URLs, just generate a static page and use the data you get from the tools.

Parameters

Required
executionIdstring

The ID of the last successful run (execution) of the data flow.

querystring

The SQL query to run on the data flow sqlite file.

Get-dataflow

get-dataflow
Full Description

Get a Coupler.io data flow by ID.

Parameters

Required
dataflowIdstring

The ID of the data flow with a successful run.

Optional
filtersobject

Filters for respective clients, each featuring their own namespace.

Get-schema

get-schema
Full Description

Get data table schema from a Coupler.io data flow. Get column names from columnName properties in column definitions. Example: {"columns":[{"key":"Row Updated At.0","label":"Row Updated At","schema":{"type":"string"},"typeOptions":{},"columnName":"col_0"},{"key":"Dimension: Source.0","label":"Dimension: Source","schema":{"type":"string"},"typeOptions":{},"columnName":"col_1"}]}. Here the columns are col_0 and col_1.

Parameters

Required
executionIdstring

The ID of the last successful run (execution) of the data flow.

List-dataflows

list-dataflows
Full Description

List my Coupler.io data flows. Use this to get the ID (uuid format) of a data flow by its name.

Parameters

Optional
filtersobject

Filters for respective clients, each featuring their own namespace.